1. 程式人生 > 其它 >專案啟用eslint 檢測工具

專案啟用eslint 檢測工具

在日常開發中,一個大點的專案會有多人蔘與,那麼可能就會出現大家的程式碼風格不一,各顯神通,這個時候就要祭出我們的eslint

在這之前磨刀不誤砍柴工,我們先來配置一下我們的程式碼編輯工具,如何在vscode下儲存程式碼時讓程式碼自動以eslint標準來儲存呢。

首先下載vscode就不用說了吧,那麼在開啟編輯器後我們在擴充套件商店先下載一個eslint外掛

ok,下載完了讓我們開啟vscode的設定項,方式:左下角圖示——>>設定

然後在這個json檔案中放入下面程式碼配置就完成了

// https://eslint.org/docs/user-guide/configuring

module.exports = {

//此項是用來告訴eslint找當前配置檔案不能往父級查詢
root: true,

//此項是用來指定eslint解析器的,解析器必須符合規則,babel-eslint解析器是對babel解析器的包裝使其與ESLint解析
parser: 'babel-eslint',

//此項是用來指定javaScript語言型別和風格,sourceType用來指定js匯入的方式,預設是script,此處設定為module,指某塊匯入方式
parserOptions: {
// 設定 script(預設) 或 module,如果程式碼是在ECMASCRIPT中的模組
sourceType: 'module',
"ecmaVersion": 6,
"ecmaFeatures": {
"jsx": true
}
},

// 此項指定環境的全域性變數,下面的配置指定為瀏覽器環境
env: {
"browser": true,
"node": true,
"commonjs": true,
"es6": true,
"amd": true
},
// https://github.com/standard/standard/blob/master/docs/RULES-en.md
// 此項是用來配置標準的js風格,就是說寫程式碼的時候要規範的寫,如果你使用vs-code我覺得應該可以避免出錯
extends: 'vue',
// 此項是用來提供外掛的,外掛名稱省略了eslint-plugin-,下面這個配置是用來規範html的
plugins: [
'html',
"flow-vars",
"react"
],
/*
下面這些rules是用來設定從外掛來的規範程式碼的規則,使用必須去掉字首eslint-plugin-
主要有如下的設定規則,可以設定字串也可以設定數字,兩者效果一致
"off" -> 0 關閉規則
"warn" -> 1 開啟警告規則
"error" -> 2 開啟錯誤規則
*/
rules: {
// 不需要
"space-before-function-paren": 0, // 函式定義時括號前面要不要有空格
"eol-last": 0, // 檔案以單一的換行符結束
"no-extra-semi": 0, // 可以多餘的冒號
"semi": 0, // 語句可以不需要分號結尾
"eqeqeq": 0, // 必須使用全等
"one-var": 0, // 連續宣告
"no-undef": 1, // 可以 有未定義的變數

// 警告
"no-extra-boolean-cast": 1, // 不必要的bool轉換
"no-extra-parens": 1, // 非必要的括號
"no-empty": 1, // 塊語句中的內容不能為空
"no-use-before-define": [1, "nofunc"], // 未定義前不能使用
"complexity": [1, 10], // 迴圈複雜度
"no-unused-vars": 1, // 不能有聲明後未被使用的變數或引數
// vue
"flow-vars/define-flow-type": 1,
"flow-vars/use-flow-type": 1,

// react
"react/jsx-uses-react": 2,
"react/jsx-uses-vars": 2,

// 錯誤
"comma-dangle": [2, "never"], // 物件字面量項尾不能有逗號
"no-debugger": 2, // 禁止使用debugger
"no-constant-condition": 2, // 禁止在條件中使用常量表達式 if(true) if(1)
"no-dupe-args": 2, // 函式引數不能重複
"no-dupe-keys": 2, // 在建立物件字面量時不允許鍵重複 {a:1,a:1}
"no-duplicate-case": 2, // switch中的case標籤不能重複
"no-empty-character-class": 2, // 正則表示式中的[]內容不能為空
"no-invalid-regexp": 2, // 禁止無效的正則表示式
"no-func-assign": 2, // 禁止重複的函式宣告
"valid-typeof": 2, // 必須使用合法的typeof的值
"no-unreachable": 2, // 不能有無法執行的程式碼
"no-unexpected-multiline": 2, // 避免多行表示式
"no-sparse-arrays": 2, // 禁止稀疏陣列, [1,,2]
"no-shadow-restricted-names": 2, // 嚴格模式中規定的限制識別符號不能作為宣告時的變數名使用
"no-cond-assign": 2, // 禁止在條件表示式中使用賦值語句
"no-native-reassign": 2, // 不能重寫native物件

// 程式碼風格
"no-else-return": 1, // 如果if語句裡面有return,後面不能跟else語句
"no-multi-spaces": 1, // 不能用多餘的空格
"key-spacing": [1, { // 物件字面量中冒號的前後空格
"beforeColon": false,
"afterColon": true
}],
"block-scoped-var": 2, // 塊語句中使用var
"consistent-return": 2, // return 後面是否允許省略
"accessor-pairs": 2, // 在物件中使用getter/setter
"dot-location": [2, "property"], // 物件訪問符的位置,換行的時候在行首還是行尾
"no-lone-blocks": 2, // 禁止不必要的巢狀塊
"no-labels": 2, // 禁止標籤宣告
"no-extend-native": 2, // 禁止擴充套件native物件
"no-floating-decimal": 2, // 禁止省略浮點數中的0 .5 3.
"no-loop-func": 2, // 禁止在迴圈中使用函式(如果沒有引用外部變數不形成閉包就可以)
"no-new-func": 2, // 禁止使用new Function
"no-self-compare": 2, // 不能比較自身
"no-sequences": 2, // 禁止使用逗號運算子
"no-throw-literal": 2, // 禁止丟擲字面量錯誤 throw "error";
"no-return-assign": [2, "always"], // return 語句中不能有賦值表示式
"no-redeclare": [2, { // 禁止重複宣告變數
"builtinGlobals": true
}],
"no-unused-expressions": [2, { // 禁止無用的表示式
"allowShortCircuit": true,
"allowTernary": true
}],
"no-useless-call": 2, // 禁止不必要的call和apply
"no-useless-concat": 2,
"no-void": 2, // 禁用void操作符
"no-with": 2, // 禁用with
"space-infix-ops": 2, // 中綴操作符周圍要不要有空格
"valid-jsdoc": [2, { // jsdoc規則
"requireParamDescription": true,
"requireReturnDescription": true
}],
"no-warning-comments": [2, { // 不能有警告備註
"terms": ["todo", "fixme", "any other term"],
"location": "anywhere"
}],
"curly": 1, // 必須使用 if(){} 中的{}

// common js
"no-duplicate-imports": 1
}
}