webpack 插件html-webpack-plugin的具体使用


Posted in Javascript onApril 09, 2018

本文介绍了webpack 插件html-webpack-plugin的具体使用,分享给大家,具体如下:

插件地址:https://www.npmjs.com/package/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

 可以进行一系列的配置,支持如下的配置信息

  1. title: 用来生成页面的 title 元素
  2. filename: 输出的 HTML 文件名,默认是 index.html, 也可以直接配置带有子目录。
  3. template: 模板文件路径,支持加载器,比如 html!./index.html
  4. inject: true | 'head' | 'body' | false  ,注入所有的资源到特定的 template 或者 templateContent 中,如果设置为 true 或者 body,所有的 javascript 资源将被放置到 body 元素的底部,'head' 将放置到 head 元素中。
  5. favicon: 添加特定的 favicon 路径到输出的 HTML 文件中。
  6. minify: {} | false , 传递 html-minifier 选项给 minify 输出
  7. hash: true | false, 如果为 true, 将添加一个唯一的 webpack 编译 hash 到所有包含的脚本和 CSS 文件,对于解除 cache 很有用。
  8. cache: true | false,如果为 true, 这是默认值,仅仅在文件修改之后才会发布文件。
  9. showErrors: true | false, 如果为 true, 这是默认值,错误信息会写入到 HTML 页面中
  10. chunks: 允许只添加某些块 (比如,仅仅 unit test 块)
  11. chunksSortMode: 允许控制块在添加到页面之前的排序方式,支持的值:'none' | 'default' | {function}-default:'auto'
  12. 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。

  1. html-webpack-plugin-before-html-processing
  2. html-webpack-plugin-after-html-processing
  3. html-webpack-plugin-after-emit

使用方式:

compilation.plugin('html-webpack-plugin-before-html-processing', function(htmlPluginData, callback) {
 htmlPluginData.html += 'The magic footer';
 callback();
});

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
JavaScript基础语法让人疑惑的地方小结
May 23 Javascript
深入理解JavaScript系列(47):对象创建模式(上篇)
Mar 04 Javascript
基于javascript实现随机颜色变化效果
Jan 14 Javascript
函数四种调用模式以及其中的this指向
Jan 16 Javascript
vue2.0中goods选购栏滚动算法的实现代码
May 17 Javascript
vue实现商城上货组件简易版
Nov 27 Javascript
在vue项目中使用md5加密的方法
Sep 14 Javascript
解决vue无法设置滚动位置的问题
Oct 07 Javascript
jQuery实现的网站banner图片无缝轮播效果完整实例
Jan 28 jQuery
webpack DllPlugin xxx is not defined解决办法
Dec 13 Javascript
vue实现带过渡效果的下拉菜单功能
Feb 19 Javascript
Vue Render函数原理及代码实例解析
Jul 30 Javascript
详解webpack 入门与解析
Apr 09 #Javascript
vue技术分享之你可能不知道的7个秘密
Apr 09 #Javascript
一步步教会你微信小程序的登录鉴权
Apr 09 #Javascript
vue组件详解之使用slot分发内容
Apr 09 #Javascript
vue组件中使用props传递数据的实例详解
Apr 08 #Javascript
Vue入门之animate过渡动画效果
Apr 08 #Javascript
vue组件与复用详解
Apr 08 #Javascript
You might like
ecshop 批量上传(加入自定义属性)
2012/03/20 PHP
PHP代码保护--Zend Guard的使用详解
2013/06/03 PHP
php中session过期时间设置及session回收机制介绍
2014/05/05 PHP
分享一个php 的异常处理程序
2014/06/22 PHP
php使用类继承解决代码重复的问题
2015/02/11 PHP
PHP中如何使用session实现保存用户登录信息
2015/10/20 PHP
javscript对象原型的一些看法
2010/09/19 Javascript
JS打开新窗口的2种方式
2013/04/18 Javascript
JS鼠标滑过图片时切换图片实现思路
2013/09/12 Javascript
ECMAScript 6即将带给我们新的数组操作方法前瞻
2015/01/06 Javascript
一看就懂:jsonp详解
2015/06/01 Javascript
详解AngularJS中的表格使用
2015/06/16 Javascript
通过点击jqgrid表格弹出需要的表格数据
2015/12/02 Javascript
js文本框输入内容智能提示效果
2015/12/02 Javascript
js 弹出对话框(遮罩)透明,可拖动的简单实例
2016/07/11 Javascript
Vee-Validate的使用方法详解
2017/09/22 Javascript
微信小程序tabbar底部导航
2018/11/05 Javascript
vue-router beforeEach跳转路由验证用户登录状态
2018/12/26 Javascript
从组件封装看Vue的作用域插槽的实现
2019/02/12 Javascript
基于node+websocket+html实现腾讯课堂聊天室聊天功能
2020/03/04 Javascript
python3实现TCP协议的简单服务器和客户端案例(分享)
2017/06/14 Python
python爬虫获取淘宝天猫商品详细参数
2020/06/23 Python
python中复数的共轭复数知识点总结
2020/12/06 Python
英国日常交易网站:Wowcher
2018/09/04 全球购物
如何在Shell脚本中使用函数
2015/09/06 面试题
仓库班组长岗位职责
2013/12/12 职场文书
2014年教师培训的自我评价
2014/01/03 职场文书
高中生期末评语大全
2014/01/28 职场文书
聚美优品广告词改编
2014/03/14 职场文书
四风批评与自我批评发言稿
2014/10/14 职场文书
敬业奉献模范事迹材料
2014/12/24 职场文书
休学证明范本
2015/06/19 职场文书
2015年支教教师工作总结
2015/07/22 职场文书
python爬取新闻门户网站的示例
2021/04/25 Python
详解nginx location指令
2022/01/18 Servers
python区块链持久化和命令行接口实现简版
2022/05/25 Python