快捷導航

webpack自動引入打包資源HtmlWebpackPlugin的實現(xiàn)

更新時間：2023年07月27日 09:45:43 作者：jieyucx

本文主要介紹了webpack自動引入打包資源HtmlWebpackPlugin的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

在之前的章節(jié)中我們每次打包完之后都是手動的在public/index.html中通過<script>的方式手動引入的dist/js/main.js文件。用過框架開發(fā)的小伙伴應(yīng)該都有體會過，比如vue-cli,每次打包完我們直接將dist目錄下的文件整個拷貝直接部署到服務(wù)器下就行了，不需要自己手動的再更改任何代碼，這該怎么實現(xiàn)呢？那就是今天要介紹的一個plugin->HtmlWebpackPlugin

一、什么是HtmlWebpackPlugin

HtmlWebpackPlugin是一個webpack插件，用于生成HTML文件，并自動注入生成的打包文件。它可以根據(jù)指定的模板生成HTML文件，并自動引入本次打包后的JS和CSS文件。此外，它還可以生成帶有哈希值的文件名以避免緩存問題。HtmlWebpackPlugin可以方便地將webpack與HTML文件的生成和管理進行集成

二、在webpack中使用

中文官網(wǎng)教程 https://webpack.docschina.org/plugins/html-webpack-plugin

1. 下載依賴

npm i html-webpack-plugin -D

2. 基本用法

const HtmlWebpackPlugin = require('html-webpack-plugin');
const path = require('path');
module.exports = {
  entry: 'index.js',
  output: {
    path: path.resolve(__dirname, './dist'),
    filename: 'index_bundle.js',
  },
  plugins: [new HtmlWebpackPlugin({
      // 以 public/index.html 為模板創(chuàng)建文件
      // 新的html文件有兩個特點：1. 內(nèi)容和源文件一致 2. 自動引入打包生成的js等資源
      template: path.resolve(__dirname, "public/index.html"),
    })],
};

在執(zhí)行打包之前，我們先注釋掉public/index.html中手動引入資源的代碼，如圖：

3. 打包

npx webpack

在打包完成之后，dist目錄下會新增一個index.html文件如圖：

已經(jīng)自動為我們引入了main.js，并保留了我們在public/index.html中的預設(shè)。

在瀏覽器中運行一下，如圖：

效果是一樣的。

4. 完整的webpack.config.js代碼如下

// Node.js的核心模塊，專門用來處理文件路徑
const path = require("path");
const ESLintWebpackPlugin = require("eslint-webpack-plugin"); // 引入 ESLint 插件
const HtmlWebpackPlugin = require("html-webpack-plugin"); // 引入 html-webpack-plugin 插件
module.exports = {
  // 入口
  // 相對路徑和絕對路徑都行
  entry: "./src/main.js",
  // 輸出
  output: {
    // path: 文件輸出目錄，必須是絕對路徑
    // path.resolve()方法返回一個絕對路徑
    // __dirname 當前文件的文件夾絕對路徑
    path: path.resolve(__dirname, "dist"),
    // filename: js文件輸出文件名
    filename: "js/main.js",
    clean: true, // 自動將上次打包目錄資源清空
  },
  // 加載器
  module: {
    rules: [
      {
        // 用來匹配 .css 結(jié)尾的文件
        test: /\.css$/,
        // use 數(shù)組里面 Loader 執(zhí)行順序是從右到左
        use: ["style-loader", "css-loader"],
      },
      {
        // 用來匹配.less結(jié)尾的文件
        test: /\.less$/,
        use: ["style-loader", "css-loader", "less-loader"],
      },
      {
        test: /\.s[ac]ss$/,
        use: ["style-loader", "css-loader", "sass-loader"],
      },
      {
        // 用來匹配圖片文件
        test: /\.(png|jpe?g|gif|webp)$/,
        type: "asset",
        parser: {
          dataUrlCondition: {
            maxSize: 10 * 1024, // 小于10kb的圖片會被base64處理
          },
        },
        generator: {
          // 將圖片文件輸出到 images 目錄中
          // 將圖片文件命名 [hash:8][ext][query]
          // [hash:8]: hash值取8位
          // [ext]: 使用之前的文件擴展名
          // [query]: 添加之前的query參數(shù)
          filename: "images/[hash:8][ext][query]",
        },
      },
      {
        test: /\.(ttf|woff2?|map4|map3|avi)$/,
        type: "asset/resource", // 以文件資源的形式輸出
        generator: {
          filename: "media/[hash:8][ext][query]", // 輸出到media目錄中
        },
      },
      {
        test: /\.m?js$/, // 轉(zhuǎn)譯哪些文件
        exclude: /(node_modules|bower_components)/, // 排除哪些文件夾中的js文件不用轉(zhuǎn)譯
        // use: {
        loader: 'babel-loader',
        //   options: {
        //     presets: ['@babel/preset-env'] // 添加預設(shè)，轉(zhuǎn)譯js文件
        //   }
        // }
      }
    ],
  },
  // 插件
  plugins: [
    new ESLintWebpackPlugin({
      // 指定檢查文件的根目錄
      context: path.resolve(__dirname, "src"),
    }),
    new HtmlWebpackPlugin({
        // 以 public/index.html 為模板創(chuàng)建文件
        // 新的html文件有兩個特點：1. 內(nèi)容和源文件一致 2. 自動引入打包生成的js等資源
        template: path.resolve(__dirname, "public/index.html"),
    }),
  ],
  // 模式
  mode: "development", // 開發(fā)模式
};

到此這篇關(guān)于webpack自動引入打包資源HtmlWebpackPlugin的實現(xiàn)的文章就介紹到這了,更多相關(guān)webpack HtmlWebpackPlugin內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: