webpack中使用Eslint的實現(xiàn)
一、Eslint介紹
要在webpack中使用Eslint首先我們先了解下什么是Eslint
1. 什么是Eslint
ESLint是一個用于在JavaScript代碼中發(fā)現(xiàn)和報告問題的靜態(tài)代碼分析工具。它可以檢測常見的編碼錯誤,如拼寫錯誤、變量未聲明、使用未定義的變量等,還可以檢測代碼格式問題,如縮進(jìn)、空格、括號使用等。
2. Eslint的使用場景
在以下情況下適合使用ESLint:
- 團(tuán)隊合作:如果開發(fā)團(tuán)隊有多個人編寫JavaScript代碼,則應(yīng)使用ESLint工具確保代碼的一致性和規(guī)范性。
- 提高開發(fā)效率:ESLint可以在編寫代碼時及時檢測出潛在的問題和錯誤,以幫助開發(fā)人員修復(fù)問題并提高開發(fā)效率。
- 維護(hù)代碼質(zhì)量:ESLint可以在代碼提交之前進(jìn)行預(yù)處理,以確保代碼符合代碼質(zhì)量標(biāo)準(zhǔn),有助于減少代碼維護(hù)負(fù)擔(dān)和工作復(fù)雜度。
3. 使用Eslint的好處
使用ESLint能為開發(fā)工作帶來以下好處:
提高代碼質(zhì)量:ESLint可以識別常見的編碼錯誤和格式問題,幫助開發(fā)人員捕獲并修復(fù)這些問題,從而提高代碼的質(zhì)量和穩(wěn)定性。
統(tǒng)一代碼風(fēng)格:ESLint允許開發(fā)團(tuán)隊指定代碼風(fēng)格規(guī)范,并自動檢查代碼是否符合規(guī)范,從而確保代碼一致性和可讀性。
減少錯誤和調(diào)試時間:ESLint可以在編碼時即時檢測常見問題和錯誤,從而減少錯誤并節(jié)省調(diào)試時間。
提高開發(fā)效率:ESLint可以自動檢測代碼問題,從而減少手動檢查和修復(fù)代碼的時間,幫助開發(fā)人員更快地編寫高質(zhì)量的代碼。
4. Eslint相關(guān)文檔和社區(qū)
Eslint 中文文檔:https://zh-hans.eslint.org/docs/latest/rules/getter-return
Eslint 英文文檔:https://eslint.org/docs/latest/
github Eslint https://github.com/eslint/eslint
5. ESlint 常用規(guī)則配置
{
"no-alert": 0, // 禁止使用alert confirm prompt
"no-array-constructor": 2, // 禁止使用數(shù)組構(gòu)造器
"no-bitwise": 0, // 禁止使用按位運算符
"no-caller": 1, // 禁止使用arguments.caller或arguments.callee
"no-catch-shadow": 2, // 禁止catch子句參數(shù)與外部作用域變量同名
"no-class-assign": 2, // 禁止給類賦值
"no-cond-assign": 2, // 禁止在條件表達(dá)式中使用賦值語句
"no-console": 2, // 禁止使用console
"no-const-assign": 2, // 禁止修改const聲明的變量
"no-constant-condition": 2, // 禁止在條件中使用常量表達(dá)式 if(true) if(1)
"no-continue": 0, // 禁止使用continue
"no-control-regex": 2, // 禁止在正則表達(dá)式中使用控制字符
"no-debugger": 2, // 禁止使用debugger
"no-delete-var": 2, // 不能對var聲明的變量使用delete操作符
"no-div-regex": 1, // 不能使用看起來像除法的正則表達(dá)式/=foo/
"no-dupe-keys": 2, // 在創(chuàng)建對象字面量時不允許鍵重復(fù)
"no-dupe-args": 2, // 函數(shù)參數(shù)不能重復(fù)
"no-duplicate-case": 2, // switch中的case標(biāo)簽不能重復(fù)
"no-else-return": 2, // 如果if語句里面有return,后面不能跟else語句
"no-empty": 2, // 塊語句中的內(nèi)容不能為空
"no-empty-character-class": 2, // 正則表達(dá)式中的[]內(nèi)容不能為空
"no-empty-label": 2, // 禁止使用空label
"no-eq-null": 2, // 禁止對null使用==或!=運算符
"no-eval": 1, // 禁止使用eval
"no-ex-assign": 2, // 禁止給catch語句中的異常參數(shù)賦值
"no-extend-native": 2, // 禁止擴(kuò)展native對象
"no-extra-bind": 2, // 禁止不必要的函數(shù)綁定
"no-extra-boolean-cast": 2, // 禁止不必要的bool轉(zhuǎn)換
"no-extra-parens": 2, // 禁止非必要的括號
"no-extra-semi": 2, // 禁止多余的冒號
"no-fallthrough": 1, // 禁止switch穿透
"no-floating-decimal": 2, // 禁止省略浮點數(shù)中的0 .5 3.
"no-func-assign": 2, // 禁止重復(fù)的函數(shù)聲明
"no-implicit-coercion": 1, // 禁止隱式轉(zhuǎn)換
"no-implied-eval": 2, // 禁止使用隱式eval
"no-inline-comments": 0, // 禁止行內(nèi)備注
"no-inner-declarations": [2, "functions"], // 禁止在塊語句中使用聲明(變量或函數(shù))
"no-invalid-regexp": 2, // 禁止無效的正則表達(dá)式
"no-invalid-this": 2, // 禁止無效的this,只能用在構(gòu)造器,類,對象字面量
"no-irregular-whitespace": 2, // 不能有不規(guī)則的空格
"no-iterator": 2, // 禁止使用__iterator__ 屬性
"no-label-var": 2, // label名不能與var聲明的變量名相同
"no-labels": 2, // 禁止標(biāo)簽聲明
"no-lone-blocks": 2, // 禁止不必要的嵌套塊
"no-lonely-if": 2, // 禁止else語句內(nèi)只有if語句
"no-loop-func": 1, // 禁止在循環(huán)中使用函數(shù)(如果沒有引用外部變量不形成閉包就可以)
"no-mixed-requires": [0, false], // 聲明時不能混用聲明類型
"no-mixed-spaces-and-tabs": [2, false], // 禁止混用tab和空格
"linebreak-style": [0, "windows"], // 換行風(fēng)格
"no-multi-spaces": 1, // 不能用多余的空格
"no-multi-str": 2, // 字符串不能用\換行
"no-multiple-empty-lines": [1, "max": 2}], // 空行最多不能超過2行
"no-native-reassign": 2, // 不能重寫native對象
"no-negated-in-lhs": 2, // in 操作符的左邊不能有!
"no-nested-ternary": 0, // 禁止使用嵌套的三目運算
"no-new": 1, // 禁止在使用new構(gòu)造一個實例后不賦值
"no-new-func": 1, // 禁止使用new Function
"no-new-object": 2, // 禁止使用new Object()
"no-new-require": 2, // 禁止使用new require
"no-new-wrappers": 2, // 禁止使用new創(chuàng)建包裝實例,new String new Boolean new Number
"no-obj-calls": 2, // 不能調(diào)用內(nèi)置的全局對象,比如Math() JSON()
"no-octal": 2, // 禁止使用八進(jìn)制數(shù)字
"no-octal-escape": 2, // 禁止使用八進(jìn)制轉(zhuǎn)義序列
"no-param-reassign": 2, // 禁止給參數(shù)重新賦值
"no-path-concat": 0, // node中不能使用__dirname或__filename做路徑拼接
"no-plusplus": 0, // 禁止使用++,--
"no-process-env": 0, // 禁止使用process.env
"no-process-exit": 0, // 禁止使用process.exit()
"no-proto": 2, // 禁止使用__proto__屬性
"no-redeclare": 2, // 禁止重復(fù)聲明變量
"no-regex-spaces": 2, // 禁止在正則表達(dá)式字面量中使用多個空格 /foo bar/
"no-restricted-modules": 0, // 如果禁用了指定模塊,使用就會報錯
"no-return-assign": 1, // return 語句中不能有賦值表達(dá)式
"no-script-url": 0, // 禁止使用javascript:void(0)
"no-self-compare": 2, // 不能比較自身
"no-sequences": 0, // 禁止使用逗號運算符
"no-shadow": 2, // 外部作用域中的變量不能與它所包含的作用域中的變量或參數(shù)同名
"no-shadow-restricted-names": 2, // 嚴(yán)格模式中規(guī)定的限制標(biāo)識符不能作為聲明時的變量名使用
"no-spaced-func": 2, // 函數(shù)調(diào)用時 函數(shù)名與()之間不能有空格
"no-sparse-arrays": 2, // 禁止稀疏數(shù)組, [1,,2]
"no-sync": 0, // nodejs 禁止同步方法
"no-ternary": 0, // 禁止使用三目運算符
"no-trailing-spaces": 1, // 一行結(jié)束后面不要有空格
"no-this-before-super": 0, // 在調(diào)用super()之前不能使用this或super
"no-throw-literal": 2, // 禁止拋出字面量錯誤 throw error;
"no-undef": 1, // 不能有未定義的變量
"no-undef-init": 2, // 變量初始化時不能直接給它賦值為undefined
"no-undefined": 2, // 不能使用undefined
"no-unexpected-multiline": 2, // 避免多行表達(dá)式
"no-underscore-dangle": 1, // 標(biāo)識符不能以_開頭或結(jié)尾
"no-unneeded-ternary": 2, // 禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
"no-unreachable": 2, // 不能有無法執(zhí)行的代碼
"no-unused-expressions": 2, // 禁止無用的表達(dá)式
"no-unused-vars": [2, {"vars": "all", "args": "after-used"}], // 不能有聲明后未被使用的變量或參數(shù)
"no-use-before-define": 2, // 未定義前不能使用
"no-useless-call": 2, // 禁止不必要的call和apply
"no-void": 2, // 禁用void操作符
"no-var": 0, // 禁用var,用let和const代替
"no-warning-comments": [1, { "terms": ["todo", "fixme", "xxx"], "location": "start" }], // 不能有警告?zhèn)渥?
"no-with": 2, // 禁用with
"array-bracket-spacing": [2, "never"], // 是否允許非空數(shù)組里面有多余的空格
"arrow-parens": 0, // 箭頭函數(shù)用小括號括起來
"arrow-spacing": 0, // =>的前/后括號
"accessor-pairs": 0, // 在對象中使用getter/setter
"block-scoped-var": 0, // 塊語句中使用var
"brace-style": [1, "1tbs"], // 大括號風(fēng)格
"callback-return": 1, // 避免多次調(diào)用回調(diào)什么的
"camelcase": 2, // 強(qiáng)制駝峰法命名
"comma-dangle": [2, "never"], // 對象字面量項尾不能有逗號
"comma-spacing": 0, // 逗號前后的空格
"comma-style": [2, "last"], // 逗號風(fēng)格,換行時在行首還是行尾
"complexity": [0, 11], // 循環(huán)復(fù)雜度
"computed-property-spacing": [0, "never"], // 是否允許計算后的鍵名什么的
"consistent-return": 0, // return 后面是否允許省略
"consistent-this": [2, "that"], // this別名
"constructor-super": 0, // 非派生類不能調(diào)用super,派生類必須調(diào)用super
"curly": [2, "all"], // 必須使用 if 中的大括號
"default-case": 2, // switch語句最后必須有default
"dot-location": 0, // 對象訪問符的位置,換行的時候在行首還是行尾
"dot-notation": [0, { "allowKeywords": true }], // 避免不必要的方括號
"eol-last": 0, // 文件以單一的換行符結(jié)束
"eqeqeq": 2, // 必須使用全等
"func-names": 0, // 函數(shù)表達(dá)式必須有名字
"func-style": [0, "declaration"], // 函數(shù)風(fēng)格,規(guī)定只能使用函數(shù)聲明/函數(shù)表達(dá)式
"generator-star-spacing": 0, // 生成器函數(shù)*的前后空格
"guard-for-in": 0, // for in循環(huán)要用if語句過濾
"handle-callback-err": 0, // nodejs 處理錯誤
"id-length": 0, // 變量名長度
"indent": [2, 4], // 縮進(jìn)風(fēng)格
"init-declarations": 0, // 聲明時必須賦初值
"key-spacing": [0, { "beforeColon": false, "afterColon": true }], // 對象字面量中冒號的前后空格
"lines-around-comment": 0, // 行前/行后備注
"max-depth": [0, 4], // 嵌套塊深度
"max-len": [0, 80, 4], // 字符串最大長度
"max-nested-callbacks": [0, 2], // 回調(diào)嵌套深度
"max-params": [0, 3], // 函數(shù)最多只能有3個參數(shù)
"max-statements": [0, 10], // 函數(shù)內(nèi)最多有幾個聲明
"new-cap": 2, // 函數(shù)名首行大寫必須使用new方式調(diào)用,首行小寫必須用不帶new方式調(diào)用
"new-parens": 2, // new時必須加小括號
"newline-after-var": 2, // 變量聲明后是否需要空一行
"object-curly-spacing": [0, "never"], // 大括號內(nèi)是否允許不必要的空格
"object-shorthand": 0, // 強(qiáng)制對象字面量縮寫語法
"one-var": 1, // 連續(xù)聲明
"operator-assignment": [0, "always"], // 賦值運算符 += -=什么的
"operator-linebreak": [2, "after"], // 換行時運算符在行尾還是行首
"padded-blocks": 0, // 塊語句內(nèi)行首行尾是否要空行
"prefer-const": 0, // 首選const
"prefer-spread": 0, // 首選展開運算
"prefer-reflect": 0, // 首選Reflect的方法
"quotes": [1, "single"], // 引號類型 `` ''
"quote-props":[2, "always"], // 對象字面量中的屬性名是否強(qiáng)制雙引號
"radix": 2, // parseInt必須指定第二個參數(shù)
"id-match": 0, // 命名檢測
"require-yield": 0, // 生成器函數(shù)必須有yield
"semi": [2, "always"], // 語句強(qiáng)制分號結(jié)尾
"semi-spacing": [0, {"before": false, "after": true}], // 分號前后空格
"sort-vars": 0, // 變量聲明時排序
"space-after-keywords": [0, "always"], // 關(guān)鍵字后面是否要空一格
"space-before-blocks": [0, "always"], // 不以新行開始的塊前面要不要有空格
"space-before-function-paren": [0, "always"], // 函數(shù)定義時括號前面要不要有空格
"space-in-parens": [0, "never"], // 小括號里面要不要有空格
"space-infix-ops": 0, // 中綴操作符周圍要不要有空格
"space-return-throw-case": 2, // return throw case后面要不要加空格
"space-unary-ops": [0, { "words": true, "nonwords": false }], // 一元運算符的前/后要不要加空格
"spaced-comment": 0, // 注釋風(fēng)格要不要有空格什么的
"strict": 2, // 使用嚴(yán)格模式
"use-isnan": 2, // 禁止比較時使用NaN,只能用isNaN()
"valid-jsdoc": 0, // jsdoc規(guī)則
"valid-typeof": 2, // 必須使用合法的typeof的值
"vars-on-top": 2, // var必須放在作用域頂部
"wrap-iife": [2, "inside"], // 立即執(zhí)行函數(shù)表達(dá)式的小括號風(fēng)格
"wrap-regex": 0, // 正則表達(dá)式字面量用小括號包起來
"yoda": [2, "never"]// 禁止尤達(dá)條件
}二、在webpack中使用Eslint
1. 下載依賴包
npm i eslint-webpack-plugin eslint -D
2. 定義 Eslint 配置文件
.eslintrc.js
module.exports = {
// 繼承 Eslint 規(guī)則
extends: ["eslint:recommended"],
env: {
node: true, // 啟用node中全局變量
browser: true, // 啟用瀏覽器中全局變量
},
parserOptions: {
ecmaVersion: 6,
sourceType: "module",
},
rules: {
"no-var": 2, // 不能使用 var 定義變量
},
};如圖,在項目的根目錄下新建.eslintrc.js文件

