webpack插件指南

webpack 有着丰富的插件接口。webpack 自身的多数功能都使用插件接口。插件接口使 webpack 变得极其灵活。使用一些配置文件能减少不少工作量,下面就来总结一些常用的插件。

1.创建html文件

在单页面项目中,可以使用HtmlWebpackPlugin方便的创建html文件,并可以将webpack输出的文件在html中自动使用<script>引入到文件中。

  • 安装
npm install --save-dev html-webpack-plugin
  • 配置
    首先需要通过require来引入
const HtmlWebpackPlugin = require('html-webpack-plugin');

然后添加在plugins中。

plugins: [new HtmlWebpackPlugin()]

执行npm run build后,将生成一个index.html文件在dist目录下。

  • 属性设置
  • title:用于设置html文件的标题。
  • filename:用于设置html文件的名称,默认为index.html
  • template:设置模板文件后,html文件根据模板来生成。除了设置html模板,还可以设置ejs,pug等模板。
  • templateParameters:用于设置模板的参数,比如使用设置一个foo参数,在ejs模板中使用<%= foo %>,生成的html文件将显示foo参数的内容。
  • inject:自动插入脚本到html中。
  • favicon:icon路径。
  • meta:设置meta信息,配置项为一个对象,在对象中设置相关的meta
  • minify:是否压缩html代码。可以通过配置一些选项来设置html的压缩方式。collapseWhitespace用于清理html中的空行和空白符,将html压缩成一行。
    removeComments:删除注释,删除的注释将显示成空行。
    removeRedundantAttributes:删除多余的属性。删除多余的属性。
    removeScriptTypeAttributes:删除script中的type属性。
    removeStyleLinkTypeAttributes:删除style标签中的type属性。
    useShortDoctype:使用短的文档类型。
  • hash:给引入的css,js文件添加hash值,如</script><script src="app.bundle.js?ce88277a1573d296df97"></script>
  • cache:是否缓存。
  • showErrors: 编译到html中时,有错误时显示错误详情。
  • chunks:有多个入口文件时,指定入口文件引入到html中,如:chunks: ['index'],只引入index.js文件。
  • excludeChunks:排队指定文件无需引入到html中。

相关的配置信息如下所示:

new HtmlWebpackPlugin({
            title:'webpack 学习',
            filename: 'index.html',
            template: 'src/index.ejs',
            templateParameters:{'foo': 'bar'},
            inject:true,
            meta:{
                viewport:'width=device-width, initial-scale=1, shrink-to-fit=no'
            },
            minify:{
                collapseWhitespace: false,
                removeComments: true,
                removeRedundantAttributes: true,
                removeScriptTypeAttributes: true,
                removeStyleLinkTypeAttributes: true,
                useShortDoctype: true
            },
            hash:true,
            cache:false,
            showErrors:true,
            chunks: ['index']
        })

2.清理构建目录

在开发的时候,可能会经常生成一些没用的文件在dist目录下,但发布的时候又不想使用这些文件,所在就得先清理,然后再生产实际用到的文件,主要是通过clean-webpack-plugin来清理无用的文件。

  • 安装
npm install clean-webpack-plugin --save-dev
  • 配置
    首先进行引入
const {CleanWebpackPlugin} = require('clean-webpack-plugin');
plugins: [
        new CleanWebpackPlugin()
    ]

3.提取css文件

webpack加载css后,打包的是默认将css文件一起打包的,为了减少打包文件的大小,可以使用mini-css-extract-plugin插件,将css文件抽取出来。webpack4以前使用的是extract-text-webpack-plugin插件

  • 安装
npm install --save-dev mini-css-extract-plugin
  • 配置
    首先进行引入
const ExtractTextPlugin = require("mini-css-extract-plugin");
plugins: [
    new MiniCssExtractPlugin({
            filename: '[name].[hash].css',
            chunkFilename: '[id].[hash].css',
        })
  ]

