webpack生产环境基本配置

转载请注明 来源:http://www.eword.name/
Author：eword
Email:eword@eword.name

webpack生产环境基本配置

直接上webpack的配置文件webpack.config.js
这里增加了自定义js、imgs、media等目录。
各类型资源的配置说明参见后续相关章节。

一、安装所需的npm包

# 需要用npm安装的依赖包
> npm i  webpack@4.41.6  webpack-cli@3.3.11   style-loader@1.1.3  css-loader@3.4.2  less-loader@5.0.0  less@3.11.1 html-webpack-plugin@4.5.2  file-loader@5.0.2  url-loader@3.0.0  html-loader@0.5.5  file-loader@5.0.2  url-loader@3.0.0  html-loader@0.5.5  webpack-dev-server@3.10.3  mini-css-extract-plugin@0.9.0  postcss-loader@3.0.0  postcss-preset-env@6.7.0  optimize-css-assets-webpack-plugin@5.0.3  eslint@7.32.0 eslint-config-airbnb-base@15.0.0  eslint-loader@4.0.2 eslint-plugin-import@2.28.1 babel-loader@8.3.0 @babel/preset-env@7.14.7  @babel/core@7.14.6    @babel/polyfill@7.12.1  core-js@3.32.1 -D

二、webpack.config.js webpack的配置文件详解

/*
    开发环境配置，能让代码运行。

    webpack.config.js webpack的配置文件
    作用:指示webpack干哪些活(当你运行webpack指令时,会加载里面的配置)
    所有构建工具都是基于nodejs平台运行的~模块化默认采用commonjs.
    loader: 1.下载 2.使用(配置loader)
    plugins: 1.下载2. 引入 3.使用

    路径： ./webpack.config.js
*/

// resolve用来拼接绝对路径的方法
const { resolve } = require('path');
// 引入打包 html 文件的插件 html-webpack-plugin
const HtmlWebpackPlugin = require('html-webpack-plugin');
// 引入插件
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
// 引入压缩 css 的插件 optimize-css-assets-webpack-plugin
const OptimizeCssAssetsWebpackPlugin = require('optimize-css-assets-webpack-plugin');

// 设置 nodejs 环境变量,决定使用‘browserslist‘的哪个环境
// process.env.NODE_ENV = 'development';

