总结18个webpack插件

何为插件(Plugin)？专一处理 webpack 在编译过程当中的某个特定的任务的功能模块，能够称为插件。

Plugin 是一个扩展器，它丰富了 webpack 自己，针对是 loader 结束后，webpack 打包的整个过程，它并不直接操做文件，而是基于事件机制工做，会监听 webpack 打包过程当中的某些节点，执行普遍的任务。

 

Plugin 的特色

• 是一个独立的模块
• 模块对外暴露一个 js 函数
• 函数的原型 (prototype) 上定义了一个注入 compiler 对象的 apply方法 apply 函数中须要有经过 compiler 对象挂载的 webpack 事件钩子，钩子的回调中能拿到当前编译的 compilation 对象，若是是异步编译插件的话能够拿到回调 callback
• 完成自定义子编译流程并处理 complition 对象的内部数据
• 若是异步编译插件的话，数据处理完成后执行 callback 回调。

下面介绍 18 个经常使用的 webpack 插件。

HotModuleReplacementPlugin

模块热更新插件。Hot-Module-Replacement 的热更新是依赖于 webpack-dev-server，后者是在打包文件改变时更新打包文件或者 reload 刷新整个页面，HRM 是只更新修改的部分。

HotModuleReplacementPlugin是webpack模块自带的，因此引入webpack后，在plugins配置项中直接使用便可。

