插件地址：https://www.npmjs.com/package/html-webpack-plugin

这个插件用来简化创建服务于 webpack bundle 的 HTML 文件，尤其是对于在文件名中包含了 hash 值，而这个值在每次编译的时候都发生变化的情况。你既可以让这个插件来帮助你自动生成 HTML 文件，也可以使用 lodash 模板加载生成的 bundles，或者自己加载这些 bundles。

Installation

使用 npm 安装这个插件

  1. $ npm install html-webpack-plugin@2 --save-dev

Basic Usage

这个插件可以帮助生成 HTML 文件，在 body 元素中，使用 script 来包含所有你的 webpack bundles，只需要在你的 webpack 配置文件中如下配置：

  1. var HtmlWebpackPlugin = require('html-webpack-plugin')
  2. var webpackConfig = {
  3.   entry: 'index.js',
  4.   output: {
  5.     path: 'dist',
  6.     filename: 'index_bundle.js'
  7.   },
  8.   plugins: [new HtmlWebpackPlugin()]
  9. }

这将会自动在 dist 目录中生成一个名为 index.html 的文件，内容如下：

  1. <!DOCTYPE html>
  2. <html>
  3.   <head>
  4.     <meta charset="UTF-8">
  5.     <title>Webpack App</title>
  6.   </head>
  7.   <body>
  8.     <script src="index_bundle.js"></script>
  9.   </body>
  10. </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: 允许跳过某些块，(比如，跳过单元测试的块)

下面的示例演示了如何使用这些配置。

  1. {
  2.   entry: 'index.js',
  3.   output: {
  4.     path: 'dist',
  5.     filename: 'index_bundle.js',
  6.     hash: true
  7.   },
  8.   plugins: [
  9.     new HtmlWebpackPlugin({
  10.       title: 'My App',
  11.       filename: 'assets/admin.html'
  12.     })
  13.   ]
  14. }

生成多个 HTML 文件

通过在配置文件中添加多次这个插件，来生成多个 HTML 文件。

  1. {
  2.   entry: 'index.js',
  3.   output: {
  4.     path: 'dist',
  5.     filename: 'index_bundle.js'
  6.   },
  7.   plugins: [
  8.     new HtmlWebpackPlugin(), // Generates default index.html
  9.     new HtmlWebpackPlugin({  // Also generate a test.html
  10.       filename: 'test.html',
  11.       template: 'src/assets/test.html'
  12.     })
  13.   ]
  14. }

编写自定义模板

如果默认生成的 HTML 文件不适合你的需要看，可以创建自己定义的模板。方便的方式是通过 inject 选项，然后传递给定制的 HTML 文件。html-webpack-plugin 将会自动注入所有需要的 CSS, js, manifest 和 favicon 文件到标记中。

  1. plugins: [
  2.   new HtmlWebpackPlugin({
  3.     title: 'Custom template',
  4.     template: 'my-index.html', // Load a custom template
  5.     inject: 'body' // Inject all scripts into the body
  6.   })
  7. ]

my-index.html 文件

  1. <!DOCTYPE html>
  2. <html>
  3.   <head>
  4.     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
  5.     <title><%= htmlWebpackPlugin.options.title %></title>
  6.   </head>
  7.   <body>
  8.   </body>
  9. </html>

如果你有模板加载器，可以使用它来解析这个模板。

  1. module: {
  2.   loaders: [
  3.     { test: /\.hbs$/, loader: "handlebars" }
  4.   ]
  5. },
  6. plugins: [
  7.   new HtmlWebpackPlugin({
  8.     title: 'Custom template using Handlebars',
  9.     template: 'my-index.hbs',
  10.     inject: 'body'
  11.   })
  12. ]

另外，如果你的模式是一个字符串，可以使用 templateContent 传递它。

  1. plugins: [
  2.   new HtmlWebpackPlugin({
  3.     inject: true,
  4.     templateContent: templateContentString
  5.   })
  6. ]

