Gulp + webpack + TypeScriptで開発環境を作成する

GulpとwebpackとTypeScriptで開発環境を作成してみます。

Gulpでwebpackを使用する

まずはGulpでwebpackを使えるように設定してみます。
今回はsrcディレクトリとhtdocsディレクトリを用意して、それぞれ開発用と出力用のディレクトリという想定で作成します。

プロジェクトを作成するディレクトリに移動して、package.jsonを作成します。

npm init

使用するプラグインをインストールします。

npm install gulp webpack webpack-stream --save-dev

プロジェクトルートにwebpack.config.jsを作成します。

module.exports = {
  mode: "production",
  entry: "./src/js/main.js",
  output: {
    path: __dirname + '/htdocs/assets/is/',
    filename: "script.js"
  }
}

entryが開発で使用するファイル、outputがコンパイル後の出力先とファイル名になります。

同じくプロジェクトルートにgulpfile.jsを作成します。

const gulp = require('gulp');
const webpackStream = require('webpack-stream');
const webpack = require('webpack');
const webpackConfig = require('./webpack.config.js');

gulp.task('webpack', function() {
  return webpackStream(webpackConfig, webpack);
});

これで設定は完了しました。
webpack.config.jsで指定した/src/ls/にmain.jsを作成します。

console.log('Hello world');

gulpfile.jsで設定したwebpackのタスクを実行します。

npx webpack

/htdocs/assets/js/にscript.jsが生成されていればOKです。

TypeScriptを使用する

次に、ここまでで作成した環境でTypeScriptを使えるようにしてみます。
まずはプラグインを追加します。

npm install typescript ts-loader --save-dev

tsconfig.jsonを作成します。

npx tsc --init

tsconfig.jsonの中身は以下のようになっています。

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    // "outDir": "./",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  }
}

tsconfig.jsonの内容は使用状況に応じて適宜設定してもらえればと思いますが、今回は以下4箇所を変更・コメントアウトします。

    "module": "es2015",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
〜 略 〜
//    "strict": true,                           /* Enable all strict type-checking options. */
〜 略 〜
//    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
〜 略 〜
//    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
//    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */

webpack.config.jsを変更します。

module.exports = {
  mode: "production",
  entry: "./src/js/main.ts",
  module: {
    rules: [
      {
        test: /\.ts$/,
        use: 'ts-loader'
      },
    ],
  },
  resolve: {
    extensions: ['.ts', '.js']
  },
  output: {
    path: __dirname + '/htdocs/assets/is/',
    filename: "script.js"
  }
}

main.jsをmain.tsに変更して、以下のようにします。

import {hello} from './greeting';

let message: string;
message = hello('Miku');
alert(message);

合わせてgreeting.tsも作成します。

export function hello(user) {
  return 'Hello, ' + user;
}

webpackのタスクを実行します。

npx webpack

script.jsが更新されていればOKです。