您好,登錄后才能下訂單哦!
這篇文章主要介紹如何搭建Webpack5-react腳手架,文中介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們一定要看完!
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處理了靜態文件,例如圖片等
引入依賴
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項目了
引入依賴:
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
"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": "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腳手架”這篇文章的所有內容,感謝各位的閱讀!希望分享的內容對大家有幫助,更多相關知識,歡迎關注億速云行業資訊頻道!
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。