如果 inject 特性不适合你的需要，你希望完全控制资源放置。 可以直接使用 lodash 语法，使用  default template 作为起点创建自己的模板。

templateContent 选项也可以是一个函数，以便使用其它语言，比如 jade：

  1. plugins: [
  2.   new HtmlWebpackPlugin({
  3.     templateContent: function(templateParams, compilation) {
  4.       // Return your template content synchronously here
  5.       return '..';
  6.     }
  7.   })
  8. ]

或者异步版本

  1. plugins: [
  2.   new HtmlWebpackPlugin({
  3.     templateContent: function(templateParams, compilation, callback) {
  4.       // Return your template content asynchronously here
  5.       callback(null, '..');
  6.     }
  7.   })
  8. ]

注意，如果同时使用 template 和 templateContent ，插件会抛出错误。

变量 o 在模板中是在渲染时传递进来的数据，这个变量有如下的属性：

  • htmlWebpackPlugin: 这个插件的相关数据

    • 　　htmlWebpackPlugin.files: 资源的块名，来自 webpack 的 stats 对象，包含来自 entry 的从 entry point name 到 bundle 文件名映射。
      1. "htmlWebpackPlugin": {
      2.   "files": {
      3.     "css": [ "main.css" ],
      4.     "js": [ "assets/head_bundle.js", "assets/main_bundle.js"],
      5.     "chunks": {
      6.       "head": {
      7.         "entry": "assets/head_bundle.js",
      8.         "css": [ "main.css" ]
      9.       },
      10.       "main": {
      11.         "entry": "assets/main_bundle.js",
      12.         "css": []
      13.       },
      14.     }
      15.   }
      16. }

      如果在 webpack 配置文件中，你配置了 publicPath，将会反射正确的资源

    • htmlWebpackPlugin.options: 传递给插件的配置。
  • webpack: webpack 的 stats 对象。
  • webpackConfig: webpack 配置信息。

过滤块

可以使用 chunks 来限定特定的块。

  1. plugins: [
  2.   new HtmlWebpackPlugin({
  3.     chunks: ['app']
  4.   })
  5. ]

还可以使用 excludeChunks 来排除特定块。

  1. plugins: [
  2.   new HtmlWebpackPlugin({
  3.     excludeChunks: ['dev-helper']
  4.   })
  5. ]

事件

通过事件允许其它插件来扩展 HTML。

  • html-webpack-plugin-before-html-processing
  • html-webpack-plugin-after-html-processing
  • html-webpack-plugin-after-emit

使用方式：

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

webpack 插件： html-webpack-plugin的更多相关文章

  1. webpack（9）plugin插件功能的使用

    plugin 插件是 webpack 的支柱功能.webpack 自身也是构建于你在 webpack 配置中用到的相同的插件系统之上! 插件目的在于解决 loader 无法实现的其他事. 常用的插件 ...

  2. 探寻 webpack 插件机制

    webpack 可谓是让人欣喜又让人忧,功能强大但需要一定的学习成本.在探寻 webpack 插件机制前,首先需要了解一件有意思的事情,webpack 插件机制是整个 webpack 工具的骨架,而 ...

  3. 编写webpack 插件

    Webpack插件为第三方开发者释放了Webpack的最大可能性.利用多级回调开发者可以把他们自己的需要的功能引入到Webpack里面来.Build插件比Build loader 更进一步.因为你需要 ...

  4. 从0开始编写webpack插件

    1. 前言 插件(plugins)是webpack中的一等功臣.正是由于有了诸多插件的存在,才使得webpack无所不能.在webpack源码中也是使用了大量的内部插件,插件要是用的好,可以让你的工作 ...

  5. 80行代码教你写一个Webpack插件并发布到npm

    1. 前言 最近在学习 Webpack 相关的原理,以前只知道 Webpack 的配置方法,但并不知道其内部流程,经过一轮的学习,感觉获益良多,为了巩固学习的内容,我决定尝试自己动手写一个插件. 这个 ...

  6. 【前端必会】不知道webpack插件? webpack插件源码分析BannerPlugin

    背景 不知道webpack插件是怎么回事,除了官方的文档外,还有一个很直观的方式,就是看源码. 看源码是一个挖宝的行动,也是一次冒险,我们可以找一些代码量不是很大的源码 比如webpack插件,我们就 ...

  7. webpack 插件拾趣 (1) —— webpack-dev-server

    结束了一季的忙碌,我这封笔已久的博客也终究该从春困的咒印中复苏,想来写些实用易读的作为开篇,自然是最好不过. 新开个 webpack 插件/工具介绍的文章系列,约莫每周更新一篇篇幅适中的文章聊以共勉, ...

  8. webpack之loader和plugin简介

    webpack之loader和plugin简介 webpack入门和实战(二):全面理解和运用loader和plugins webpack入门(四)——webpack loader 和plugin w ...

  9. 【vue】webpack插件svg-sprite-loader---实现自己的icon组件

    引言:最近开始写vue的项目,借鉴了一下vue-element-admin源码,针对vue有一个关于icon图标的处理,最近也找了很多关于vue的icon处理的解决方案,大部分都是按照之前小程序的方式 ...

  10. webpack插件html-webpack-plugin

    1.插件安装 npm install html-webpack-plugin --save-dev 2.插件使用 webpack.config.js配置文件为: var htmlWebpackPlug ...

