Webpack - 自定义 plugin

插件向第三方开发者提供了 webpack 引擎中完整的能力。使用阶段式的构建回调，开发者可以引入他们自己的行为到 webpack 构建流程中。

webpack在编译过程中，会触发一系列 Tapable 钩子事件，注册相应的钩子，在 webpack 构建过程中触发钩子执行自定义的任务，就形成了我们自己的 plugin。

背景

插件组成
- 一个 JavaScript 命名函数
- 在插件函数原型上定义一个 apply 方法
- 注册一个 webpack 自身的事件钩子
- 处理 webpack 内部实例的特定数据
- 功能完成后调用 webpack 提供的回调
执行流程
- 合并命令行参数与配置文件，解析得到参数对象
- 参数对象传给 webpack 得到 Compiler 对象
- 执行 Compiler 的 run 方法，生成 Compilation 对象
- 触发 Compiler 的 make 方法分析入口文件，调用 compilation 的 buildModule 方法创建主模块对象
- 生成入口文件AST，加载依赖模块
- 模块分析完成后，执行 Compilation 的 seal 方法
- 最后执行 Compilation.emitAssets() 输出文件
  参考这个图示
Compiler 与 Compilation
- Compiler：完整的 webpack 配置环境。这个对象在启动 webpack 时被一次性创建，并配置好所有可操作的设置，包括 options、loader、plugin。当在 webpack 环境中应用一个插件时，插件可通过compiler 对象引用来访问 webpack 主环境。
- Compilation：一次资源版本的构建。开发环境每当检测到问价变化，就会创建新的 compilation。

示例

参考官网，实现一个简单的插件：生成.md文件展示构建生成的文件列表。github 仓库
file-list-plugin.js:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
function FileListPlugin(options={}) {
  this.filename = options.filename ? options.filename : 'filelist.md';
}

FileListPlugin.prototype.apply = function(compiler) {
  // 注册输出文件之前的钩子 emit 
  compiler.hooks.emit.tapAsync('FileListPlugin', (compilation, cb) => {
    // 从compilation.assets 获取文件信息
    const len = Object.keys(compilation.assets).length;
    let filelist = `${len} file${len > 1 ? 's': ''} in this build:\n\n`;
    for (let filename in compilation.assets) {
      filelist += `* ${filename}\n`;
    }

    // 将列表作为新的文件资源，插入到 webpack 构建
    compilation.assets[this.filename] = {
      source: function() {
        return filelist;
      },
      size: function() {
        return filelist.length;
      }
    }

    cb();
  });
}

module.exports = FileListPlugin;

webpack.config.js:

1
2
3
4
5
6
module.exports = {
  //...
  plugins: [
    new FileListPlugin({filename: '_filelist.md'}),
  ],
};

参考

编写一个插件
 揭秘 webpack plugin