Plugin API

插件是 webpack 生态系统的重要组成部分,为社区用户提供了一种强大方式来直接触及 webpack 的编译过程(compilation process)。插件能够 钩入(hook) 到在每个编译(compilation)中触发的所有关键事件。在编译的每一步,插件都具备完全访问 compiler 对象的能力,如果情况合适,还可以访问当前 compilation 对象。

对于编写插件的高度概括,请从编写一个插件开始。

我们首先回顾 tapable 工具,它提供了 webpack 插件接口的支柱。

Tapable

tapable 这个小型 library 是 webpack 的一个核心工具,但也可用于其他地方,以提供类似的插件接口。webpack 中许多对象扩展自 Tapable 类。这个类暴露 tap, tapAsynctapPromise 方法,可以使用这些方法,注入自定义的构建步骤,这些步骤将在整个编译过程中不同时机触发。

请查看 文档 了解更多信息。理解三种 tap 方法以及提供这些方法的钩子至关重要。要注意到,扩展自 Tapable 的对象(例如 compiler 对象)、它们提供的钩子和每个钩子的类型(例如 SyncHook)。

插件类型(plugin types)

根据所使用的 钩子(hook) 和 tap 方法,插件可以以多种不同的方式运行。这个工作方式与 Tapable 提供的 hooks 密切相关。compiler hooks 分别记录了 Tapable 内在的钩子,指出哪些 tap 方法可用。

因此,根据你触发到 tap 事件,插件可能会以不同的方式运行。例如,当钩入 compile 阶段时,只能使用同步的 tap 方法:

  1. compiler.hooks.compile.tap('MyPlugin', params => {
  2. console.log('以同步方式触及 compile 钩子。');
  3. })

然而,对于能够使用了 AsyncHook(异步钩子)run,我们可以使用 tapAsynctapPromise(以及 tap):

  1. compiler.hooks.run.tapAsync('MyPlugin', (source, target, routesList, callback) => {
  2. console.log('以异步方式触及 run 钩子。');
  3. callback();
  4. });
  5. compiler.hooks.run.tapPromise('MyPlugin', (source, target, routesList) => {
  6. return new Promise(resolve => setTimeout(resolve, 1000)).then(() => {
  7. console.log('以具有延迟的异步方式触及 run 钩子。');
  8. });
  9. });
  10. compiler.hooks.run.tapPromise('MyPlugin', async (source, target, routesList) => {
  11. await new Promise(resolve => setTimeout(resolve, 1000));
  12. console.log('以具有延迟的异步方式触及 run 钩子。');
  13. });

这些需求(story)的含义在于,可以有多种方式将 hook 钩入到 compiler 中,可以让各种插件都以合适的方式去运行。

自定义的钩子函数(custom hooks)

为了给其他插件的编译添加一个新的钩子,来 tap(触及) 到这些插件的内部,直接从 tapablerequire 所需的钩子类(hook class),然后创建:

  1. const SyncHook = require('tapable').SyncHook;
  2. // 具有 `apply` 方法……
  3. if (compiler.hooks.myCustomHook) throw new Error('Already in use');
  4. compiler.hooks.myCustomHook = new SyncHook(['a', 'b', 'c']);
  5. // 在你想要触发钩子的位置/时机下调用……
  6. compiler.hooks.myCustomHook.call(a, b, c);

再次声明,查看 tapable 文档 来,了解更多不同的钩子类(hook class),以及它们是如何工作的。

Reporting Progress

Plugins can report progress via ProgressPlugin, which prints progress messages to stderr by default. In order to enable progress reporting, pass a --progress argument when running the webpack CLI.

It is possible to customize the printed output by passing different arguments to the reportProgress function of ProgressPlugin.

To report progress, a plugin must tap into a hook using the context: true option:

  1. compiler.hooks.emit.tapAsync({
  2. name: 'MyPlugin',
  3. context: true
  4. }, (context, compiler, callback) => {
  5. const reportProgress = context && context.reportProgress;
  6. if (reportProgress) reportProgress(0.95, 'Starting work');
  7. setTimeout(() => {
  8. if (reportProgress) reportProgress(0.95, 'Done work');
  9. callback();
  10. }, 1000);
  11. });

The reportProgress function may be called with these arguments:

  1. reportProgress(percentage, ...args);
  • percentage: This argument is unused; instead, ProgressPlugin will calculate a percentage based on the current hook.
  • ...args: Any number of strings, which will be passed to the ProgressPlugin handler to be reported to the user.

Note that only a subset of compiler and compilation hooks support the reportProgress function. See ProgressPlugin for a full list.

下一步

查看 compiler hooks 部分,了解所有可用的 compiler 钩子和其所需的参数的详细列表。


贡献人员

EugeneHlushko EugeneHlushko byzyk byzyk e-cloud e-cloud pksjce pksjce thelarkinn thelarkinn