插件是 webpack 的骨干。webpack 本身就是基于你在 webpack 配置中使用的同一插件系统构建的!
它们还用于完成 loader 无法完成的任何其他任务。webpack 提供了 许多开箱即用的插件。
webpack 插件是一个 JavaScript 对象,它有一个 apply
方法。这个 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!');
});
}
}
module.exports = ConsoleLogOnBuildWebpackPlugin;
建议编译器 hook 的 tap 方法的第一个参数是插件名称的驼峰式命名版本。建议为此使用一个常量,以便在所有 hook 中重复使用。
由于插件可以接受参数/选项,因此你必须在 webpack 配置的 plugins
属性中传递一个 new
实例。
根据你使用 webpack 的方式,有多种使用插件的方法。
webpack.config.js
const HtmlWebpackPlugin = require('html-webpack-plugin');
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' }),
],
};
ProgressPlugin
用于自定义编译期间如何报告进度,HtmlWebpackPlugin
将生成一个 HTML 文件,其中使用 script
标签包含 my-first-webpack.bundle.js
文件。
在使用 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) {
// ...
});