// 复用 loader
const commonCssLoader = [
    // use数组中loader执行顺序:从右到左,从下到上依次执行
    // 创建style标签,将js中的样式资源插入进行,添加到head中生效
    // 'style-loader',
    // 这个loader取代style-loader。作用:提取js中的css成单独文件            
    {
        loader: MiniCssExtractPlugin.loader,
        options: {
            // 这里可以指定一个 publicPath
            // 默认使用 webpackOptions.output中的publicPath
            publicPath: '../'
        },
    },
    // 将css文件变成commonjs模块加载js中,里面内容是样式字符串
    'css-loader',
    /*
        css兼容性处理: postcss --> postcss-loader postcss-preset-env
        postcss-preset-env的作用是帮postcss找到package.json中browserslist里面的配置,
        通过配置加载指定的css兼容性样式，可以在 github上找到 browserslist 的更多配置。
        以下举例应该在package.json 配置的内容。
        ========package.json  文件 begin=========
                        "browserslist":{
                            //开发环境-->设置node环境变量: process.env.NODE_ENV = development
                            "development":[
                                "last 1 chrome version",
                                "last 1 firefox version",
                                "last 1 safari version",
                                "ie 9-12"
                            ],
                            //生产环境：默认是生产环境
                            "production":[
                                ">0.2%",
                                "not dead",
                                "not op_mini all"
                            ]
                        },
            ========package.json  文件 end=========
    */
    //使用loader的默认配置
    //'postcss-loader"
    //修改loader的配置
    {
        loader: 'postcss-loader',
        options: {
            ident: 'postcss',
            plugins: () => [
                // postcss的插件
                require('postcss-preset-env')()
            ]

        }
    }
]
module.exports = {
    // webpack配置
    // 入口起点文件
    entry: './src/js/index.js',
    // 输出
    output: {
        // 输出文件名
        filename: 'js/built.js',
        // 输出路径
        // __dirname nodejs的变量,代表当前文件的目录绝对路径
        path: resolve(__dirname, 'build'),
    },
    // loader的配置
    module: {
        rules: [
            // 详细loader配置
            //不同文件必须配置不同loader处理

            // 打包 css 文件的详细loader配置
            {
                // 匹配哪些文件
                test: /\.css$/,
                // 使用哪些loader进行处理
                use: [...commonCssLoader],
            },

            //打包less 文件的详细loader配置
            {
                //匹配哪些文件
                test: /\.less$/,
                //使用哪些loader进行处理
                use: [
                    ...commonCssLoader,
                    //将less文件编译成css文件
                    //需要下载less-loader和less
                    'less-loader'
                ]
            },

            /*
           语法检查: eslint-loader eslint
           注意:只检查自己写的源代码,第三方的库是不用检查的
           设置检查规则:
               airbnb-->eslint-config-airbnb-base eslint-plugin-import eslint

               在package.json中eslintConfig中设置
                 "eslintConfig": {
                       "extends": "airbnb-base"
                   }
           
           */
            {
                test: /\.js$/,
                // 指定检查的目录，或者配置排除某些文件夹
                // include: [path.resolve(__dirname, 'src')], 
                // 注意:只检查自己写的源代码,第三方的库是不用检查的,这里排除node_modules文件夹
                exclude: /node_modules/,
                loader: 'eslint-loader',
                /*
                1. pre 优先处理
                2. normal 正常处理（默认）
                3. inline 其次处理
                4. post 最后处理
                */
                enforce: 'pre',
                options: {
                    // 这里的配置项参数将会被传递到 eslint 的 CLIEngine
                    // 自动修复eslint的错误
                    fix: true,
                },
            },
            /*
                 js兼容性处理:babel-loader @babel/core @babel/preset-env
                 1.基本js兼容性处理 @babel/preset-env
                 问题：只能转换基本语法，如promise不能转换 
                 2．全部js兼容性处理 --> @babel/polvfill
                 问题：我只要解决部分兼容性问题，但是将所有兼容性代码全部引入，体积太大了~ 
                 3. 需要做兼容性处理的就做：按需加载 --> core-js
                 */
            {
                test: /\.(?:js|mjs|cjs)$/,
                // 指定检查的目录，或者配置排除某些文件夹
                // include: [path.resolve(__dirname, 'src')], 
                // 注意:只检查自己写的源代码,第三方的库是不用检查的,这里排除node_modules文件夹
                loader: "babel-loader",
                exclude: /node_modules/,
                options: {
                    // 预设：指示 babel 做怎么样的兼容性处理
                    "presets": [
                        [
                            "@babel/preset-env",
                            {
                                // 按需加载
                                useBuiltIns: 'usage',
                                // 制定 core-js 版本
                                corejs: {
                                    version: 3
                                },
                                //指定兼容性做到哪个版本的浏览器
                                targets: {
                                    chrome: '60',
                                    firefox: '60',
                                    ie: '9',
                                    safari: '10',
                                    edge: '17'
                                }
                            }
                        ]
                    ]
                }
            },
            {
                // 问题：默认处理不了 html 中的 img 图片
                // 处理图片资源
                test: /\.(jpg|png|gif)$/,
                // 使用一个loader
                // 下载url-loader file-loader
                loader: 'url-loader',
                options: {
                    // 图片大小小于8kb,就会被base64处理
                    // 优点:减少请求数量(减轻服务器压力)
                    // 缺点:图片体积会更大(文件请求速度更慢)
                    limit: 8 * 1024,
                    // 问题:因为url-loader默认使用es6模块化解析, 而html-loader默认引入图片是commonjs
                    // 解析时会出问题: [object Module]
                    // 解决:关闭url-loader的es6模块化,使用commonjs解析
                    esModule: false,
                    // 给图片进行重命名
                    // [hash:10]取图片的hash的前10位
                    // [ext]取文件原来扩展名
                    name: '[hash:10].[ext]',
                    // 设置输出目录，将打包的图片资源放到imgs文件夹
                    outputPath: './imgs',
                },
            },
            {
                test: /\.html$/,
                // 处理html文件的img图片(负责引入img,从而能被url-loader进行处理)
                loader: 'html-loader',
                options:
                {
                    // 默认情况下,生成使用ES块语法的Js模块
                    // 问题:生成的图片显示错误
                    // 解决: esModule改为false
                    esModule: false,
                },
            },
            {
                // 打包其他资源(除了html/js/css资源以外的资源)
                // 排除css/is/html资源
                exclude: /\.(css|js|html|less|jpg|png|gif)$/,
                loader: 'file-loader',
                options:
                {
                    // 给资源进行重命名
                    // [hash:10]取资源的hash的前10位
                    // [ext]取文件原来扩展名
                    name: '[hash:10]. [ext]',
                    // 设置输出目录，将打包的其他资源放到media 文件夹
                    outputPath: './media',
                },
            },

        ],
    },
    // plugins的配置
    plugins: [
        // 详细的plugins配置
        // html-webpack-plugin
        // 功能:默认会创建一个空的HTML, 自动引入打包输出的所有资源(JS/CSS)
        // 需求:需要有结构的HTML文件
        new HtmlWebpackPlugin({
            // 复制../src/index.html'文件,并自动引入打包输出的所有资源(JS/CS5)
            template: './src/index.html',
            //压缩 html 代码
            minify: {
                //移除空格
                collapseWhitespace: true,
                //移除注释
                removeComments: true
            }
        }),
        new MiniCssExtractPlugin({
            //对输出的css文件进行重命名，这里单独为生成的 css 创建一个 css 文件夹。
            filename: './css/[name].css',
            chunkFilename: "./css/[id].css",
            ignoreOrder: false,
            linkType: "text/css",
        }),
        // 压缩 css
        new OptimizeCssAssetsWebpackPlugin(),
    ],
    // 模式  development  开发环境，production 生产环境
    // mode: 'development',
    // 生产环境下会自动压缩js代码
    mode: 'production',

    // 开发服务器devServer:用来自动化(自动编译, 自动打开浏览器, 自动刷新浏览器)
    // 特点:只会在内存中编译打包,不会有任何输出
    // 启动devServer指令为: npx webpack-dev-server
    devServer: {
        // 项目构建后路径
        contentBase: resolve(__dirname, 'build'),
        // 启动gzip压缩
        compress: true,
        // 端口号
        port: 3000,
        // 自动打开浏览器
        open: true,
    },
};

