您好,登錄后才能下訂單哦!
html-webpack-plugin 插件是用于編譯 Webpack 項目中的 html 類型的文件,如果直接將 html 文件置于 ./src 目錄中,用 Webpack 打包時是不會編譯到生產環境中的。因為 Webpack 編譯任何文件都需要基于配置文件先行配置的。
Webpack 插件使用三步曲:安裝>引入>配置
npm 安裝
npm install --save-dev html-webpack-plugin
yarn 安裝
yarn add html-webpack-plugin --dev
html-webpack-plugin 入口未定義時
//webpack.config.js const path = require('path'); const htmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: { home: path.resolve(__dirname, './src/app.js') }, output: { path: path.resolve(__dirname, 'dist'), filename: '[name].js' }, plugins: [ new htmlWebpackPlugin() ] }
輸出的 html 文件為:dist/index.html
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Webpack App</title> </head> <body> <script type="text/javascript" src="home.js"></script></body> </html>
此 webpack.config.js 配置文件,是最簡用法 html-webpack-plugin 甚至未傳遞任何參數,但它基于這個原則 Entrypoint undefined = index.html 當未定義此插件的入口時,默認為 index.html,輸出同樣是 index.html。
所以未定義入口時,不論 ./src 下有任何名稱的 html 文件都不會被打包處理,但是會默認輸出 index.html 文件。
html-webpack-plugin 中任何自定義參數設置都會覆蓋默認值
簡單定義一個入口(在參數對象的 template 字段中設置)看看效果:
./src/index.html 中有這個文件
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>Document</title> </head> <body> <div id="test">html webpack plugin</div> </body> </html>
webpack.config.js 增加 template 字段
const path = require('path'); const htmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: { home: path.resolve(__dirname, './src/app.js') }, output: { path: path.resolve(__dirname, 'dist'), filename: '[name].js' }, plugins: [ new htmlWebpackPlugin({ template: './src/index.html'//只增加了這行 }) ] }
打包結果是 dist/home.js 和 dist/index.html 其中 html 文件內容如下,和之前src文件中創建的完全一樣,證明自定義入口生效,且覆蓋了默認入口
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>Document</title> </head> <body> <div id="test">html webpack plugin</div> </body> </html>
template: './src/index2.html' 這里,template 的值就是 html 文件的入口,相當于js文件的 entry 字段的作用,只設置 template時,默認輸出為 index.html, 輸出文件名通過 `filename` 字段設置
template指定你生成的文件所依賴哪一個html文件模板,模板類型可以是html、jade、ejs等。但是要注意的是,如果想使用自定義的模板文件的時候,你需要安裝對應的loader。
當配置了 html 文件的出口 filename 時
const path = require('path'); const htmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: { home: path.resolve(__dirname, './src/app.js') }, output: { path: path.resolve(__dirname, 'dist'), filename: '[name].js' }, plugins: [ new htmlWebpackPlugin({ template: './src/index2.html', filename: 'index.output.html' }) ] }
輸出為 dist/home.js 和 dist/index.output.html
同 webpack.config.js 配置文件的 output 屬性的 filename 字段一樣,htmlWebpackPlugin({})的filname 字段也可以在其值加文件夾實現分類
const path = require('path'); const htmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: { home: path.resolve(__dirname, './src/app.js') }, output: { path: path.resolve(__dirname, 'dist'), filename: '[name].js' }, plugins: [ new htmlWebpackPlugin({ template: './src/index2.html', filename: './category/index.output.html' }) ] }
輸出為 dist/home.js 和 dist/category/index.output.html
title 字段,只有未定義 template 模板文件的時候生效,即只在使用默認輸出文件index.html 的時候,title 設置才有用,否則它的值,會被你指定的 template 文件的title所覆蓋,title 默認值為 Webpack App
favicon
'./somepath/favicon.ico',它的值是你的 favicon.ico 圖標的路徑
inject的四個值: true body head false 指定在何處(body or head)引入 script 文件
其中 body 和 head 為字符串類型需要加引號,false和true為 Boolean 類型值
minify 的值是一個對象,設置壓縮屬性
plugins: [ new HtmlWebpackPlugin({ ... minify: { removeAttributeQuotes: true // 移除屬性的引號 } }) ]
meta:{viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no'}
xhtml
一個布爾值,默認值是 false ,如果為 true ,則以兼容 xhtml 的模式引用文件。
chunks
chunks主要用于多入口文件,當你有多個入口文件,那就回編譯后生成多個打包后的文件,那么chunks 就能選擇你要使用那些js文件
entry: { index: path.resolve(__dirname, './src/index.js'), devor: path.resolve(__dirname, './src/devor.js'), main: path.resolve(__dirname, './src/main.js') } plugins: [ new httpWebpackPlugin({ chunks: ['index','main'] }) ]
那么編譯后:
<script type=text/javascript src="index.js"></script> <script type=text/javascript src="main.js"></script>
如果你沒有設置 chunks 選項,那么默認html 文件會引入所有的 entry 里面的js文件
excludeChunks
和 Chunks
作用是一樣的,值也都是數組形式,對多入口js進行選擇
排除掉一些js
excludeChunks: ['devor.js'] // 等價于上面的
xhtml
一個布爾值,默認值是 false ,如果為 true ,則以兼容 xhtml 的模式引用文件。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持億速云。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。