プラグイン

プラグインはwebpackのバックボーンです。 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!');
    });
  }
}

module.exports = ConsoleLogOnBuildWebpackPlugin;

コンパイラーフックのtapメソッドの最初のパラメーターは、プラグイン名のキャラメル化されたバージョンにすることをお勧めします。 これをすべてのフックで再利用できるように、定数を使用することをお勧めします。

使い方

プラグインは引数/オプションを取ることができるため、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は、scriptタグを使用してmy-first-webpack.bundle.jsファイルを含む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) {
  // ...
});