webpack4系列教程（三）：自动生成项目中的HTML文件

时间 2019-12-13

标签 webpack4 webpack 系列教程自动生成项目 html 文件栏目 HTML 繁體版

原文原文链接

1. webpack中的CommonJS和ES Mudule 规范

1.1 CommonJs规范

CommonJs规范的出发点：JS没有模块系统、标准库较少、缺少包管理工具；为了让JS能够在任何地方运行，以达到Java、PHP这些后台语言具有开发大型应用的能力。html

在CommonJs规范中：webpack

一个文件就是一个模块，拥有单独的做用域；
普通方式定义的变量、函数、对象都属于该模块内；
经过require来加载模块；
经过exports和modul.exports来暴露模块中的内容；

1.2 ES Mudule 规范

ES6在语言标准的层面上，实现了模块功能，基本特色以下：git

每个模块只加载一次，每个JS只执行一次，若是下次再去加载同目录下同文件，直接从内存中读取；
每个模块内声明的变量都是局部变量，不会污染全局做用域；
模块内部的变量或者函数能够经过export导出；
一个模块能够导入别的模块；

模块功能主要由两个命令构成：export和import；export命令用于规定模块的对外接口，import命令用于输入其余模块提供的功能：github

// esm.js
let firstName = 'Jack';
let lastName = 'Wang';

export {firstName, lastName}

// export命令除了输出变量，还能够输出函数
export function (a, b) {
  return a + b
}

使用export命令定义了模块的对外接口之后，其余 JS 文件就能够经过import命令加载这个模块，import命令接受一对大括号，里面指定要从其余模块导入的变量名，大括号里面的变量名，必须与被导入模块对外接口的名称相同。web

// main.js
import {firstName, lastName} from './esm';

function say() {
  console.log('Hello , ' + firstName + ' ' + lastName)
}

1.3 使用

如今，在src目录下新建 sum.js 和 minus.jschrome

// sum.js ES Mudule 规范
// export default命令，为模块指定默认输出
export default function (a, b) {
  return a + b
}

// minus.js commonJS 规范

module.exports = function (a, b) {
  return a - b
}

修改 main.js npm

import sum from './sum'
import minus from './minus'

console.log('sum(1, 2): ' + sum(1, 2))
console.log('minus(5, 2): ' + minus(5, 2))

执行 npm run build 以后，打开 index.html，在控制台中能够看到输出的结果。数组

2. 自动生成项目中的HTML文件

在前文中咱们为了演示打包好的 main.bundle.js ，在根目录下建立了一个 index.html ，并引入main.bundle.js。而在实际项目中，咱们能够经过 webpack 的一个插件：HtmlWebpackPlugin 来自动生成HTML文件并引入咱们打包好的JS和CSS文件。函数

安装：

npm install --save-dev html-webpack-plugin

整理项目目录：工具

在根目录建立config文件夹，把webpack.config.js移入config，并修改webpack.config.js：

const path = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')

const config = {
  mode: 'none',
  entry: {
    main: path.join(__dirname, '../src/main.js')
  },
  output: {
    filename: '[name].bundle.js',
    path: path.join(__dirname, '../dist')
  },
  plugins: [
    new HtmlWebpackPlugin({
      template: path.join(__dirname, '../index.html'),
      inject: true,
      minify: {
        removeComments: true
      }
    })
  ]
}

module.exports = config

template：模版文件的路径，这里使用根目录下的index.html文件；
inject：设为 true 表示把JS文件注入到body结尾，CSS文件注入到head中；
minify：removeComments: true 表示删除模版文件中的注释，minify还有不少配置可选请自行参阅；

下一步注释掉index.html 中咱们手动引入的 script ：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="renderer" content="webkit"/>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
    <title>Title</title>
</head>
<body>

<!-- <script src="dist/main.bundle.js"></script> -->
</body>
</html>

执行 npm run build ，能够看到，dist 目录下多了一个 index.html，这就是经过 HtmlWebpackPlugin 生成的文件，打开dist/index.html，已经自动引入了 main.bundle.js而且注释已被删除。

至此，咱们已经成功实现自动生成项目中的HTML文件了。

3. 清理/dist文件夹

每次执行npm run build 打包时，都会有上次的代码遗留下来，致使咱们的 /dist 文件夹至关杂乱。一般，在每次构建前清理 /dist 文件夹，是比较推荐的作法。

clean-webpack-plugin 是一个比较普及的管理插件，让咱们安装和配置下：

npm install clean-webpack-plugin --save-dev

在webpack.config.js 中使用：

const CleanWebpackPlugin = require('clean-webpack-plugin')

在 plugins 中加入：

new CleanWebpackPlugin(['dist'],{root: path.join(__dirname, '../')})

第一个参数表示文件夹路径数组；第二个参数是 options 配置项，root 为到webpack根文件夹的绝对路径，默认为 __dirname，因为dist文件夹和webpack.config.js再也不相同目录下，所以咱们须要从新定义 root 路径，以避免没法找到 dist 文件夹。

执行 npm run build ，在命令行中可见：

dist 文件夹已被删除了。