クモのようにコツコツと

フロントエンドエンジニア イイダリョウの技術ブログ。略称「クモコツ」

【TypeScript】モジュールファイルをwebpackでバンドルする

メタ言語の続きです。前回はモジュール分割したTypeScriptをgulpでコンパイルしました。モジュールは分割したままでインポート設定がCommonJSになりブラウザ上ではエラーになりました。今回はモジュールを1つのファイルにバンドルすべく、webpackを使ってコンパイルします。それではいきましょう!

【目次】

※参考:前回記事
【TypeScript】モジュール分割で起きたエラーを調べる(CommonJSが原因) - クモのようにコツコツと

※参考:【メタ言語】HTMLテンプレートエンジン、AltCSS、AltJSのまとめ
qiita.com

前回のおさらい

TypeScriptでモジュール分割したところ、ファイルは分割されたままコンパイルされる。 f:id:idr_zz:20200713215017j:plain

そして、ESモジュールのimportexportがCommonJSのrequireexportsに変換される。それによってモジュールファイルがブラウザで認識されない。

f:id:idr_zz:20200714080201j:plain それによってモジュールファイルがリンクにならずエラーのまま。

詳細は前回の記事を参照

※参考:前回記事
【TypeScript】モジュール分割で起きたエラーを調べる(CommonJSが原因) - クモのようにコツコツと

webpackをインストール

EJSやSass(SCSS)はモジュールファイルをインポートすると一つに統合された。TypeScriptもその形が望ましい。モジュールをバンドルするにはやはりwebpackでバンドルするのが良さそう。

以前触ったwebpackの記事は

※参考:webpackでJSのモジュールファイルをバンドルする - クモのようにコツコツと

TypeScriptをwebpackでコンパイル&バンドルする方法、下記の記事が参考になりそう。

※参考:最新版TypeScript+webpack 4の環境構築まとめ(React, Vue.js, Three.jsのサンプル付き) - ICS MEDIA

まずは必要なツールをインストールする。

npm i -D webpack webpack-cli ts-loader

webpackwebpack-clits-loaderの3つ。3つ目のts-loaderは今回初めてだが、webpackでTypeScriptをコンパイルするためのツール。

※参考:ts-loader - npm

インストール成功されるとpackage.jsonに追記される。

  "devDependencies": {
    "browser-sync": "^2.26.7",
    "gulp": "^4.0.2",
    "gulp-ejs": "^5.1.0",
    "gulp-plumber": "^1.2.1",
    "gulp-rename": "^2.0.0",
    "gulp-replace": "^1.0.0",
    "gulp-sass": "^4.0.2",
    "gulp-typescript": "^6.0.0-alpha.1",
    "ts-loader": "^8.0.1", // 追加
    "webpack": "^4.43.0", // 追加
    "webpack-cli": "^3.3.12" // 追加
  },
  "dependencies": {
    "@types/node": "^13.13.2",
    "typescript": "^3.8.3"
  }

package.jsonのscriptにwebpack実行するbuildスクリプトを追記

  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "webpack" // 追記
  },

これでnpm run buildでwebpackが実行される。

※参考:Node.jsユーザーなら押さえておきたいnpm-scriptsのタスク実行方法まとめ - ICS MEDIA

tsconfig.jsonの設定

前回「tsconfig.json」の設定を色々いじったので念のためチェック。

とくにmoduleにes2015を指定するのが重要です。これを指定しないと、TypeScriptコードのimport文とexport文がコンパイラによってCommonJSとして変換されるため、webpackによるTree Shaking(未使用のimportを静的解析によって振り落とす機能)のメリットが得られません。

※参考:最新版TypeScript+webpack 4の環境構築まとめ(React, Vue.js, Three.jsのサンプル付き) - ICS MEDIA

