Webpack 是 JavaScript 的模块建置工具,运行在 Node.js 上,它可以将零散的 JavaScript 文件用各式工具优化并打包起来,加快网页的加载时间。Webpack 也并不限于用在 JavaScript 上,它除了还能打包网页有用到的静态资源(如 JS、CSS、图片档等)外,也还能透过 TypeScript 的加载器(loader)来编译并打包 TypeScript 代码。
背景知识
在开始阅读这篇文章之前,您应该要先对 TypeScript 编程语言和 Webpack 打包文件的方式有所了解。可以先阅读《TypeScript 学习之路》系列文章。
还要会使用 Webpack 来打包 JavaScript、SCSS/CSS、HTML 网页和任意文件,可以参考以下文章:
用了 TypeScript 还需要用 Webpack 吗?
TypeScript 是一种能用来编译出 JavaScript 代码的编程语言,它「本身」并没有将多个 TypeScript 模块编译为一个 JavaScript 的功能,必须要依靠 System(SystemJS) 或是 AMD (Asynchronous Module Definition)模块系统来集成到同一个 JavaScript 文件上。
例如以下的 TypeScript 程序:
console.log("A");
export default function print() {
console.log("B");
}
import "./a.js";
import print from "./b.js";
print();
我们可以在 tsconfig.json 设置档中的 compilerOptions 字段内加上 outFile 字段来让 TypeScript 在编译 TypeScript 时将 JavaScript 代码输出到同一个 JavaScript 文件中。此时 compilerOptions 字段内的 module 字段要设置为 System 或是 AMD,也就是说,编译出来的 JavaScript 文件必须要运作在 System 和 AMD 的 Runtime 上(如果是要把该 JavaScript 文件放在网页浏览器上运行,就需要引用额外的 JavaScript 套件)。但如果我们是在 Webpack 下用 TypeScript 撰写相同的程序,就不用受到模块系统的限制,自在地使用 ES6 的模块系统。
另外还有一点就是,TypeScript 的编译器并无法帮我们最小化并混淆编译出来的 JavaScript 程序,但 Webpack 可以做到这件事。
所以,如果您的 TypeScript 程序所编译出来的 JavaScript 程序也要用于网页浏览器上,最好还是用 Webpack 来打包。
创建 TypeScript 的 Webpack 项目
加入 Webpack
Webpack 可以被加进现有的 TypeScript 的 Node.js 项目中,在终端机运行以下指令来安装 webpack 和 webpack-cli 这两个套件。
然后编辑 package.json 中的脚本指令,如下:
{
...
"scripts": {
...
"build:webpack": "webpack --mode production",
...
}
...
}
再来就是在 Node.js 项目根目录中,添加 Webpack 的设置档 webpack.config.ts,内容可以初始如下:
import type { Configuration } from "webpack";
const config: Configuration = {
plugins: [],
module: { rules: [] },
resolve: { extensionAlias: { ".js": [".ts", ".js"] } },
};
export default config;
若您的 ESlint 有使用 import/no-extraneous-dependencies 规则,记得一定要将 webpack.config.ts 设为 devDependencies 的例外。
resolve: { extensionAlias: { ".js": [".ts", ".js"] } } 可以让 Webpack 看到扩展名为 .js 的文件路径时,先以 .ts 作为扩展名来尝试,如果不存在,再以 .js 来尝试。如果您的 TypeScript 不是使用 Node16+ 模块设置,要在 resolve 中加上 extensions: [".ts", ".js"] 以支持 import 的路径无扩展名时的情形。
Webpack 预设的输出目录为项目根目录下的 dist 目录,如果您的 TypeScript 原先也是输出到这个目录的话,要换成别的。
若您的 TypeScript 有激活 noUncheckedSideEffectImports,会造成非 JS 模块的资源难以引入进来打包,建议关闭。
加入 TypeScript 加载器
TypeScript 的官方加载器为 ts-loader,不过笔者偏好直接使用 Babel 来加载 TypeScript 和 JavaScript。
在终端机运行以下指令来安装 Babel:
在 webpack.config.ts 设置档中,于 module 字段的 rules 数组内,加入 TypeScript 的加载器规则,如下:
const config: Configuration = {
...
module: {
rules: [
...
{
test: /\.ts$/iu,
use: [
{
loader: "babel-loader",
options: { presets: ["@babel/preset-env", "@babel/preset-typescript"] },
},
],
},
{
test: /\.js$/iu,
use: [
{
loader: "babel-loader",
options: { presets: ["@babel/preset-env"] },
},
],
},
...
]
}
...
};
设置 Webpack 的进入点(Entry Point)
直接使用 TypeScript 文件作为 Webpack 的进入点。例如:
const config: Configuration = {
...
entry: "./src/index.ts"
...
};
