webpack最常用的插件：HtmlWebpackPlugin

天介绍 webpack 的一个最常用的插件：HTML Webpack Plugin。

说它是使用 webpack 开发前端项目必不可少的插件也不为过，因为它可以自动帮我们将 webpack 打包生成的文件（比如 js 文件、css 文件）嵌入到 html 文件中。

这在生成的文件带有哈希串时尤为有用。

在 webpack 配置文件引入 HtmlWebpackPlugin 插件，然后在 plugins 数组中通过 new HtmlWebpackPlugin() 加入 HtmlWebpackPlugin 实例对象即可。

// webpack.config.js
const HtmlWebpackPlugin = require('html-webpack-plugin');

module.exports = {
  entry: './src/index.js',
  output: {
    filename: 'app.[contenthash:8].js',
  },
  mode: 'production',
  plugins: [
    new HtmlWebpackPlugin()
  ],
}

我们执行 npx webpack 命令后，webpack 额外给我们生成了一个 dist/index.html 文件。该 html 文件格式化后得到的内容为：

<!doctype html>
<html>
<head>
  <meta charset="utf-8">
  <title>Webpack App</title>
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <script defer="defer" src="app.c8b961ec13a790ae7d15.js"></script>
</head>
<body></body>
</html>

可以看到将打包好的 app.js 文件被自动嵌入到 head 元素下最后一个子元素位置。

这里打包文件名尾部被添加了内容哈希串，这意味着每次项目的内容发生变化，哈希串的值都不同。

试想下，如果你自己管理 html 文件，每次都要改这个 js 文件名，是要多累，还好有 HtmlWebpackPlugin 帮忙。

当然前面这种只是 HtmlWebpackPlugin 插件的默认用法，我们可以做更具体的定制化。

一些常用的属性

我们需要传入一个配置对象来进行模板渲染定制化。

HtmlWebpackPlugin 的配置非常丰富，不过常用的就几个。

plugins: [
  new HtmlWebpackPlugin({
    title: '前端西瓜哥的博客',
    favicon: 'static/favicon.ico',
  }),
],

titile：设置网页标题；
filename：生成 html 文件名，默认值为 index/html；
template：使用自己的模板，这里填这个模板的路径，使用了之后一些配置项就无效了，比如 title；
favicon：指定网站图标路径，除了会在 html 上填充 favicon 相关内容，还会将该文件拷贝到打包文件夹下，非常好用；
minify：是否压缩 html 文件。不设置时，如果 webpack 的 mode 为 production，就会压缩 html，移除多余的空格和注释之类的。

使用自定义 html 模板

在实际开发中，通常是创建一个 index.html 提供给 HtmlWebpackPlugin 插件作为模板。

这样的话，title 等配置和一些更细碎的内容就可以直接写到 html 上。相比配置，直接在 html 上编辑要更直观些。

我们在根目录创建一个 index.html 作为模板：

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>前端西瓜哥</title>
  <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
</head>
<body></body>
</html>

这样就可以直接在 html 模板上添加 title，以及一些 cdn 形式的第三方库。

webpack.config.js 配置改为：

plugins: [
  new HtmlWebpackPlugin({
    template: 'index.html'
  }),
],

生成的 html 为：

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>前端西瓜哥</title>
  <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
  <script defer src="app.d02c9155f73c92f51bf5.js"></script>
</head>
<body></body>
</html>

第三方库建议使用自己本地项目的，会更稳定和安全些，比如上面就建议改为 <script src="static/jquery-3.6.0.min.js"></script>。

这里会用到一个 copy-webpack-plugin 插件将一些文件或文件夹拷贝到打包目录下。关于这个插件我会另外专门写一篇文章讲解，这里不展开。

自定义 html 注入变量

webpack 支持通过使用 lodash.template() 的方式注入变量。

我们将模板 html 改为下面这样：

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title><%= htmlWebpackPlugin.options.title %></title>
</head>
<body>
  <%= htmlWebpackPlugin.options.saySomething %>
</body>
</html>

配置改为：

plugins: [
  new HtmlWebpackPlugin({
    template: 'index.html',
    title: '前端西瓜哥的博客',
    // 下面这个是自定义属性
    saySomething: 'Stay hungry, stay foolish'
  }),
],

将传入给 HtmlWebpackPlugin 的配置属性会成为 htmlWebpackPlugin.options 对象下的属性，嵌入到模板 html 下。

所以这里的生成结果是：

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>前端西瓜哥的博客</title>
<script defer src="app.d02c9155f73c92f51bf5.js"></script></head>
<body>
  Stay hungry, stay foolish
</body>
</html>

因为使用了 lodash.template 模板渲染丰富，除了可以嵌入变量的值，还支持判断条件、循环等特性，基本上可以满足我们的绝大多数场景。

结尾

HTML Webpack Plugin 是被广泛使用的 webpack 插件，用来将我们打包出来的文件自动嵌入到一个模板 HTML 中。

实际开发中，通常我们会使用自己编写的 html 模板。

我是前端西瓜哥，热衷于分享前端知识，欢迎关注我。

念

HTML Webpack Plugin这是一个webpack插件，它简化了HTML文件的创建，以服务于你的webpack bundle。这对于在文件名中包含哈希的webpack包特别有用，因为文件名会改变每次编译。您可以让插件为您生成一个HTML文件，或者使用lodash模板提供您自己的模板，或者使用您自己的加载器。

安装

针对webpack的版本，需要安装对应不同的版本。

webpack4

npm i --save-dev html-webpack-plugin@4

webpack5

  npm i --save-dev html-webpack-plugin

使用

这个插件会为你生成一个HTML5文件，其中包含了使用script标签的所有webpack的bundle。