{
  "compilerOptions": {
    // 中略
    "target": "es5", 
    "module": "es2015",  
    // 中略
}

ふむ、前回modulees2015にたのはこのままで良さそうだ。

webpack.config.jsを作成

webpackの設定ファイル「webpack.config.js」を作成する。package.jsonなどと同じフォルダ直下の階層。

module.exports = {
    mode: 'production', // development or production
    entry: './src/ts/script.ts',
    output: {
        path: `${__dirname}/dest/js`,
        // 出力ファイル名
        filename: "script.js"
      },
    module: {
      rules: [
        {
          test: /\.ts$/,
          use: 'ts-loader',
        },
      ],
    },
    resolve: {
      extensions: [
        '.ts', '.js',
      ],
    },
  };
  • module.exportsプロパティに連想配列で設定を書く
  • modedevelopmentに:圧縮されないモードでバンドルされる
  • entryにエントリーポイントになるファイルを指定(script.ts)
  • outputの中のpathで出力先のフォルダdest/jsを指定
    filenameでファイル名script.jsを指定
  • moduleの中のrulesの中、test.tsファイルがあったら
    usets-loaderを起動する
  • resolveの中のextensionsで拡張子'.ts'を'.js'に変更

webpackを起動

いよいよ、webpackを実行する!

npm run build

おお、今度は「script.js」だけの形でコンパイルされた!*1 f:id:idr_zz:20200717012913j:plain

「script.js」のコード

/******/ (function(modules) { // webpackBootstrap
/******/    // The module cache
/******/    var installedModules = {};
/******/
/******/    // The require function
/******/    function __webpack_require__(moduleId) {
/******/
/******/        // Check if module is in cache
/******/        if(installedModules[moduleId]) {
/******/            return installedModules[moduleId].exports;
/******/        }
/******/        // Create a new module (and put it into the cache)
/******/        var module = installedModules[moduleId] = {
/******/            i: moduleId,
/******/            l: false,
/******/            exports: {}
/******/        };
/******/
/******/        // Execute the module function
/******/        modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/        // Flag the module as loaded
/******/        module.l = true;
/******/
/******/        // Return the exports of the module
/******/        return module.exports;
/******/    }
/******/
/******/
/******/    // expose the modules object (__webpack_modules__)
/******/    __webpack_require__.m = modules;
/******/
/******/    // expose the module cache
/******/    __webpack_require__.c = installedModules;
/******/
/******/    // define getter function for harmony exports
/******/    __webpack_require__.d = function(exports, name, getter) {
/******/        if(!__webpack_require__.o(exports, name)) {
/******/            Object.defineProperty(exports, name, { enumerable: true, get: getter });
/******/        }
/******/    };
/******/
/******/    // define __esModule on exports
/******/    __webpack_require__.r = function(exports) {
/******/        if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
/******/            Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
/******/        }
/******/        Object.defineProperty(exports, '__esModule', { value: true });
/******/    };
/******/
/******/    // create a fake namespace object
/******/    // mode & 1: value is a module id, require it
/******/    // mode & 2: merge all properties of value into the ns
/******/    // mode & 4: return value when already ns object
/******/    // mode & 8|1: behave like require
/******/    __webpack_require__.t = function(value, mode) {
/******/        if(mode & 1) value = __webpack_require__(value);
/******/        if(mode & 8) return value;
/******/        if((mode & 4) && typeof value === 'object' && value && value.__esModule) return value;
/******/        var ns = Object.create(null);
/******/        __webpack_require__.r(ns);
/******/        Object.defineProperty(ns, 'default', { enumerable: true, value: value });
/******/        if(mode & 2 && typeof value != 'string') for(var key in value) __webpack_require__.d(ns, key, function(key) { return value[key]; }.bind(null, key));
/******/        return ns;
/******/    };
/******/
/******/    // getDefaultExport function for compatibility with non-harmony modules
/******/    __webpack_require__.n = function(module) {
/******/        var getter = module && module.__esModule ?
/******/            function getDefault() { return module['default']; } :
/******/            function getModuleExports() { return module; };
/******/        __webpack_require__.d(getter, 'a', getter);
/******/        return getter;
/******/    };
/******/
/******/    // Object.prototype.hasOwnProperty.call
/******/    __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };
/******/
/******/    // __webpack_public_path__
/******/    __webpack_require__.p = "";
/******/
/******/
/******/    // Load entry module and return exports
/******/    return __webpack_require__(__webpack_require__.s = "./src/ts/script.ts");
/******/ })
/************************************************************************/
/******/ ({

/***/ "./src/ts/omikuji/omikuji.ts":
/*!***********************************!*\
  !*** ./src/ts/omikuji/omikuji.ts ***!
  \***********************************/
/*! exports provided: omikuji */
/***/ (function(module, __webpack_exports__, __webpack_require__) {

"use strict";
eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, \"omikuji\", function() { return omikuji; });\n// 運勢\nvar unsei = [\n    \"大吉\",\n    \"\",\n    \"中吉\",\n    \"小吉\",\n    \"末吉\",\n    \"\",\n    \"大凶\"\n];\n// 結果\nvar kekka = function () {\n    var nmb = Math.floor(Math.random() * unsei.length);\n    return unsei[nmb];\n};\n// おみくじ\nvar omikuji = function () {\n    var massage = 'あなたの運勢は「' + kekka() + '」です。';\n    alert(massage);\n};\n\n\n//# sourceURL=webpack:///./src/ts/omikuji/omikuji.ts?");

/***/ }),

/***/ "./src/ts/script.ts":
/*!**************************!*\
  !*** ./src/ts/script.ts ***!
  \**************************/
/*! no exports provided */
/***/ (function(module, __webpack_exports__, __webpack_require__) {

"use strict";
eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _omikuji_omikuji__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./omikuji/omikuji */ \"./src/ts/omikuji/omikuji.ts\");\n\n// イベント実行\ndocument.addEventListener(\"DOMContentLoaded\", function () {\n    var btn = document.querySelector('.inner__text-btn');\n    btn.addEventListener('click', _omikuji_omikuji__WEBPACK_IMPORTED_MODULE_0__[\"omikuji\"], false);\n}, false);\n\n\n//# sourceURL=webpack:///./src/ts/script.ts?");

/***/ })

