webpack 插件html-webpack-plugin的具体使用
本文介绍了webpack 插件html-webpack-plugin的具体使用,分享给大家,具体如下:
插件地址:
这个插件用来简化创建服务于 webpack bundle 的 html 文件,尤其是对于在文件名中包含了 hash 值,而这个值在每次编译的时候都发生变化的情况。你既可以让这个插件来帮助你自动生成 html 文件,也可以使用 lodash 模板加载生成的 bundles,或者自己加载这些 bundles。
installation
使用 npm 安装这个插件
$ npm install html-webpack-plugin@2 --save-dev
basic usage
这个插件可以帮助生成 html 文件,在 body 元素中,使用 script 来包含所有你的 webpack bundles,只需要在你的 webpack 配置文件中如下配置:
var htmlwebpackplugin = require('html-webpack-plugin') var webpackconfig = { entry: 'index.js', output: { path: 'dist', filename: 'index_bundle.js' }, plugins: [new htmlwebpackplugin()] }
这将会自动在 dist 目录中生成一个名为 index.html 的文件,内容如下:
<!doctype html> <html> <head> <meta charset="utf-8"> <title>webpack app</title> </head> <body> <script src="index_bundle.js"></script> </body> </html>
如果你有多个 webpack 入口点,它们都会被包含在生成的 script 元素中。
如果有任何的 css 资源包含在 webpack 输出中(例如,使用 extracttextplugin 提炼出的 css ),这些将会使用 link 包含在 html 页面的 head 元素中。
configuration
可以进行一系列的配置,支持如下的配置信息
- title: 用来生成页面的 title 元素
- filename: 输出的 html 文件名,默认是 index.html, 也可以直接配置带有子目录。
- template: 模板文件路径,支持加载器,比如 html!./index.html
- inject: true | 'head' | 'body' | false ,注入所有的资源到特定的 template 或者 templatecontent 中,如果设置为 true 或者 body,所有的 javascript 资源将被放置到 body 元素的底部,'head' 将放置到 head 元素中。
- favicon: 添加特定的 favicon 路径到输出的 html 文件中。
- minify: {} | false , 传递 html-minifier 选项给 minify 输出
- hash: true | false, 如果为 true, 将添加一个唯一的 webpack 编译 hash 到所有包含的脚本和 css 文件,对于解除 cache 很有用。
- cache: true | false,如果为 true, 这是默认值,仅仅在文件修改之后才会发布文件。
- showerrors: true | false, 如果为 true, 这是默认值,错误信息会写入到 html 页面中
- chunks: 允许只添加某些块 (比如,仅仅 unit test 块)
- chunkssortmode: 允许控制块在添加到页面之前的排序方式,支持的值:'none' | 'default' | {function}-default:'auto'
- excludechunks: 允许跳过某些块,(比如,跳过单元测试的块)
下面的示例演示了如何使用这些配置。
{ entry: 'index.js', output: { path: 'dist', filename: 'index_bundle.js', hash: true }, plugins: [ new htmlwebpackplugin({ title: 'my app', filename: 'assets/admin.html' }) ] }
生成多个 html 文件
通过在配置文件中添加多次这个插件,来生成多个 html 文件。
{ entry: 'index.js', output: { path: 'dist', filename: 'index_bundle.js' }, plugins: [ new htmlwebpackplugin(), // generates default index.html new htmlwebpackplugin({ // also generate a test.html filename: 'test.html', template: 'src/assets/test.html' }) ] }
编写自定义模板
如果默认生成的 html 文件不适合你的需要看,可以创建自己定义的模板。方便的方式是通过 inject 选项,然后传递给定制的 html 文件。html-webpack-plugin 将会自动注入所有需要的 css, js, manifest 和 favicon 文件到标记中。
plugins: [ new htmlwebpackplugin({ title: 'custom template', template: 'my-index.html', // load a custom template inject: 'body' // inject all scripts into the body }) ]
my-index.html 文件
<!doctype html> <html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <title><%= htmlwebpackplugin.options.title %></title> </head> <body> </body> </html>
如果你有模板加载器,可以使用它来解析这个模板。
module: { loaders: [ { test: /\.hbs$/, loader: "handlebars" } ] }, plugins: [ new htmlwebpackplugin({ title: 'custom template using handlebars', template: 'my-index.hbs', inject: 'body' }) ]
另外,如果你的模式是一个字符串,可以使用 templatecontent 传递它。
plugins: [ new htmlwebpackplugin({ inject: true, templatecontent: templatecontentstring }) ]
如果 inject 特性不适合你的需要,你希望完全控制资源放置。 可以直接使用 lodash 语法,使用 default template 作为起点创建自己的模板。
templatecontent 选项也可以是一个函数,以便使用其它语言,比如 jade:
plugins: [ new htmlwebpackplugin({ templatecontent: function(templateparams, compilation) { // return your template content synchronously here return '..'; } }) ]
或者异步版本
plugins: [ new htmlwebpackplugin({ templatecontent: function(templateparams, compilation, callback) { // return your template content asynchronously here callback(null, '..'); } }) ]
注意,如果同时使用 template 和 templatecontent ,插件会抛出错误。
变量 o 在模板中是在渲染时传递进来的数据,这个变量有如下的属性:
1、htmlwebpackplugin: 这个插件的相关数据 ◦
htmlwebpackplugin.files: 资源的块名,来自 webpack 的 stats 对象,包含来自 entry 的从 entry point name 到 bundle 文件名映射。
"htmlwebpackplugin": { "files": { "css": [ "main.css" ], "js": [ "assets/head_bundle.js", "assets/main_bundle.js"], "chunks": { "head": { "entry": "assets/head_bundle.js", "css": [ "main.css" ] }, "main": { "entry": "assets/main_bundle.js", "css": [] }, } } }
如果在 webpack 配置文件中,你配置了 publicpath,将会反射正确的资源
htmlwebpackplugin.options: 传递给插件的配置。
2、webpack: webpack 的 stats 对象。
3、webpackconfig: webpack 配置信息。
过滤块
可以使用 chunks 来限定特定的块。
plugins: [ new htmlwebpackplugin({ chunks: ['app'] }) ]
还可以使用 excludechunks 来排除特定块。
plugins: [ new htmlwebpackplugin({ excludechunks: ['dev-helper'] }) ]
事件
通过事件允许其它插件来扩展 html。
- html-webpack-plugin-before-html-processing
- html-webpack-plugin-after-html-processing
- html-webpack-plugin-after-emit
使用方式:
compilation.plugin('html-webpack-plugin-before-html-processing', function(htmlplugindata, callback) { htmlplugindata.html += 'the magic footer'; callback(); });
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
上一篇: 为何比尔盖茨、谷歌风投如此看好基因编辑?
下一篇: 我知道你爱我,可是....
推荐阅读
-
CSS3 mask 遮罩的具体使用方法
-
谷歌浏览器(chrome)的免费插件时空隧道安装与使用图文教程
-
solidworks已经安装的motion插件却不能使用该怎么办?
-
Webpack中css-loader和less-loader的使用教程
-
新手快速上手webpack4打包工具的使用详解
-
详解eclipse中Maven工程使用Tomcat7以上插件的方法
-
Sketchup怎么安装使用ToolsOnSurface插件? SU插件的使用方法
-
在SQL Server中使用命令调用SSIS包的具体方法
-
jQuery使用eraser.js插件实现擦除、刮刮卡效果的方法【附eraser.js下载】
-
Spring的RestTemplata使用的具体方法