const webpack = require('webpack') plugins: [ new webpack.HotModuleReplacementPlugin(), // 热更新插件 ]

 

html-webpack-plugin

生成 html 文件。将 webpack 中entry配置的相关入口 chunk 和 extract-text-webpack-plugin抽取的 css 样式 插入到该插件提供的template或者templateContent配置项指定的内容基础上生成一个 html 文件，具体插入方式是将样式link插入到head元素中，script插入到head或者body中。

const HtmlWebpackPlugin = require('html-webpack-plugin') plugins: [ new HtmlWebpackPlugin({ filename: 'index.html', template: path.join(__dirname, '/index.html'), minify: { // 压缩HTML文件 removeComments: true, // 移除HTML中的注释 collapseWhitespace: true, // 删除空白符与换行符 minifycss: true, // 压缩内联css }, inject: true, }), ]

inject 有四个选项值

• true：默认值，script 标签位于 html 文件的 body 底部
• body：script 标签位于 html 文件的 body 底部（同 true）
• head：script 标签位于 head 标签内
• false：不插入生成的 js 文件，只是单纯的生成一个 html 文件

多页应用打包

有时，咱们的应用不必定是一个单页应用，而是一个多页应用，那么如何使用 webpack 进行打包呢。

const path = require('path') const HtmlWebpackPlugin = require('html-webpack-plugin') module.exports = { entry: { index: './src/index.js', login: './src/login.js', }, output: { path: path.resolve(__dirname, 'dist'), filename: '[name].[hash:6].js', }, //... plugins: [ new HtmlWebpackPlugin({ template: './public/index.html', filename: 'index.html', //打包后的文件名 }), new HtmlWebpackPlugin({ template: './public/login.html', filename: 'login.html', //打包后的文件名 }), ], }

若是须要配置多个 HtmlWebpackPlugin，那么 filename 字段不可缺省，不然默认生成的都是 index.html。

可是有个问题，index.html 和 login.html 会发现，都同时引入了 index.f7d21a.js 和 login.f7d21a.js，一般这不是咱们想要的，咱们但愿 index.html 中只引入 index.f7d21a.js，login.html 只引入 login.f7d21a.js。

HtmlWebpackPlugin 提供了一个 chunks 的参数，能够接受一个数组，配置此参数仅会将数组中指定的 js 引入到 html 文件中

module.exports = { //... plugins: [ new HtmlWebpackPlugin({ template: './public/index.html', filename: 'index.html', //打包后的文件名 chunks: ['index'], }), new HtmlWebpackPlugin({ template: './public/login.html', filename: 'login.html', //打包后的文件名 chunks: ['login'], }), ], }

这样执行 npm run build，能够看到 index.html 中仅引入了 index 的 js 文件，而 login.html 中也仅引入了 login 的 js 文件。

vi设计http://www.maiqicn.com 办公资源网站大全https://www.wode007.com

clean-webpack-plugin

clean-webpack-plugin 用于在打包前清理上一次项目生成的 bundle 文件，它会根据 output.path 自动清理文件夹；这个插件在生产环境用的频率很是高，由于生产环境常常会经过 hash 生成不少 bundle 文件，若是不进行清理的话每次都会生成新的，致使文件夹很是庞大。

const { CleanWebpackPlugin } = require('clean-webpack-plugin') plugins: [ new HtmlWebpackPlugin({ template: path.join(__dirname, '/index.html'), }), new CleanWebpackPlugin(), // 所要清理的文件夹名称 ]

 

extract-text-webpack-plugin

将 css 成生文件，而非内联 。该插件的主要是为了抽离 css 样式,防止将样式打包在 js 中引发页面样式加载错乱的现象

const ExtractTextPlugin = require('extract-text-webpack-plugin') plugins: [ // 将css分离到/dist文件夹下的css文件夹中的index.css new ExtractTextPlugin('css/index.css'), ]

 

mini-css-extract-plugin

将 CSS 提取为独立的文件的插件，对每一个包含 css 的 js 文件都会建立一个 CSS 文件，支持按需加载 css 和 sourceMap。只能用在 webpack4 中，对比另外一个插件 extract-text-webpack-plugin 有如下特色:

• 异步加载
• 不重复编译，性能更好
• 更容易使用
• 只针对 CSS

这个插件应该只用在生产环境配置，而且在 loaders 链中不使用 style-loader, 并且这个插件暂时不支持 HMR

const MiniCssExtractPlugin = require('mini-css-extract-plugin') module.exports = { module: { rules: [ { test: /\.(le|c)ss$/, use: [ { loader: MiniCssExtractPlugin.loader, options: { publicPath: '../', }, }, 'css-loader', 'postcss-loader', 'less-loader', ], }, ], }, plugins: [ new MiniCssExtractPlugin({ filename: 'css/[name].[contenthash:8].css', chunkFilename: 'css/[id].[contenthash:8].css', }), ], }

 

purifycss-webpack

有时候咱们 css 写得多了或者重复了，这就形成了多余的代码，咱们但愿在生产环境进行去除。

const path = require('path') const PurifyCssWebpack = require('purifycss-webpack') // 引入PurifyCssWebpack插件 const glob = require('glob') // 引入glob模块,用于扫描所有html文件中所引用的css module.exports = merge(common, { plugins: [ new PurifyCssWebpack({ paths: glob.sync(path.join(__dirname, 'src/*.html')), }), ], })

 

optimize-css-assets-webpack-plugin

咱们但愿减少 css 打包后的体积，能够用到 optimize-css-assets-webpack-plugin。

const OptimizeCSSAssetsPlugin = require("optimize-css-assets-webpack-plugin") // 压缩css代码 optimization: { minimizer: [ // 压缩css new OptimizeCSSAssetsPlugin({}) ] }

 

UglifyJsPlugin

uglifyJsPlugin 是 vue-cli 默认使用的压缩代码方式，用来对 js 文件进行压缩，从而减少 js 文件的大小，加速 load 速度。它使用的是单线程压缩代码，打包时间较慢，因此能够在开发环境将其关闭，生产环境部署时再把它打开。

const UglifyJsPlugin = require('uglifyjs-webpack-plugin') plugins: [ new UglifyJsPlugin({ uglifyOptions: { compress: { warnings: false } }, sourceMap: true, //是否启用文件缓存 parallel: true //使用多进程并行运行来提升构建速度 })

 

ParallelUglifyPlugin

开启多个子进程，把对多个文件压缩的工做分别给多个子进程去完成，每一个子进程其实仍是经过 UglifyJS 去压缩代码，可是变成了并行执行。

const ParallelUglifyPlugin = require('webpack-parallel-uglify-plugin') plugins: [ new ParallelUglifyPlugin({ //cacheDir 用于配置缓存存放的目录路径。 cacheDir: '.cache/', sourceMap: true, uglifyJS: { output: { comments: false, }, compress: { warnings: false, }, }, }), ]

 

terser-webpack-plugin

Webpack4.0 默认是使用 terser-webpack-plugin 这个压缩插件，在此以前是使用 uglifyjs-webpack-plugin，二者的区别是后者对 ES6 的压缩不是很好，同时咱们能够开启 parallel 参数，使用多进程压缩，加快压缩。

const TerserPlugin = require('terser-webpack-plugin') // 压缩js代码 optimization: { minimizer: [ new TerserPlugin({ parallel: 4, // 开启几个进程来处理压缩，默认是 os.cpus().length - 1 cache: true, // 是否缓存 sourceMap: false, }), ] }

 

NoErrorsPlugin

报错但不退出 webpack 进程。编译出现错误时，使用 NoEmitOnErrorsPlugin 来跳过输出阶段。这样能够确保输出资源不会包含错误。

plugins: [new webpack.NoEmitOnErrorsPlugin()]

 

compression-webpack-plugin

全部现代浏览器都支持 gzip 压缩，启用 gzip 压缩可大幅缩减传输资源大小，从而缩短资源下载时间，减小首次白屏时间，提高用户体验。

gzip 对基于文本格式文件的压缩效果最好（如：CSS、JavaScript 和 HTML），在压缩较大文件时每每可实现高达 70-90% 的压缩率，对已经压缩过的资源（如：图片）进行 gzip 压缩处理，效果很很差。

const CompressionPlugin = require('compression-webpack-plugin') plugins: [ new CompressionPlugin({ // gzip压缩配置 test: /\.js$|\.html$|\.css/, // 匹配文件名 threshold: 10240, // 对超过10kb的数据进行压缩 deleteOriginalAssets: false, // 是否删除原文件 }), ]

固然，这个方法还须要后端配置支持。

 

DefinePlugin

咱们能够经过 DefinePlugin 能够定义一些全局的变量，咱们能够在模块当中直接使用这些变量，无需做任何声明，DefinePlugin 是 webpack 自带的插件。

plugins: [
  new webpack.DefinePlugin({ DESCRIPTION: 'This Is The Test Text.', }), ] // 直接引用 console.log(DESCRIPTION)

 

ProvidePlugin

自动加载模块。 任什么时候候，当 identifier 被看成未赋值的变量时， module 就会自动被加载，而且 identifier 会被这个 module 输出的内容所赋值。这是 webpack 自带的插件。

module.exports = { resolve: { alias: { jquery: './lib/jquery', }, }, plugins: [ //提供全局的变量，在模块中使用无需用require引入 new webpack.ProvidePlugin({ $: 'jquery', react: 'react', }), ], }

 

DLLPlugin

这是在一个额外的独立的 webpack 设置中建立一个只有 dll 的 bundle(dll-only-bundle)。 这个插件会生成一个名为 manifest.json 的文件，这个文件是用来让 DLLReferencePlugin 映射到相关的依赖上去的。

使用步骤以下

一、在 build 下建立 webpack.dll.config.js

const path = require('path') const webpack = require('webpack') module.exports = { entry: { vendor: [ 'vue-router', 'vuex', 'vue/dist/vue.common.js', 'vue/dist/vue.js', 'vue-loader/lib/component-normalizer.js', 'vue', 'axios', 'echarts', ], }, output: { path: path.resolve('./dist'), filename: '[name].dll.js', library: '[name]_library', }, plugins: [ new webpack.DllPlugin({ path: path.resolve('./dist', '[name]-manifest.json'), name: '[name]_library', }), // 建议加上代码压缩插件，不然dll包会比较大。 new webpack.optimize.UglifyJsPlugin({ compress: { warnings: false, }, }), ], }

二、在 webpack.prod.conf.js 的 plugin 后面加入配置

new webpack.DllReferencePlugin({ manifest: require('../dist/vendor-manifest.json'), })

三、package.json文件中添加快捷命令(build:dll)

"scripts": { "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js", "start": "npm run dev", "lint": "eslint --ext .js,.vue src", "build": "node build/build.js", "build:dll": "webpack --config build/webpack.dll.conf.js" }

生产环境打包的时候先npm run build:dll命令会在打包目录下生成 vendor-manifest.json 文件与 vendor.dll.js 文件。而后npm run build生产其余文件。

四、根目录下的入口 index.html 加入引用

<script type="text/JavaScript" src="./vendor.dll.js"></script>

 

HappyPack

HappyPack 能让 webpack 把任务分解给多个子进程去并发的执行，子进程处理完后再把结果发送给主进程。要注意的是 HappyPack 对 file-loader、url-loader 支持的不友好，因此不建议对该 loader 使用。

一、HappyPack 插件安装

npm i -D happypack

二、webpack.base.conf.js 文件对 module.rules 进行配置

module: { rules: [ { test: /\.js$/, use: ['happypack/loader?id=babel'], include: [resolve('src'), resolve('test')], exclude: path.resolve(__dirname, 'node_modules'), }, { test: /\.vue$/, use: ['happypack/loader?id=vue'], }, ] }

三、在生产环境 webpack.prod.conf.js 文件进行配置

const HappyPack = require('happypack') // 构造出共享进程池，在进程池中包含5个子进程 const HappyPackThreadPool = HappyPack.ThreadPool({ size: 5 }) plugins: [ new HappyPack({ // 用惟一的标识符id，来表明当前的HappyPack是用来处理一类特定的文件 id: 'babel', // 如何处理.js文件，用法和Loader配置中同样 loaders: ['babel-loader?cacheDirectory'], threadPool: HappyPackThreadPool, }), new HappyPack({ id: 'vue', // 用惟一的标识符id，来表明当前的HappyPack是用来处理一类特定的文件 loaders: [ { loader: 'vue-loader', options: vueLoaderConfig, }, ], threadPool: HappyPackThreadPool, }), ]

注意，当项目较小时，多线程打包反而会使打包速度变慢。

 

copy-webpack-plugin

咱们在 public/index.html 中引入了静态资源，可是打包的时候 webpack 并不会帮咱们拷贝到 dist 目录，所以 copy-webpack-plugin 就能够很好地帮我作拷贝的工做了。

const CopyWebpackPlugin = require('copy-webpack-plugin') module.exports = { plugins: [ new CopyWebpackPlugin({ patterns: [ { from: 'public/js/*.js', to: path.resolve(__dirname, 'dist', 'js'), flatten: true, }, ], }), ], }

 

IgnorePlugin

这是 webpack 内置插件，它的做用是：忽略第三方包指定目录，让这些指定目录不要被打包进去。

好比咱们要使用 moment 这个第三方依赖库，该库主要是对时间进行格式化，而且支持多个国家语言。虽然我设置了语言为中文，可是在打包的时候，是会将全部语言都打包进去的。这样就致使包很大，打包速度又慢。对此，咱们能够用 IgnorePlugin 使得指定目录被忽略，从而使得打包变快，文件变小。

const Webpack = require('webpack') plugins: [ //moment这个库中，若是引用了./locale/目录的内容，就忽略掉，不会打包进去 new Webpack.IgnorePlugin(/\.\/locale/, /moment/), ]

咱们虽然按照上面的方法忽略了包含’./locale/'该字段路径的文件目录，可是也使得咱们使用的时候不能显示中文语言了，因此这个时候能够手动引入中文语言的目录。

import moment from 'moment' //手动引入所须要的语言包 import 'moment/locale/zh-cn' moment.locale('zh-cn') let r = moment().endOf('day').fromNow() console.log(r)