3. 配置webpack.config.js文件
如圖:

完整webpack.config.js代碼:
// Node.js的核心模塊,專門用來處理文件路徑
const path = require("path");
const ESLintWebpackPlugin = require("eslint-webpack-plugin"); // 引入 ESLint 插件
module.exports = {
// 入口
// 相對路徑和絕對路徑都行
entry: "./src/main.js",
// 輸出
output: {
// path: 文件輸出目錄,必須是絕對路徑
// path.resolve()方法返回一個絕對路徑
// __dirname 當(dāng)前文件的文件夾絕對路徑
path: path.resolve(__dirname, "dist"),
// filename: js文件輸出文件名
filename: "js/main.js",
clean: true, // 自動將上次打包目錄資源清空
},
// 加載器
module: {
rules: [
{
// 用來匹配 .css 結(jié)尾的文件
test: /\.css$/,
// use 數(shù)組里面 Loader 執(zhí)行順序是從右到左
use: ["style-loader", "css-loader"],
},
{
// 用來匹配.less結(jié)尾的文件
test: /\.less$/,
use: ["style-loader", "css-loader", "less-loader"],
},
{
test: /\.s[ac]ss$/,
use: ["style-loader", "css-loader", "sass-loader"],
},
{
// 用來匹配圖片文件
test: /\.(png|jpe?g|gif|webp)$/,
type: "asset",
parser: {
dataUrlCondition: {
maxSize: 10 * 1024, // 小于10kb的圖片會被base64處理
},
},
generator: {
// 將圖片文件輸出到 images 目錄中
// 將圖片文件命名 [hash:8][ext][query]
// [hash:8]: hash值取8位
// [ext]: 使用之前的文件擴(kuò)展名
// [query]: 添加之前的query參數(shù)
filename: "images/[hash:8][ext][query]",
},
},
{
test: /\.(ttf|woff2?|map4|map3|avi)$/,
type: "asset/resource", // 以文件資源的形式輸出
generator: {
filename: "media/[hash:8][ext][query]", // 輸出到media目錄中
},
},
],
},
// 插件
plugins: [
new ESLintWebpackPlugin({
// 指定檢查文件的根目錄
context: path.resolve(__dirname, "src"),
}),
],
// 模式
mode: "development", // 開發(fā)模式
};4. 測試Eslint
在上面的.eslintrc.js文件中,我們配置了一個不能使用var變量聲明的規(guī)則,現(xiàn)在我們?nèi)ジ囊幌聅rc/main.js文件如圖:

