webpack 外掛程式： html-webpack-plugin的使用

最後更新：2017-08-26 來源：互聯網

上載者：User

創建阿里雲帳戶，並獲得超過 40 款產品的免費試用版；而企業帳戶則可以享有總值 $1200 的免費試用版。立即註冊！

標籤：lod 錯誤資訊控制 async das 自訂需要 cal bundle

外掛程式地址：https://www.npmjs.com/package/html-webpack-plugin

這個外掛程式用來簡化建立服務於 webpack bundle 的 HTML 檔案，尤其是對於在檔案名稱中包含了 hash 值，而這個值在每次編譯的時候都發生變化的情況。你既可以讓這個外掛程式來協助你自動產生 HTML 檔案，也可以使用 lodash 模板載入產生的 bundles，或者自己載入這些 bundles。

Installation

使用 npm 安裝這個外掛程式

$ npm install [email protected] --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

可以進行一系列的配置，支援如下的配置資訊

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: 允許跳過某些塊，(比如，跳過單元測試的塊)

下面的樣本示範了如何使用這些配置。

{  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 在模板中是在渲染時傳遞進來的資料，這個變數有如下的屬性：

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: 傳遞給外掛程式的配置。
webpack: webpack 的 stats 對象。
webpackConfig: webpack 配置資訊。過濾塊
可以使用 chunks 來限定特定的塊。

plugins: [  new HtmlWebpackPlugin({    chunks: [‘app‘]  })]

還可以使用 excludeChunks 來排除特定塊。

plugins: [  new HtmlWebpackPlugin({    excludeChunks: [‘dev-helper‘]  })]

事件

通過事件允許其它外掛程式來擴充 HTML。

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

使用方式：

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

webpack 外掛程式： html-webpack-plugin的使用

本文章原先以中文撰寫並發佈於 aliyun.com，亦設英文版本，僅作資訊用途。本網站不對文章的準確性，完整性或可靠性或其任何翻譯作出任何明示或暗示的陳述或保證。如對該文章有任何疑慮或投訴，請傳送電郵至 info-contact@alibabacloud.com 並提供相關疑慮或投訴的詳細說明。職員會於 5 個工作天內與您聯絡，一經驗證之後，即會刪除該侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

Get Started for Free

Sales Support

1 on 1 presale consultation

Chat Contact Sales
After-Sales Support

24/7 Technical Support 6 Free Tickets per Quarter Faster Response

Open a Ticket
Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.

Learn More