通过设置好配置后,将分离出css文件,虽然能单独提取出来,但代码是没有经过压缩的。需要使用optimize-css-assets-webpack-plugin插件进行css压缩。
先安装该插件。

 npm install --save-dev optimize-css-assets-webpack-plugin
  • 引入
const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
  • 配置
module.exports = {
optimization: {
        minimizer: [new OptimizeCSSAssetsPlugin({})],
    }
}

默认情况下对每个包含cssjs文件都会创建一个css文件,支持按需加载csssourceMap。但为了方便加载,需要将所有css文件提取到同一个css文件中。使用optimization.splitChunks.cacheGroups可以将css文件提取到一个文件中。需要进行如下的配置:

module.exports = {
optimization: {
        minimizer: [new OptimizeCSSAssetsPlugin({})],
        splitChunks: {
            cacheGroups: {
                styles: {
                    name: 'styles',
                    test: /\.css$/,
                    chunks: 'all',
                    enforce: true,
                },
            },
        },
    }
}
new MiniCssExtractPlugin({
            filename: '[name].[hash].css',
        })

4.css自动添加浏览器前缀

在写css的时候,经常会碰到一些兼容性的问题,总是忘记给一些css3的属性忘记添加了浏览器前缀,使用postcss-loader autoprefixer postcss等插件和转换器,可以处理浏览器兼容,将自动补全浏览器前缀

  • 安装
npm install --save-dev  postcss-loader autoprefixer postcss
  • 配置
{
                test: /\.css$/i,
                use: [MiniCssExtractPlugin.loader,
                    'css-loader',
                    {
                        loader: 'postcss-loader',
                        options: {
                            plugins: [
                                require('autoprefixer')({
                                    browsers: ['last 30 versions', "> 2%", "Firefox >= 10", "ie 6-11"]
                                })
                            ]
                        }
                    }
                ],
            },

配置好后,生成的css文件中css3属性将自动补全前缀。
参考文章

  • browsers
    autoprefixer中可以设置browsers来兼容指定的游览器。可以设置相关的参数来进行配置。

defaults:默认的浏览器列表 (> 0.5%, last 2 versions, Firefox ESR, not dead)。
> 0.5%:指全球有超过0.5%的人使用的浏览器。
last 2 versions:所有浏览器兼容到最新的两个版本。
> 5% in US:指定国家使用游览器的比例。
ie 6-8:指定IE浏览器的版本范围。
Firefox > 20 :指定浏览器的版本范围。
Firefox ESR:浏览器最新版本。
iOS 7iOS系统最低支持iOS 7
since 2015 or last 2 years :2015之后的所有版本或者最近两年发布的版本。
last 2 Chrome versions:指定浏览器最近的几个版本。
not ie <= 8:排除指定范围的浏览器。
unreleased versions:所有浏览器的测试版本。
unreleased Chrome versions:指定浏览器的测试版本。

5.px转rem

在移动端,为了适配不同分辨率的手机,采用的像素单位是'rem',而在写代码的时候,用的都是px,为了将px自动转成'rem,可以借助postcss-px2rem`插件来自动完成。

  • 安装
 npm install --save-dev postcss-px2rem
  • 配置
{
                test: /\.css$/i,
                use: [MiniCssExtractPlugin.loader,
                    'css-loader',
                    {
                        loader: 'postcss-loader',
                        options: {
                            plugins: [
                                require('postcss-px2rem')({remUnit: 75}),
                                require('autoprefixer')({
                                    browsers: ['last 30 versions', "> 2%", "Firefox >= 10", "ie 6-11"]
                                })
                            ]
                        }
                    }
                ],
            }

还需要在html中添加根font-size的大小,代码如下所示:

<script>
    document.getElementsByTagName('html')[0].style.fontSize = (document.documentElement.clientWidth ||  document.body.clientWidth) /10 + 'px';
    window.addEventListener("resize",()=>{
        document.getElementsByTagName('html')[0].style.fontSize = (document.documentElement.clientWidth ||  document.body.clientWidth) /10 + 'px';
    });
