DDR爱好者之家

webpack 插件html-webpack-plugin的具体使用
站长资源 2024/11/26 佚名
40 1538
DDR爱好者之家 Design By 杰米

本文介绍了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="/UploadFiles/2021-04-02/index_bundle.js">


如果你有多个 webpack 入口点，它们都会被包含在生成的 script 元素中。


如果有任何的 CSS 资源包含在 webpack 输出中（例如，使用 ExtractTextPlugin 提炼出的 css ），这些将会使用 link 包含在 HTML 页面的 head 元素中。


Configuration


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


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



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





{
 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: 这个插件的相关数据 "htmlcode">



"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. 
  
  2. html-webpack-plugin-after-html-processing
    3. 
  
  3. html-webpack-plugin-after-emit
    4. 



使用方式：





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





以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。
DDR爱好者之家 Design By 杰米
广告合作：本站广告合作请联系QQ：858582 申请时备注：广告合作（否则不回）
免责声明：本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除！
DDR爱好者之家 Design By 杰米
ddrfans.com DDR爱好者之家
8,675无损音乐
1,324高清电影
213破解软件
70,141收录资讯

稳了！魔兽国服回归的3条重磅消息！官宣时间再确认！

昨天有一位朋友在大神群里分享，自己亚服账号被封号之后居然弹出了国服的封号信息对话框。

这里面让他访问的是一个国服的战网网址，com.cn和后面的zh都非常明白地表明这就是国服战网。

而他在复制这个网址并且进行登录之后，确实是网易的网址，也就是我们熟悉的停服之后国服发布的暴雪游戏产品运营到期开放退款的说明。这是一件比较奇怪的事情，因为以前都没有出现这样的情况，现在突然提示跳转到国服战网的网址，是不是说明了简体中文客户端已经开始进行更新了呢？

更新日志

友情链接

杰晶网络 DDR爱好者之家 南强小屋 黑松山资源网 白云城资源网
DDR爱好者之家 Design By 杰米