/******/ });

productionモードでバンドルしてみる

modedevelopmentからproductionに変更すると…

「webpack.config.js」

module.exports = {
    mode: 'production', // development or production
    // 中略
}

再びwebpackを起動すると…

npm run build

こうなった。

!function(e){var t={};function n(r){if(t[r])return t[r].exports;var o=t[r]={i:r,l:!1,exports:{}};return e[r].call(o.exports,o,o.exports,n),o.l=!0,o.exports}n.m=e,n.c=t,n.d=function(e,t,r){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:r})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var r=Object.create(null);if(n.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)n.d(r,o,function(t){return e[t]}.bind(null,o));return r},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=0)}([function(e,t,n){"use strict";n.r(t);var r=["大吉","吉","中吉","小吉","末吉","凶","大凶"],o=function(){var e,t="あなたの運勢は「"+(e=Math.floor(Math.random()*r.length),r[e]+"」です。");alert(t)};document.addEventListener("DOMContentLoaded",(function(){document.querySelector(".inner__text-btn").addEventListener("click",o,!1)}),!1)}]);

可読性は低いがシュッとスリムに圧縮されとる。

最後に

ということで、TypeScriptをwebpackでコンパイル→バンドルに成功しました。

次回は、他のEJS、Sass(SCSS)などと同時にコンパイルをすべく、gulpとwebpackを連携したく思います。それではまた!


※参考:【メタ言語】HTMLテンプレートエンジン、AltCSS、AltJSのまとめ
qiita.com

*1:前回のファイルは「js」フォルダごと一旦消している