5. 執(zhí)行npx webpack打包
如圖:Eslint會在打包的時候按照規(guī)則檢測代碼,不符合規(guī)則的會給出提示

6. vscode 的Eslint插件
打開 VSCode,下載 Eslint 插件,即可不用編譯就能看到錯誤,可以提前解決
但是此時就會對項目所有文件默認(rèn)進(jìn)行 Eslint 檢查了,我們 dist 目錄下的打包后文件就會報錯。但是我們只需要檢查 src 下面的文件,不需要檢查 dist 下面的文件。
所以可以使用 Eslint 忽略文件解決。在項目根目錄新建下面文件:
.eslintignore
# 忽略dist目錄下所有文件 dist
如圖:

到此這篇關(guān)于webpack中使用Eslint的實現(xiàn)的文章就介紹到這了,更多相關(guān)webpack使用Eslint內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
uniapp開發(fā)小程序的開發(fā)規(guī)范總結(jié)
uni-app 是一個使用 vue.js 開發(fā)跨平臺應(yīng)用的前端框架,下面這篇文章主要給大家介紹了關(guān)于uniapp開發(fā)小程序的開發(fā)規(guī)范,文中通過實例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-07-07
微信小程序?qū)崿F(xiàn)圖片選擇并預(yù)覽功能
這篇文章主要為大家詳細(xì)介紹了微信小程序?qū)崿F(xiàn)圖片選擇并預(yù)覽,文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2019-07-07
JavaScript寫的一個DIV 彈出網(wǎng)頁對話框
自己整理得一個JavaScript寫的一個DIV 彈出網(wǎng)頁對話框2009-08-08
JavaScript使用localStorage存儲數(shù)據(jù)
這篇文章主要為大家詳細(xì)介紹了JavaScript使用localStorage存儲數(shù)據(jù),文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2019-09-09
layui數(shù)據(jù)表格重載實現(xiàn)往后臺傳參
今天小編就為大家分享一篇layui數(shù)據(jù)表格重載實現(xiàn)往后臺傳參,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2019-11-11
uni-app動態(tài)修改導(dǎo)航欄標(biāo)題簡單步驟
uniapp作為一款開源軟件,可以做到一端多用,不過也有局限,在開發(fā)中有時候需要動態(tài)的去修改標(biāo)題,下面這篇文章主要給大家介紹了關(guān)于uni-app動態(tài)修改導(dǎo)航欄標(biāo)題的相關(guān)資料,需要的朋友可以參考下2023-06-06