三、去除webpack.config.js配置文件过多的注释

const { resolve } = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const OptimizeCssAssetsWebpackPlugin = require('optimize-css-assets-webpack-plugin');

// 设置 nodejs 环境变量,决定使用‘browserslist‘的哪个环境
// process.env.NODE_ENV = 'development';

// 复用 loader
const commonCssLoader = [
    {
        loader: MiniCssExtractPlugin.loader,
        options: {
            // 这里可以指定一个 publicPath
            // 默认使用 webpackOptions.output中的publicPath
            publicPath: '../'
        },
    },
    'css-loader',
    {
        loader: 'postcss-loader',
        options: {
            ident: 'postcss',
            plugins: () => [
                require('postcss-preset-env')()
            ]

        }
    }
]
module.exports = {
    // webpack配置
    // 入口起点文件
    entry: './src/js/index.js',
    // 输出
    output: {
        // 输出文件名
        filename: 'js/built.js',
        // 输出路径
        // __dirname nodejs的变量,代表当前文件的目录绝对路径
        path: resolve(__dirname, 'build'),
    },
    // loader的配置
    module: {
        rules: [
            // 详细loader配置
            //不同文件必须配置不同loader处理

            // 打包 css 文件的详细loader配置
            {
                test: /\.css$/,
                use: [...commonCssLoader],
            },

            //打包less 文件的详细loader配置
            {
                test: /\.less$/,
                use: [
                    ...commonCssLoader,
                    'less-loader'
                ]
            },

            /*
           语法检查: eslint-loader eslint
           注意:只检查自己写的源代码,第三方的库是不用检查的
           */
            {
                test: /\.(?:js|mjs|cjs)$/,
                exclude: /node_modules/,
                loader: 'eslint-loader',
                /*
                1. pre 优先处理
                2. normal 正常处理（默认）
                3. inline 其次处理
                4. post 最后处理
                */
                enforce: 'pre',
                options: {
                    // 自动修复eslint的错误
                    fix: true,
                },
            },
            /*
                 js兼容性处理
            */
            {
                test: /\.(?:js|mjs|cjs)$/,
                // 注意:只检查自己写的源代码,第三方的库是不用检查的,这里排除node_modules文件夹
                loader: "babel-loader",
                exclude: /node_modules/,
                options: {
                    // 预设：指示 babel 做怎么样的兼容性处理
                    "presets": [
                        [
                            "@babel/preset-env",
                            {
                                // 按需加载
                                useBuiltIns: 'usage',
                                // 制定 core-js 版本
                                corejs: {
                                    version: 3
                                },
                                //指定兼容性做到哪个版本的浏览器
                                targets: {
                                    chrome: '60',
                                    firefox: '60',
                                    ie: '9',
                                    safari: '10',
                                    edge: '17'
                                }
                            }
                        ]
                    ]
                }
            },
            {
                // 问题：默认处理不了 html 中的 img 图片
                // 处理图片资源
                test: /\.(jpg|png|gif)$/,
                loader: 'url-loader',
                options: {
                    // 图片大小小于8kb,就会被base64处理
                    limit: 8 * 1024,
                    // 解决:关闭url-loader的es6模块化,使用commonjs解析
                    esModule: false,
                    // 给图片进行重命名
                    // [hash:10]取图片的hash的前10位
                    // [ext]取文件原来扩展名
                    name: '[hash:10].[ext]',
                    // 设置输出目录，将打包的图片资源放到imgs文件夹
                    outputPath: './imgs',
                },
            },
            {
                test: /\.html$/,
                // 处理html文件的img图片(负责引入img,从而能被url-loader进行处理)
                loader: 'html-loader',
                options:
                {
                    // 解决: esModule改为false
                    esModule: false,
                },
            },
            {
                // 打包其他资源(除了html/js/css资源以外的资源)
                // 排除css/is/html资源
                exclude: /\.(css|js|html|less|jpg|png|gif)$/,
                loader: 'file-loader',
                options:
                {
                    // 给资源进行重命名
                    // [hash:10]取资源的hash的前10位
                    // [ext]取文件原来扩展名
                    name: '[hash:10]. [ext]',
                    // 设置输出目录，将打包的其他资源放到media 文件夹
                    outputPath: './media',
                },
            },

        ],
    },
    // plugins的配置
    plugins: [

        new HtmlWebpackPlugin({
            // 复制../src/index.html'文件,并自动引入打包输出的所有资源(JS/CS5)
            template: './src/index.html',
            //压缩 html 代码
            minify: {
                //移除空格
                collapseWhitespace: true,
                //移除注释
                removeComments: true
            }
        }),
        new MiniCssExtractPlugin({
            //对输出的css文件进行重命名，这里单独为生成的 css 创建一个 css 文件夹。
            filename: './css/[name].css',
            chunkFilename: "./css/[id].css",
            ignoreOrder: false,
            linkType: "text/css",
        }),
        // 压缩 css
        new OptimizeCssAssetsWebpackPlugin(),
    ],
    // 模式  development  开发环境，production 生产环境
    // mode: 'development',
    // 生产环境下会自动压缩js代码
    mode: 'production',

    // 开发服务器devServer:用来自动化(自动编译, 自动打开浏览器, 自动刷新浏览器)
    // 启动devServer指令为: npx webpack-dev-server
    devServer: {
        // 项目构建后路径
        contentBase: resolve(__dirname, 'build'),
        // 启动gzip压缩
        compress: true,
        // 端口号
        port: 3000,
        // 自动打开浏览器
        open: true,
    },
};

