插件(Plugin)

插件是 webpack 的 支柱。webpack 自身即是构建在你的 webpack 配置中用到的相同插件系统上!

它们还用于做 加载器 无法做的事情。

剖析

webpack 插件是一个具有 apply 方法的 JavaScript 对象。 这个 apply 方法由 webpack 编译器调用,可以访问整个编译生命周期。

ConsoleLogOnBuildWebpackPlugin.js

const pluginName = 'ConsoleLogOnBuildWebpackPlugin';

class ConsoleLogOnBuildWebpackPlugin {
  apply(compiler) {
    compiler.hooks.run.tap(pluginName, compilation => {
      console.log('The webpack build process is starting!!!');
    });
  }
}

编译器钩子的 tap 方法的第一个参数应该是驼峰版本的插件名称。建议使用常量,以便它可以在所有钩子中重复使用。

用法

由于插件可以带参数/选项,因此你必须传递一个 new 实例给你的 webpack 配置中的 plugins 属性。

根据你使用 webpack 的方式,有多种使用插件的方法。

配置

webpack.config.js

const HtmlWebpackPlugin = require('html-webpack-plugin'); //installed via npm
const webpack = require('webpack'); //to access built-in plugins
const path = require('path');

module.exports = {
  entry: './path/to/my/entry/file.js',
  output: {
    filename: 'my-first-webpack.bundle.js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /\.(js|jsx)$/,
        use: 'babel-loader'
      }
    ]
  },
  plugins: [
    new webpack.ProgressPlugin(),
    new HtmlWebpackPlugin({template: './src/index.html'})
  ]
};

Node API

即便使用 Node API,用户也应该通过配置中的 plugins 属性传递插件配置。

some-node-script.js

const webpack = require('webpack'); //to access webpack runtime
const configuration = require('./webpack.config.js');

let compiler = webpack(configuration);

new webpack.ProgressPlugin().apply(compiler);

compiler.run(function(err, stats) {
  // ...
});

你知道吗:上面看到的示例与 webpack 运行时自身 非常相似!有许多很好的用法示例隐藏在 webpack 源代码 中,你可以将这些用例应用于自己的配置和脚本!