随机推荐

  1. linux GD库安装

    GD 安裝第一部需要做的是先要安裝 GD 到系統內,而安裝 GD 前需要安裝 jpeg-6b, libpng, zlib, freetype.以下是下载网址:GD 2.0.33jpeg-6blibpn ...

  2. web报表移动端如何进行移动设备绑定与撤销

    场景需求描述 为了增强移动端的登录机制验证,保证数据的安全性,报表工具FineReport提供了移动设备绑定的功能,每个系统用户在使用移动端连接系统的时,需要管理员授权,将用户的移动设备与系统绑定起来 ...

  3. 使用中国版 Office 365 -- Team Site分享

    Team Site(工作组网站)主要用于团队内部的协同工作,团队(组织机构)内部每个需要使用Team Site的用户都需要一个Office 365的license.但是如果我们需要将Team Site ...

  4. HDU 5015 233 Matrix --矩阵快速幂

    题意:给出矩阵的第0行(233,2333,23333,...)和第0列a1,a2,...an(n<=10,m<=10^9),给出式子: A[i][j] = A[i-1][j] + A[i] ...

  5. win10输入法切换快捷键怎么设置

    win10输入法切换快捷键怎么修改?以前都是习惯使用(Ctrl+Shift) 现在新版的Win10默认的是[Shift+Alt]那要怎么把它改回来呢? http://jingyan.baidu.com ...

  6. PageContext

    pageContext对象 pageContext对象是JSP中很重要的一个内置对象,不过在一般的JSP程序中,很少用到它,所以知道request对象.response对象的人比较多,知道pageCo ...

  7. BZOJ 2005: [Noi2010]能量采集

    2005: [Noi2010]能量采集 Time Limit: 10 Sec  Memory Limit: 552 MBSubmit: 3312  Solved: 1971[Submit][Statu ...

  8. linux系统root密码遗忘的情况下的解决办法

    机房一台centos系统的服务器,由于这台服务器的系统装了好长时间,且root密码中间更新过几次,后面去机房现场维护时,登陆密码遗忘了,悲催啊~ 没办法,只能开机进入“单用户模式”进行密码重置了. 下 ...

  9. Win7安装Redis

    首先, 到 https://github.com/MSOpenTech/redis/releases 下载Redis的windows 64bit port zip 解压后放到某个目录下, 例如 c:\ ...

  10. Html5 Egret游戏开发 成语大挑战（三）开始界面

    本篇需要在前面的素材准备完毕,才可以开始,使用egret的eui结合代码编辑,快速完成基本的界面搭建,这里写的可能比较细,目的是减少大家对于其中一些操作疑问,我去掉了很多无用的步骤,以最精简的流程来完 ...