从零搭建Webpack5-react脚手架的实现步骤(附源码)
目录
- webpack5
- 正式开始
- 搭建指南
- 开始搭建
- 完成了依赖的准备工作,开始搭建项目
- 编写webpack.dev.js开发配置
- 开始编写webpack.prod.js生产配置
- 编写scripts命令
- 配置代码质量管控流程
- 单元测试
webpack5
近期终于有时间和精力专注于公司技术基础建设了，于是一开始，将公司的Saas系统改造成了微前端模式，解决了历史遗留的一部分问题
接着，想着webpack5已经发布这么久了，该在生产环境用起来了，也顺势想推动微前端、webpack5、vite在业内的普及率,没看过我之前文章的朋友可以在文末找找,干货真的很多
正式开始
webpack5升级后，有哪些改变？
- 通过持久化缓存提高性能
- 采用更好的持久化缓存算法和默认行为
- 通过优化 Tree Shaking 和代码生成来减小Bundle体积（干掉了nodejs的polyfill）
- 提高 Web 平台的兼容性
- 清除之前为了实现 Webpack4 没有不兼容性变更导致的不合理 state
- 尝试现在引入重大更改来为将来的功能做准备，以使我们能够尽可能长时间地使用 Webpack 5
- 新增Module Federation(联邦模块)
搭建指南
推荐大家使用我在我们公司(深圳明源云空间)做的脚手架，给大家一键生成项目模板，这样大家在看本文的时候会得到更好的提升
生成模板步骤：
npm i ykj-cli -g ykj init webpack5 （这里选择通用项目模板） cd webpack5 yarn yarn dev
开始搭建
首先新建文件夹，使用yarn初始化项目
mkdir webpack5-demo cd webpack5-demo yarn init webpack5-demo ...一路回车
下载webpack webpack-cli最新版本:
yarn add webpack@next webpack-cli@next -D
然后安装React react-dom17版本的库
yarn add react@17.0.0 react-dom@17.0.0 --save
接着安装react官方热更新推荐的库
yarn add react-refresh -D
安装less css style标签 postcss等样式处理的库（mini-css-extract-plugin要安装@next版本的）
yarn add less less-loader css-loader style-loader mini-css-extract-plugin@next -D
安装相关babel依赖
yarn add core-js@3.9.0 @babel/core@next babel-loader@next @babel/preset-env@next -D
babel具体要哪些配置，建议大家参考我的模板里面
完成了依赖的准备工作,开始搭建项目
项目根目录创建config文件夹，用于放置webpack配置文件
config文件夹下新建四个文件
paths.js//存放路径 webpack.base.js //基础配置 webpack.dev.js//开发配置 webpack.prod.js//生产配置
在paths文件内，用变量记录几个关键目录:
const path = require('path');
module.exports = {
// 源码目录
src: path.resolve(__dirname, '../src'),
// 构建后的资源产物文件夹
build: path.resolve(__dirname, '../dist'),
// 静态资源
public: path.resolve(__dirname, '../public'),
};
编写基础webpack.base.js配置文件,引入依赖
//webpack.base.js
const { CleanWebpackPlugin } = require('clean-webpack-plugin');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const path = require('path');
const paths = require('./paths');
编写entry和output字段：
entry: paths.src + 'index.tsx',
output: {
path: path.resolve(__dirname, '../dist'),
filename: '[name].[contenthash].js',
publicPath: '',
},
这里要注意的是，webpack5对contenthash算法进行了优化，这里可以在chunkhash和contenthash中选择一个，建议contenthash
编写基础loader配置:
module: {
rules: [
{
use: 'babel-loader',
test: /\.(ts|tsx)$/,
exclude: /node_modules/,
},
{
use: ['style-loader', 'css-loader', 'less-loader'],
test: /\.(css|less)$/,
},
{
type: 'asset',
test: /\.(png|svg|jpg|jpeg|gif)$/i,
},
],
},
这里要注意的是：webpack5对于资源，类似：图片、字体文件等，可以用内置的asset去处理，不用url-loader和file-loader了
接着，由于项目需要配置别名和省略后缀名，我们先配置resolve字段(我是TypeScript+React技术栈):
resolve: {
extensions: ['.ts', '.tsx', '.js', '.json', '.jsx'],
alias: {
'@': paths.src,
'@c': paths.src + '/components',
'@m': paths.src + '/model',
'@s': paths.src + '/services',
'@t': paths.src + '/types',
},
},
插件的话，由于是基础配置，只要一个clean、html的插件即可
plugins: [
new CleanWebpackPlugin(),
new HtmlWebpackPlugin({
template: './public/index.html',
}),
],
在项目根目录新建文件babel.config.js
const { argv } = require('yargs');
const isDev = argv.mode === 'development';
const plugins = [
[
'const-enum',
{
transform: 'constObject',
},
],
'lodash',
'@babel/plugin-transform-runtime',
//支持import 懒加载
'@babel/plugin-syntax-dynamic-import',
'@babel/plugin-transform-async-to-generator',
'transform-class-properties',
[
'import',
{
libraryName: 'antd',
libraryDirectory: 'es',
style: true, // or 'css'
},
'antd',
],
[
'import',
{
libraryName: 'ykj-ui',
libraryDirectory: 'lib/components',
style: true, // or 'css'
},
'ykj-ui',
],
];
module.exports = (api) => {
api.cache(true);
return {
presets: [
[
'@babel/preset-env',
{
corejs: 3.9,
useBuiltIns: 'usage',
},
],
[
'@babel/preset-react',
{
runtime: 'automatic',
},
],
'@babel/preset-typescript',
],
plugins: isDev ? [...plugins, 'react-refresh/babel'] : [...plugins],
};
};
这样，我们的基础webpack配置就好了,捋一捋先：
- 用babel处理tsx ts 和es高阶语法
- 用loader处理less语法
- 用插件处理了html和负责清理工作
- 用resolve字段配置了别名和省略文件后缀
- 用内置的asset处理了静态文件，例如图片等
编写webpack.dev.js开发配置
引入依赖
const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
const { HotModuleReplacementPlugin } = require('webpack');
const { merge } = require('webpack-merge');
const common = require('./webpack.base');
先引入了热更新、合并配置、基础配置、官方react热更新依赖
接着编写配置
const devConfig = {
mode: 'development',
devServer: {
port: 3000,
contentBase: '../dist',
open: true,
hot: true,
},
target: 'web',
plugins: [new HotModuleReplacementPlugin(), new ReactRefreshWebpackPlugin()],
devtool: 'eval-cheap-module-source-map',
};
module.exports = merge(common, devConfig);
注意：这里要设置 target: 'web'才会有热更新效果
devtool在开发模式最佳实践是:eval-cheap-module-source-map
这样，我们的开发模式配置就搭建好了，只要在public文件夹下编写一个index.html，就可以跟之前一样，开始写react项目了
开始编写webpack.prod.js生产配置
引入依赖：
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const { merge } = require('webpack-merge');
const common = require('./webpack.base');
生产环境要抽离css标签，所以这里针对less和css要做特殊处理,一个是postcss处理样式兼容性问题，一个是MiniCssExtractPlugin.loader:
const prodConfig = {
mode: 'production',
devtool: 'hidden-source-map',
module: {
rules: [
{
test: /\.(css|less)$/,
use: [MiniCssExtractPlugin.loader, 'css-loader', 'postcss-loader', 'less-loader'],
},
],
},
optimization: {
splitChunks: {
chunks: 'all',
name: false,
},
},
plugins: [new MiniCssExtractPlugin()],
};
module.exports = merge(common, prodConfig);
这样生产的配置也编写好了
生产环境devtool最佳实践是: hidden-source-map
编写scripts命令
"build": "webpack --config config/webpack.prod.js --mode production", "dev": "webpack serve --config config/webpack.dev.js --mode development",
注意：热更新以前是webpack-dev-server,现在是webpack serve!!!
配置代码质量管控流程
新增依赖
yarn add lint-staged @commitlint/cli @commitlint/config-conventional -D
编写代码、提交检测流程
"husky": {
"hooks": {
"pre-commit": "lint-staged",
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
},
"lint-staged": {
"src/**/*.{js,jsx,ts,tsx,json,css,less,md}": [
"prettier --write",
"eslint --fix",
"git add"
]
},
"browserslist": [
"ie >= 10",
"ff >= 30",
"chrome >= 34",
"safari >= 8",
"opera >= 23"
]
}
新增eslint配置：
//.eslintrc.js
module.exports = {
root: true,
parserOptions: {
ecmaVersion: 7,
sourceType: 'module',
},
parser: '@typescript-eslint/parser',
plugins: ['typescript', 'react'],
env: {
browser: true,
node: true,
es6: true,
},
rules: {
semi: ['error', 'always'], // 该规则强制使用一致的分号
'no-unused-vars': 'off', // 禁止未使用过的变量
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off', //生产环境禁用 debugger
'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off', //生产环境禁用 console
'default-case': ['warn', { commentPattern: '^no default$' }], //要求 Switch 语句中有 Default
'dot-location': ['warn', 'property'], // 强制在点号之前或之后换行
eqeqeq: ['error', 'allow-null'], //要求使用 === 和 !==
'new-parens': 'warn', //要求调用无参构造函数时带括号
'no-caller': 'error', // 禁用 caller 或 callee
'no-const-assign': 'error', //不允许改变用 const 声明的变量
'no-dupe-args': 'error', //禁止在 function 定义中出现重复的参数
'no-dupe-class-members': 'error', //不允许类成员中有重复的名称
'no-dupe-keys': 'warn', //禁止在对象字面量中出现重复的键
'no-extend-native': 'warn', //禁止扩展原生对象
'no-extra-bind': 'warn', //禁止不必要的函数绑定
'no-fallthrough': 'error', //禁止 case 语句落空
'no-func-assign': 'warn', //禁止对 function 声明重新赋值
'no-implied-eval': 'error', //禁用隐式的 eval()
'no-label-var': 'error', //禁用与变量同名的标签
'no-loop-func': 'error', //禁止循环中存在函数
'no-mixed-operators': [
'warn',
{
groups: [
['&', '|', '^', '~', '<<', '>>', '>>>'],
['==', '!=', '===', '!==', '>', '>=', '<', '<='],
['&&', '||'],
['in', 'instanceof'],
],
allowSamePrecedence: false,
},
], //禁止混合使用不同的操作符
'no-multi-str': 'warn', //禁止多行字符串 (需要多行时用\n)
'no-native-reassign': 'warn', //禁止重新分配本地对象
'no-obj-calls': 'warn', //禁止将全局对象当作函数进行调用
'no-redeclare': 'error', //禁止重新声明变量
'no-script-url': 'warn', //禁用 Script URL
'no-shadow-restricted-names': 'warn', //关键字不能被遮蔽
'no-sparse-arrays': 'warn', //禁用稀疏数组
'no-this-before-super': 'warn', //在构造函数中禁止在调用 super()之前使用 this 或 super
'no-undef': 'error', //禁用未声明的变量
'no-unexpected-multiline': 'warn', //禁止使用令人困惑的多行表达式
'no-use-before-define': [
'warn',
{
functions: false,
classes: false,
variables: false,
},
], //禁止定义前使用
'no-with': 'error', //禁用 with 语句
radix: 'error', //禁用函数内没有 yield 的 generator 函数
'rest-spread-spacing': ['warn', 'never'], //强制限制扩展运算符及其表达式之间的空格
'react/jsx-no-undef': 'error', //在 JSX 中禁止未声明的变量
'react/no-direct-mutation-state': 'error', //禁止 this.state 的直接变化
'react/jsx-uses-react': 'warn', //防止 React 被错误地标记为未使用
'no-alert': 0, //禁止使用alert confirm prompt
'no-duplicate-case': 2, //switch中的case标签不能重复
'no-eq-null': 2, //禁止对null使用==或!=运算符
'no-inner-declarations': [2, 'functions'], //禁止在块语句中使用声明（变量或函数）
'no-iterator': 2, //禁止使用__iterator__ 属性
'no-negated-in-lhs': 2, //in 操作符的左边不能有!
'no-octal-escape': 2, //禁止使用八进制转义序列
'no-plusplus': 0, //禁止使用++，--
'no-self-compare': 2, //不能比较自身
'no-undef-init': 2, //变量初始化时不能直接给它赋值为undefined
'no-unused-expressions': 2, //禁止无用的表达式
'no-useless-call': 2, //禁止不必要的call和apply
'init-declarations': 0, //声明时必须赋初值
'prefer-const': 0, //首选const
'use-isnan': 2, //禁止比较时使用NaN，只能用isNaN()
'vars-on-top': 2, //var必须放在作用域顶部
},
};
单元测试
新增命令：
"test": "【文章由高防cdn提供，感恩】jest", //进行测试 "test-c": "jest --coverage" //生成测试报告
安装jest等依赖:
yarn add jest-environment-enzyme ts-jest@next enzyme enzyme-adapter-react-17 enzyme-to-json @types/enzyme @types/enzyme-adapter-react-17 @types/enzyme-to-json -D
新建文件夹 test
编写第一个单元测试,引入依赖:
import App from '../src/App';
import { mount, shallow } from 'enzyme';
import React from 'react';
import toJson from 'enzyme-to-json'; //做快照
然后就可以愉快的开始写单元测试了哦
这样，一个webpack5的脚手架就搭建好了，webpack内置的一些东西，可以让我们省去很多配置，看起来会更简单
到此这篇关于从零搭建Webpack5-react脚手架的实现步骤(附源码)的文章就介绍到这了,更多相关Webpack5-react搭建脚手架内容请搜索hwidc以前的文章或继续浏览下面的相关文章希望大家以后多多支持hwidc！
【文章原创作者：http://www.1234xp.com/yz.html 转载请保留连接】