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 相关文章推荐
裁剪字符串trim()自定义改进版
Apr 10 Javascript
js 中的switch表达式使用示例
Jun 03 Javascript
js语法学习之判断一个对象是否为数组
May 13 Javascript
javascript模拟post提交隐藏地址栏的参数
Sep 03 Javascript
原生js实现新闻列表展开/收起全文功能
Jan 20 Javascript
weex slider实现滑动底部导航功能
Aug 28 Javascript
浅谈Postman解决token传参的问题
Mar 31 Javascript
实例解析Vue.js下载方式及基本概念
May 11 Javascript
JS与jQuery实现ListBox上移,下移,左移,右移操作功能示例
May 31 jQuery
详解JavaScript栈内存与堆内存
Apr 04 Javascript
详解vue项目中实现图片裁剪功能
Jun 07 Javascript
在vue中使用jsx语法的使用方法
Sep 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
用PHP程序实现支持页面后退的两种方法
2008/06/30 PHP
php数组函数序列之array_keys() - 获取数组键名
2011/10/30 PHP
PHP更新购物车数量(表单部分/PHP处理部分)
2013/05/03 PHP
php加速器eAccelerator的配置参数、API详解
2014/05/05 PHP
跟我学Laravel之配置Laravel
2014/10/15 PHP
CodeIgniter开发实现支付宝接口调用的方法示例
2016/11/14 PHP
PHP中的浅复制与深复制的实例详解
2017/10/26 PHP
jquery ajax提交表单数据的两种方式
2009/11/24 Javascript
jQuery Flash/MP3/Video多媒体插件
2010/01/18 Javascript
js 获取、清空input type=&quot;file&quot;的值(示例代码)
2013/12/24 Javascript
node.js入门教程
2014/06/01 Javascript
JavaScript利用append添加元素报错的解决方法
2014/07/01 Javascript
jquery实现两个图片渐变切换效果的方法
2015/06/25 Javascript
微信企业号开发之微信考勤Cookies的使用
2015/09/11 Javascript
jQuery插件之jQuery.Form.js用法实例分析(附demo示例源码)
2016/01/04 Javascript
JavaScript 不支持 indexof 该如何解决
2016/03/30 Javascript
JQuery 两种方法解决刚创建的元素遍历不到的问题
2016/04/13 Javascript
jQuery视差滚动效果网页实现方法经验总结
2016/09/29 Javascript
JS实现定时任务每隔N秒请求后台setInterval定时和ajax请求问题
2017/10/15 Javascript
vue bus全局事件中心简单Demo详解
2018/02/26 Javascript
JavaScript 浏览器对象模型BOM原理与常见用法实例分析
2019/12/16 Javascript
Ant Design Pro 之 ProTable使用操作
2020/10/31 Javascript
python创建只读属性对象的方法(ReadOnlyObject)
2013/02/10 Python
python3序列化与反序列化用法实例
2015/05/26 Python
Python实现调度算法代码详解
2017/12/01 Python
python redis 删除key脚本的实例
2019/02/19 Python
python启动应用程序和终止应用程序的方法
2019/06/28 Python
Web时代变迁及html5与html4的区别
2016/01/06 HTML / CSS
美体小铺英国官网:The Body Shop英国
2017/01/24 全球购物
墨西哥网上超市:Superama
2018/07/10 全球购物
《小鹰学飞》教学反思
2014/04/23 职场文书
私人委托书格式
2014/09/10 职场文书
感谢信范文大全
2015/01/23 职场文书
关爱留守儿童捐款倡议书
2015/04/27 职场文书
浅谈python中的多态
2021/06/15 Python
深入理解go slice结构
2021/09/15 Golang