# 插件(plugin)

插件是 webpack 的 支柱 (opens new window) 功能。webpack 自身也是构建于,你在 webpack 配置中用到的相同的插件系统之上!

插件目的在于解决 loader (opens new window) 无法实现的其他事

# 剖析

webpack 插件是一个具有 apply (opens new window) 方法的 JavaScript 对象。apply 方法会被 webpack compiler 调用,并且 compiler 对象可在整个编译生命周期访问。

ConsoleLogOnBuildWebpackPlugin.js

const pluginName = 'ConsoleLogOnBuildWebpackPlugin';

class ConsoleLogOnBuildWebpackPlugin {
  apply(compiler) {
    compiler.hooks.run.tap(pluginName, compilation => {
      console.log('webpack 构建过程开始!');
    });
  }
}

compiler hook 的 tap 方法的第一个参数,应该是驼峰式命名的插件名称。建议为此使用一个常量,以便它可以在所有 hook 中复用。

# 用法

由于插件可以携带参数/选项,你必须在 webpack 配置中,向 plugins 属性传入 new 实例。

根据你使用 webpack 的需要,这里有多种方式使用插件。

# 配置

webpack.config.js

const HtmlWebpackPlugin = require('html-webpack-plugin'); //通过 npm 安装
const webpack = require('webpack'); //访问内置的插件
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'); //访问 webpack 运行时(runtime)
const configuration = require('./webpack.config.js');

let compiler = webpack(configuration);

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

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

你知道吗:以上看到的示例和 webpack 自身运行时(runtime) (opens new window) 极其类似。wepback 源码 (opens new window)中隐藏有大量使用示例,你可以用在自己的配置和脚本中。

# 常用plugin

CommonsChunkPlugin (opens new window) 提取 chunks 之间共享的通用模块
HtmlWebpackPlugin (opens new window) 简单创建 HTML 文件,用于服务器访问
IgnorePlugin (opens new window) 从 bundle 中排除某些模块
UglifyjsWebpackPlugin (opens new window) 可以控制项目中 UglifyJS 的版
DashboardPlugin()

# webpack-dashboard

  • vue-cli

    // vue.config.js
    
    + const DashboardPlugin = require("webpack-dashboard/plugin");
    
     configureWebpack: {
        name: name,
        resolve: {
          alias: {
            '@': resolve('src')
          }
        },
    +   plugins: [
    +     new DashboardPlugin()
    +   ]
      },
    

# 编写一个plugin

write a plugin

# 参考文献

Last Updated: 5/31/2021, 1:27:55 AM