四、package.json 文件

{
  "name": "notes_demo",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "eword <eword@eword.name> (http://www.eword.name/)",
  "license": "ISC",
  "devDependencies": {
    "@babel/core": "^7.14.6",
    "@babel/preset-env": "^7.14.7",
    "babel-loader": "^8.3.0",
    "core-js": "^3.32.1",
    "css-loader": "^3.4.2",
    "eslint": "^7.32.0",
    "eslint-config-airbnb-base": "^15.0.0",
    "eslint-loader": "^4.0.2",
    "eslint-plugin-import": "^2.28.1",
    "file-loader": "^5.0.2",
    "find-cache-dir": "^5.0.0",
    "html-loader": "^0.5.5",
    "html-webpack-plugin": "^4.5.2",
    "less": "^3.11.1",
    "less-loader": "^5.0.0",
    "mini-css-extract-plugin": "^0.9.0",
    "optimize-css-assets-webpack-plugin": "^5.0.3",
    "postcss-loader": "^3.0.0",
    "postcss-preset-env": "^6.7.0",
    "style-loader": "^1.1.3",
    "uninstall": "0.0.0",
    "url-loader": "^3.0.0",
    "webpack": "^4.41.6",
    "webpack-cli": "^3.3.11",
    "webpack-dev-server": "^3.10.3"
  },
  "browserslist": {
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version",
      "ie 9-12"
    ],
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ]
  },
  "eslintConfig": {
    "extends": "airbnb-base"
  }
}

五、工程目录

.
├── build
│   ├── css
│   │   ├── 1.css
│   │   └── 2.css
│   ├── imgs
│   │   ├── 32de6ca13b.jpg
│   │   ├── 5e7e5c80c7.jpg
│   │   └── ae7bf15c0d.jpg
│   ├── index.html
│   ├── js
│   │   ├── 1.built.js
│   │   ├── 2.built.js
│   │   └── built.js
│   └── media
│       └── cffec944b5. ttf
├── src
│   ├── css
│   │   ├── iconfont.css
│   │   └── index.less
│   ├── imgs
│   │   ├── img.jpg
│   │   ├── img1.jpg
│   │   ├── img2.jpg
│   │   └── img3.jpg
│   ├── index.html
│   ├── js
│   │   ├── iconfont.js
│   │   └── index.js
│   └── media
│       ├── iconfont.json
│       └── iconfont.ttf
└── webpack.config.js