從零搭建Webpack5-react腳手架的實(shí)現(xiàn)步驟(附源碼)
更新時(shí)間：2021年08月02日 16:07:32 作者：Peter譚老師
本文主要介紹了從零搭建Webpack5-react腳手架的實(shí)現(xiàn)步驟，文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下
webpack5
近期終于有時(shí)間和精力專注于公司技術(shù)基礎(chǔ)建設(shè)了，于是一開始，將公司的Saas系統(tǒng)改造成了微前端模式，解決了歷史遺留的一部分問題
接著，想著webpack5已經(jīng)發(fā)布這么久了，該在生產(chǎn)環(huán)境用起來了，也順勢想推動微前端、webpack5、vite在業(yè)內(nèi)的普及率,沒看過我之前文章的朋友可以在文末找找,干貨真的很多
正式開始
webpack5升級后，有哪些改變？
- 通過持久化緩存提高性能
- 采用更好的持久化緩存算法和默認(rèn)行為
- 通過優(yōu)化 Tree Shaking 和代碼生成來減小Bundle體積（干掉了nodejs的polyfill）
- 提高 Web 平臺的兼容性
- 清除之前為了實(shí)現(xiàn) Webpack4 沒有不兼容性變更導(dǎo)致的不合理 state
- 嘗試現(xiàn)在引入重大更改來為將來的功能做準(zhǔn)備，以使我們能夠盡可能長時(shí)間地使用 Webpack 5
- 新增Module Federation(聯(lián)邦模塊)
搭建指南
推薦大家使用我在我們公司(深圳明源云空間)做的腳手架，給大家一鍵生成項(xiàng)目模板，這樣大家在看本文的時(shí)候會得到更好的提升
生成模板步驟：
npm i ykj-cli -g ykj init webpack5 （這里選擇通用項(xiàng)目模板） cd webpack5 yarn yarn dev
開始搭建
首先新建文件夾，使用yarn初始化項(xiàng)目
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標(biāo)簽 postcss等樣式處理的庫（mini-css-extract-plugin要安裝@next版本的）
yarn add less less-loader css-loader style-loader mini-css-extract-plugin@next -D
安裝相關(guān)babel依賴
yarn add core-js@3.9.0 @babel/core@next babel-loader@next @babel/preset-env@next -D
babel具體要哪些配置，建議大家參考我的模板里面
完成了依賴的準(zhǔn)備工作,開始搭建項(xiàng)目
項(xiàng)目根目錄創(chuàng)建config文件夾，用于放置webpack配置文件
config文件夾下新建四個文件
paths.js//存放路徑 webpack.base.js //基礎(chǔ)配置 webpack.dev.js//開發(fā)配置 webpack.prod.js//生產(chǎn)配置
在paths文件內(nèi)，用變量記錄幾個關(guān)鍵目錄:
const path = require('path');
module.exports = {
// 源碼目錄
src: path.resolve(__dirname, '../src'),
// 構(gòu)建后的資源產(chǎn)物文件夾
build: path.resolve(__dirname, '../dist'),
// 靜態(tài)資源
public: path.resolve(__dirname, '../public'),
};
編寫基礎(chǔ)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算法進(jìn)行了優(yōu)化，這里可以在chunkhash和contenthash中選擇一個，建議contenthash
編寫基礎(chǔ)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對于資源，類似：圖片、字體文件等，可以用內(nèi)置的asset去處理，不用url-loader和file-loader了
接著，由于項(xiàng)目需要配置別名和省略后綴名，我們先配置resolve字段(我是TypeScript+React技術(shù)棧):
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',
},
},
插件的話，由于是基礎(chǔ)配置，只要一個clean、html的插件即可
plugins: [
new CleanWebpackPlugin(),
new HtmlWebpackPlugin({
template: './public/index.html',
}),
],
在項(xiàng)目根目錄新建文件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],
};
};
這樣，我們的基礎(chǔ)webpack配置就好了,捋一捋先：
- 用babel處理tsx ts 和es高階語法
- 用loader處理less語法
- 用插件處理了html和負(fù)責(zé)清理工作
- 用resolve字段配置了別名和省略文件后綴
- 用內(nèi)置的asset處理了靜態(tài)文件，例如圖片等
編寫webpack.dev.js開發(fā)配置
引入依賴
const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
const { HotModuleReplacementPlugin } = require('webpack');
const { merge } = require('webpack-merge');
const common = require('./webpack.base');
先引入了熱更新、合并配置、基礎(chǔ)配置、官方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);
注意：這里要設(shè)置 target: 'web'才會有熱更新效果
devtool在開發(fā)模式最佳實(shí)踐是:eval-cheap-module-source-map
這樣，我們的開發(fā)模式配置就搭建好了，只要在public文件夾下編寫一個index.html，就可以跟之前一樣，開始寫react項(xiàng)目了
開始編寫webpack.prod.js生產(chǎn)配置
引入依賴：
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const { merge } = require('webpack-merge');
const common = require('./webpack.base');
生產(chǎn)環(huán)境要抽離css標(biāo)簽，所以這里針對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);
這樣生產(chǎn)的配置也編寫好了
生產(chǎn)環(huán)境devtool最佳實(shí)踐是: 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,現(xiàn)在是webpack serve!!!
配置代碼質(zhì)量管控流程
新增依賴
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'], // 該規(guī)則強(qiáng)制使用一致的分號
'no-unused-vars': 'off', // 禁止未使用過的變量
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off', //生產(chǎn)環(huán)境禁用 debugger
'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off', //生產(chǎn)環(huán)境禁用 console
'default-case': ['warn', { commentPattern: '^no default$' }], //要求 Switch 語句中有 Default
'dot-location': ['warn', 'property'], // 強(qiáng)制在點(diǎn)號之前或之后換行
eqeqeq: ['error', 'allow-null'], //要求使用 === 和 !==
'new-parens': 'warn', //要求調(diào)用無參構(gòu)造函數(shù)時(shí)帶括號
'no-caller': 'error', // 禁用 caller 或 callee
'no-const-assign': 'error', //不允許改變用 const 聲明的變量
'no-dupe-args': 'error', //禁止在 function 定義中出現(xiàn)重復(fù)的參數(shù)
'no-dupe-class-members': 'error', //不允許類成員中有重復(fù)的名稱
'no-dupe-keys': 'warn', //禁止在對象字面量中出現(xiàn)重復(fù)的鍵
'no-extend-native': 'warn', //禁止擴(kuò)展原生對象
'no-extra-bind': 'warn', //禁止不必要的函數(shù)綁定
'no-fallthrough': 'error', //禁止 case 語句落空
'no-func-assign': 'warn', //禁止對 function 聲明重新賦值
'no-implied-eval': 'error', //禁用隱式的 eval()
'no-label-var': 'error', //禁用與變量同名的標(biāo)簽
'no-loop-func': 'error', //禁止循環(huán)中存在函數(shù)
'no-mixed-operators': [
'warn',
{
groups: [
['&', '|', '^', '~', '<<', '>>', '>>>'],
['==', '!=', '===', '!==', '>', '>=', '<', '<='],
['&&', '||'],
['in', 'instanceof'],
],
allowSamePrecedence: false,
},
], //禁止混合使用不同的操作符
'no-multi-str': 'warn', //禁止多行字符串 (需要多行時(shí)用\n)
'no-native-reassign': 'warn', //禁止重新分配本地對象
'no-obj-calls': 'warn', //禁止將全局對象當(dāng)作函數(shù)進(jìn)行調(diào)用
'no-redeclare': 'error', //禁止重新聲明變量
'no-script-url': 'warn', //禁用 Script URL
'no-shadow-restricted-names': 'warn', //關(guān)鍵字不能被遮蔽
'no-sparse-arrays': 'warn', //禁用稀疏數(shù)組
'no-this-before-super': 'warn', //在構(gòu)造函數(shù)中禁止在調(diào)用 super()之前使用 this 或 super
'no-undef': 'error', //禁用未聲明的變量
'no-unexpected-multiline': 'warn', //禁止使用令人困惑的多行表達(dá)式
'no-use-before-define': [
'warn',
{
functions: false,
classes: false,
variables: false,
},
], //禁止定義前使用
'no-with': 'error', //禁用 with 語句
radix: 'error', //禁用函數(shù)內(nèi)沒有 yield 的 generator 函數(shù)
'rest-spread-spacing': ['warn', 'never'], //強(qiáng)制限制擴(kuò)展運(yùn)算符及其表達(dá)式之間的空格
'react/jsx-no-undef': 'error', //在 JSX 中禁止未聲明的變量
'react/no-direct-mutation-state': 'error', //禁止 this.state 的直接變化
'react/jsx-uses-react': 'warn', //防止 React 被錯誤地標(biāo)記為未使用
'no-alert': 0, //禁止使用alert confirm prompt
'no-duplicate-case': 2, //switch中的case標(biāo)簽不能重復(fù)
'no-eq-null': 2, //禁止對null使用==或!=運(yùn)算符
'no-inner-declarations': [2, 'functions'], //禁止在塊語句中使用聲明（變量或函數(shù)）
'no-iterator': 2, //禁止使用__iterator__ 屬性
'no-negated-in-lhs': 2, //in 操作符的左邊不能有!
'no-octal-escape': 2, //禁止使用八進(jìn)制轉(zhuǎn)義序列
'no-plusplus': 0, //禁止使用++，--
'no-self-compare': 2, //不能比較自身
'no-undef-init': 2, //變量初始化時(shí)不能直接給它賦值為undefined
'no-unused-expressions': 2, //禁止無用的表達(dá)式
'no-useless-call': 2, //禁止不必要的call和apply
'init-declarations': 0, //聲明時(shí)必須賦初值
'prefer-const': 0, //首選const
'use-isnan': 2, //禁止比較時(shí)使用NaN，只能用isNaN()
'vars-on-top': 2, //var必須放在作用域頂部
},
};
單元測試
新增命令：
"test": "jest", //進(jìn)行測試 "test-c": "jest --coverage" //生成測試報(bào)告
安裝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內(nèi)置的一些東西，可以讓我們省去很多配置，看起來會更簡單
到此這篇關(guān)于從零搭建Webpack5-react腳手架的實(shí)現(xiàn)步驟(附源碼)的文章就介紹到這了,更多相關(guān)Webpack5-react搭建腳手架內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
使用react-beautiful-dnd實(shí)現(xiàn)列表間拖拽踩坑
相比于react-dnd，react-beautiful-dnd更適用于列表之間拖拽的場景，本文主要介紹了使用react-beautiful-dnd實(shí)現(xiàn)列表間拖拽踩坑，感興趣的可以了解一下2021-05-05
詳解react native頁面間傳遞數(shù)據(jù)的幾種方式
這篇文章主要介紹了詳解react native頁面間傳遞數(shù)據(jù)的幾種方式，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-11-11
這篇文章主要介紹了一文理解R通過圍繞主題展開詳細(xì)edux及其工作原理，文章通過主題展開詳細(xì)的內(nèi)容介紹，具有一定的參考價(jià)值，需要的小伙伴可以參考一下2022-09-09
React如何實(shí)現(xiàn)像Vue一樣將css和js寫在同一文件
這篇文章主要介紹了React如何實(shí)現(xiàn)像Vue一樣將css和js寫在同一文件問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01
React Router 如何使用history跳轉(zhuǎn)的實(shí)現(xiàn)
這篇文章主要介紹了React Router 如何使用history跳轉(zhuǎn)的實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04
React.render?是?React?的最基本方法，用于將模板轉(zhuǎn)為?HTML?語言，并插入指定的?DOM?節(jié)點(diǎn)，這篇文章主要介紹了ReactJS入門實(shí)例教程,需要的朋友可以參考下2022-06-06
React利用scheduler思想實(shí)現(xiàn)任務(wù)的打斷與恢復(fù)
這篇文章主要為大家詳細(xì)介紹了React如何利用scheduler思想實(shí)現(xiàn)任務(wù)的打斷與恢復(fù),文中的示例代碼講解詳細(xì),感興趣的小伙伴可以參考一下2024-03-03
webpack4+react多頁面架構(gòu)的實(shí)現(xiàn)
webpack在單頁面打包上應(yīng)用廣泛，以create-react-app為首的腳手架眾多。這篇文章主要介紹了webpack4+react多頁面架構(gòu)的實(shí)現(xiàn)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-10-10
jenkins分環(huán)境部署vue/react項(xiàng)目的方法步驟
這篇文章主要介紹了jenkins分環(huán)境部署vue/react項(xiàng)目的方法，本文分步驟給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-02-02
React競態(tài)條件Race Condition實(shí)例詳解
這篇文章主要為大家介紹了React競態(tài)條件Race Condition實(shí)例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-11-11