只需将插件添加到webpack配置中，如下所示：

const path = require("path")
const HtmlWebpackPlugin = require("html-webpack-plugin")
module.exports = {
    entry: "./src/index.js",
    output: {
        filename:"index_bundle.js",
        path: path.resolve(__dirname,"dist")
    },
    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标签一起包含在生成的HTML中。

如果你在webpack的输出中有任何CSS资产(例如，用mini-css-extract-plugin提取的CSS)，那么这些将包含在HTML头部的标签中。

如果你有使用它的插件，html-webpack-plugin应该在任何集成插件之前。

选项

你可以传递一个配置选项到html-webpack-plugin。允许的值如下：

title

类型：String

默认值：Webpack App

描述：要用于生成的HTML文档的标题。

filename

类型：String或Function

默认值：index.html

描述：要写入HTML的文件的文件名。默认为index.html。您也可以在这里指定一个子目录(例如:assets/admin.html)。占位符[name]将被条目名称替换。也可以是一个函数，例如(entryName) => entryName + '.html'。

template

类型：String

默认值：空

描述：默认情况下，它将使用src/index.ejs(如果存在的话)。

templateContent

类型：string|Function|false

默认值：false

描述：可以用来代替模板提供一个内联模板。

templateParameters

类型：Boolean|Object|Function

默认值：false

描述：允许覆盖模板中使用的参数。

inject

类型：Boolean|String

默认值：true

描述：true || 'head' || 'body' || false将所有资产注入到给定的模板或templateContent中。当传递'body'时，所有javascript资源将被放置在body元素的底部。'head'将把脚本放置在head元素中。设置为true时，将根据scriptLoading选项，决定是把脚本添加到head还是body中。使用false禁用自动注入。

publicPath

类型：String|'auto'

默认值：auto

描述：publicPath属性值用于script和link 标签。

scriptLoading

类型：blocking|defer

默认值：defer

描述：现代浏览器支持非阻塞javascript加载(“defer”)，以提高页面启动性能。

favicon

类型：String

默认值：空

描述：将给定的图标路径添加到输出的HTML中。

meta

类型：Object

默认值：{}

描述：允许注入meta标签。例如:meta: {viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no'}。

base

类型：Object|String|false

默认值：false

描述：注入一个base标签。如base:“https://example.com/path/page.html

minify

类型：Boolean|Object

默认值：如果mode为'production'则为true，否则为false

描述：控制是否以及以何种方式压缩输出。

hash

类型：Boolean

默认值：false

描述：如果为true，则附加一个唯一的webpack编译哈希到所有包含的脚本和CSS文件。这对于缓存销毁是很有用的

cache

类型：Boolean

默认值：true

描述：只有当文件被更改时，才会删除它。

showErrors

类型：Boolean

默认值：true

描述：错误的详细信息将写入HTML页面。

chunks

类型：?

默认值：?

描述：只允许添加一些chunk(例如：只添加unit-test 的chunk)

chunksSortMode

类型：String|Function

默认值：auto

描述：允许控制块在包含到HTML之前应该如何排序。允许的值是'none' | 'auto' | 'manual' | {Function}。

excludeChunks

类型：Array.<string>

默认值：空

描述：允许你跳过一些chunk(例如不添加unit-test 的chunk)。

xhtml

类型：Boolean

默认值：false

描述：如果为true，则将link标签呈现为自动关闭(XHTML兼容)

下面是一个webpack配置示例，演示了如何使用这些选项：

{
  entry: 'index.js',
  output: {
    path: __dirname + '/dist',
    filename: 'index_bundle.js'
  },
  plugins: [
    new HtmlWebpackPlugin({
      title: 'My App',
      filename: 'assets/admin.html'
    })
  ]
}

生成多个HTML文件

要生成多个HTML文件，请在插件数组中多次声明插件。

配置示例：

{
  entry: 'index.js',
  output: {
    path: __dirname + '/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不能满足您的需要，您可以提供自己的模板。最简单的方法是使用template选项并传递一个定制的HTML文件。html-webpack-plugin会自动将所有必需的CSS, JS, manifest和favicon文件注入到标记中。

配置文件的部分内容：

plugins: [
  new HtmlWebpackPlugin({
    title: 'Custom template',
    // Load a custom template (lodash by default)
    template: 'index.html'
  })
]

模板文件index.html的内容：

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8"/>
    <title><%= htmlWebpackPlugin.options.title %></title>
  </head>
  <body>
  </body>
</html>

如果您已经有一个模板加载器，您可以使用它来解析模板。请注意，如果您指定了html加载器并使用.html文件作为模板，也会发生这种情况。

module: {
  loaders: [
    { test: /\.hbs$/, loader: "handlebars-loader" }
  ]
},
plugins: [
  new HtmlWebpackPlugin({
    title: 'Custom template using Handlebars',
    template: 'index.hbs'
  })
]

您可以使用现成的lodash语法。如果inject特性不适合你的需要，而你又想完全控制资产的位置，可以使用html-webpack-template项目的默认模板作为你自己编写模板的起点。

ebpack 配置文件详解

Webpack 是一个强大的模块打包工具，它的配置文件webpack.config.js

在线咨询

上一篇：Burpsuite插件大集合
下一篇：css美化文字做法详解总结

您的项目需求

*请认真填写需求信息，我们会在24小时内与您取得联系。

整合营销服务商

webpack最常用的插件：HtmlWebpackPlugin

一些常用的属性

使用自定义 html 模板

自定义 html 注入变量

结尾

念

安装

使用

选项

生成多个HTML文件

编写模板

ebpack 配置文件详解

您的项目需求