</script>

6.JS代码压缩

使用webpack打包时,可以使用UglifyjsWebpackPlugin插件对JS代码进行压缩。

  • 安装
npm i -D uglifyjs-webpack-plugin
  • 引入
const UglifyJsPlugin = require('uglifyjs-webpack-plugin')
  • 配置
module.exports = {
  plugins: [
    new UglifyJsPlugin()
  ]
}
  • 配置选项介绍

test:用于设置匹配js文件的正则表达式。
include:包含指定文件的正则表达式。
exclude:排队指定文件的正则表达式。
** cache:是否进行缓存。
** parallel
:是否启动并行压缩。
** sourceMap:是否开启sourceMap。
** extractComments
:提取注释文件。
uglifyOptionsie8设置是否兼容ie8。ecma设置es的版本。

7.拷贝文件

webpack默认情况下是要将所有的代码、图片、文件等当作模块来处理,并进行打包压缩的,如果有时候需要指定一些文件不需要打包,比如static目录下的文件不需要进行打包时,可以使用copy-webpack-plugin插件将文件复制到指定的目录下。

  • 安装
npm install --save-dev copy-webpack-plugin
  • 引入
const CopyWebpackPlugin = require('copy-webpack-plugin');
  • 配置
new CopyWebpackPlugin([
            {
                from: __dirname +'/static',
                to:__dirname + '/dist/static'
            }
        ])

-配置选项介绍

from:需要拷贝的文件。
to:目标目录。
ignore:忽略的文件。
toType:拷贝后的文件类型,包括dirfiletemplate三种类型。
** test:匹配文件的正则表达式。
** flatten
:删除目录,只拷贝文件。

8.提取公共资源

在使用webpack打包的时候,可以对一些公用的代码进行分离,将其抽取出来,以减少打包后文件的大小,就需要用到html-webpack-externals-plugin插件来提取公共资源了。

  • 安装
npm install --save-dev html-webpack-externals-plugin
  • 引入
const HtmlWebpackExternalsPlugin = require('html-webpack-externals-plugin')
  • 配置
new HtmlWebpackExternalsPlugin({
            externals: [
                {
                    module: 'jquery',
                    entry: 'https://unpkg.com/jquery@3.2.1/dist/jquery.min.js',
                    global: 'jQuery',
                },
            ],
        })

也可以使用官方的SplitChunksPlugin插件进行分离。

总结

webpack插件相关的信息先介绍到这里了,使用插件能为我们的工程打包提升了不少工作效率,webpack是个好工具,值得去深入研究和探索。
个人博客

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,386评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,142评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,704评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,702评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,716评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,573评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,314评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,230评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,680评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,873评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,991评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,706评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,329评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,910评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,038评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,158评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,941评论 2 355

推荐阅读更多精彩内容

  • 目录第1章 webpack简介 11.1 webpack是什么? 11.2 官网地址 21.3 为什么使用 web...
    lemonzoey阅读 1,736评论 0 1
  • 在现在的前端开发中,前后端分离、模块化开发、版本控制、文件合并与压缩、mock数据等等一些原本后端的思想开始...
    Charlot阅读 5,440评论 1 32
  • 本项目基于 入门 Webpack,看这篇就够了创建。本例程通过从头构建一个基于npm管理的前端项目,一步步的让读者...
    尤利西斯U阅读 2,777评论 0 8
  • 写在开头 先说说为什么要写这篇文章, 最初的原因是组里的小朋友们看了webpack文档后, 表情都是这样的: (摘...
    Lefter阅读 5,289评论 4 31
  • 鱼与熊掌不可兼得,所谓求仁得仁,求义得义。 世间的事情很难两全,能够将事情做到两全的那肯定就不是一般人,可以做到面...
    十月痞子阅读 486评论 0 1