前言

最近接手了一個專案，由於之前為了快速開發，沒有做程式碼檢查。為了使得程式碼更加規範以及更易讀，所以就要eslint上場了。

安裝依賴

安裝依賴有兩種方法：

1. 在cmd中打上把相應的依賴加到devDependencies下，再npm install對應依賴。
2. 在package.json檔案加上相應依賴：
   

"eslint-plugin-html": "^6.0.3","@vue/cli-plugin-eslint": "^3.3.0","@vue/eslint-config-standard": "^4.0.0","eslint": "5.0.0","eslint-friendly-formatter": "4.0.1","eslint-loader": "2.0.0","eslint-plugin-import": "^2.20.2","eslint-plugin-vue": "4.7.1",

eslint配置方法

eslint的規則有三個選項：

• "off"或者0，不啟用這個規則
• "warn"或者1，出現問題會有警告
• "error"或者2，出現問題會報錯
  

在根目錄建立.eslintrc.js，程式碼如下：

module.exports = {
 // 預設情況下，ESLint會在所有父級元件中尋找配置檔案，一直到根目錄。ESLint一旦發現配置檔案中有  "root": true，它就會停止在父級目錄中尋找。
 root: true,parserOptions: {
  // 對Babel解析器的包裝使其與 ESLint 相容。
  parser: 'babel-eslint',// 程式碼是 ECMAScript 模組
  sourceType: 'module'
 },env: {
   // 預定義的全域性變數，這裡是瀏覽器環境
  browser: true,node: true,es6: true,},// 擴充套件風格
 extends: ['plugin:vue/recommended','eslint:recommended'],// 規則的細節請到ESLint官方網站檢視http://eslint.org/docs/rules/
 rules: {
  "vue/max-attributes-per-line": [2,{
   "singleline": 10,"multiline": {
    "max": 1,"allowFirstLine": false
   }
  }],"vue/name-property-casing": ["error","PascalCase"],// 定義物件的set存取器屬性時，強制定義get
  'accessor-pairs': 2,'arrow-spacing': [2,{
   'before': true,'after': true
  }],// 禁止或強制在單行程式碼塊中使用空格
  'block-spacing': [2,'always'],// 強制使用一致的縮排 第二個引數為 "tab" 時，會使用tab
  'brace-style': [2,'1tbs',{
   'allowSingleLine': true
  }],// 雙峰駝命名格式
  'camelcase': [0,{
   'properties': 'always'
  }],// 陣列和物件鍵值對最後一個逗號， never引數：不能帶末尾的逗號,always引數：必須帶末尾的逗號
  'comma-dangle': [2,'never'],// 控制逗號前後的空格
  'comma-spacing': [2,{
   'before': false,// 控制逗號在行尾出現還是在行首出現 (預設行尾)
  'comma-style': [2,'last'],// 強制在子類建構函式中用super()呼叫父類建構函式，TypeScrip的編譯器也會提示
  'constructor-super': 2,// 強制所有控制語句使用一致的括號風格
  'curly': [2,'multi-line'],// 強制object.key 中 . 的位置，引數:
  // property，'.'號應與屬性在同一行
  // object,'.' 號應與物件名在同一行
  'dot-location': [2,'property'],// 檔案末尾強制換行
  'eol-last': 2,// 使用 === 替代 == allow-null允許null和undefined==
  "eqeqeq": [2,"allow-null"],// 強制 generator 函式中 * 號周圍使用一致的空格
  'generator-star-spacing': [2,// 要求回撥函式中有容錯處理
  'handle-callback-err': [2,'^(err|error)$'],'indent': [2,2,{
   'SwitchCase': 1
  }],// 強制在 JSX 屬性中一致地使用雙引號或單引號
  'jsx-quotes': [2,'prefer-single'],// 強制在物件字面量的屬性中鍵和值之間使用一致的間距
  'key-spacing': [2,{
   'beforeColon': false,'afterColon': true
  }],// 強制在關鍵字前後使用一致的空格
  'keyword-spacing': [2,// 要求建構函式首字母大寫
  'new-cap': [2,{
   'newIsCap': true,'capIsNew': false
  }],// 要求呼叫無參建構函式時有圓括號
  'new-parens': 2,// 禁止在沒有型別檢查操作符的情況下與 null 進行比較
  'no-eq-null': 0,// 禁止使用 Array 建構函式
  'no-array-constructor': 2,// 禁用 arguments.caller 或 arguments.callee
  'no-caller': 2,// 禁用 console
  'no-console': 0,// 禁止修改類宣告的變數
  'no-class-assign': 2,// 禁止條件表示式中出現賦值操作符
  'no-cond-assign': 2,// 禁止修改 const 宣告的變數
  'no-const-assign': 2,// 禁止在正則表示式中使用控制字元 ：new RegExp("\x1f")
  'no-control-regex': 0,// 禁止刪除變數
  'no-delete-var': 2,// 禁止 function 定義中出現重名引數
  'no-dupe-args': 2,// 禁止類成員中出現重複的名稱
  'no-dupe-class-members': 2,// 禁止物件字面量中出現重複的 key
  'no-dupe-keys': 2,// 禁止重複的 case 標籤
  'no-duplicate-case': 2,// 禁止在正則表示式中使用空字符集 (/^abc[]/)
  'no-empty-character-class': 2,// 禁止使用空解構模式no-empty-pattern
  'no-empty-pattern': 2,// 禁用 eval()，由於多處地方使用，暫不開啟
  'no-eval': 0,// 禁止對 catch 子句的引數重新賦值
  'no-ex-assign': 2,// 禁止擴充套件原生型別
  'no-extend-native': 2,// 禁止不必要的 .bind() 呼叫
  'no-extra-bind': 2,// 禁止不必要的布林轉換
  'no-extra-boolean-cast': 2,// 禁止不必要的括號 //(a * b) + c;//報錯
  'no-extra-parens': [2,'functions'],// 禁止 case 語句落空
  'no-fallthrough': 2,// 禁止數字字面量中使用前導和末尾小數點
  'no-floating-decimal': 2,// 禁止對 function 宣告重新賦值
  'no-func-assign': 2,// 禁止使用類似 eval() 的方法
  'no-implied-eval': 2,// 禁止在巢狀的塊中出現 function 或 var 宣告
  'no-inner-declarations': [2,// 禁止 RegExp 建構函式中無效的正則表示式字串
  'no-invalid-regexp': 2,// 禁止在字串和註釋之外不規則的空白
  'no-irregular-whitespace': 2,// 禁用 __iterator__ 屬性
  'no-iterator': 2,// 不允許標籤與變數同名
  'no-label-var': 2,// 禁用標籤語句
  'no-labels': [2,{
   'allowLoop': false,'allowSwitch': false
  }],// 禁用不必要的巢狀塊
  'no-lone-blocks': 2,// 不允許空格和 tab 混合縮排
  'no-mixed-spaces-and-tabs': 2,// 禁止使用多個空格
  'no-multi-spaces': 2,// 禁止使用多行字串，在 JavaScript 中，可以在新行之前使用斜線建立多行字串
  'no-multi-str': 2,// 不允許多個空行
  'no-multiple-empty-lines': [2,{
   'max': 1
  }],// 禁止對原生物件賦值
  'no-native-reassign': 2,// 禁止在 in 表示式中出現否定的左運算元
  'no-negated-in-lhs': 2,// 禁止使用 Object 的建構函式
  'no-new-object': 2,// 禁止呼叫 require 時使用 new 操作符
  'no-new-require': 2,// 禁止 Symbol 的建構函式
  'no-new-symbol': 2,// 禁止對 String，Number 和 Boolean 使用 new 操作符
  'no-new-wrappers': 2,// 禁止把全域性物件 (Math 和 JSON) 作為函式呼叫 錯誤：var math = Math();
  'no-obj-calls': 2,// 禁用八進位制字面量
  'no-octal': 2,// 禁止在字串中使用八進位制轉義序列
  'no-octal-escape': 2,// 禁止對 __dirname 和 __filename進行字串連線
  'no-path-concat': 2,// 禁用 __proto__ 屬性
  'no-proto': 2,// 禁止使用 var 多次宣告同一變數
  'no-redeclare': 2,// 禁止正則表示式字面量中出現多個空格
  'no-regex-spaces': 2,// 禁用指定的通過 require 載入的模組
  'no-return-assign': [2,'except-parens'],// 禁止自我賦值
  'no-self-assign': 2,// 禁止自身比較
  'no-self-compare': 2,// 禁用逗號操作符
  'no-sequences': 2,// 禁止覆蓋受限制的識別符號
  'no-shadow-restricted-names': 2,// 禁止 function 識別符號和括號之間出現空格
  'no-spaced-func': 2,// 禁用稀疏陣列
  'no-sparse-arrays': 2,// 禁止在建構函式中，在呼叫 super() 之前使用 this 或 super
  'no-this-before-super': 2,// 禁止丟擲非異常字面量
  'no-throw-literal': 0,// 禁用行尾空格
  'no-trailing-spaces': 2,// 禁用未宣告的變數，除非它們在 /*global */ 註釋中被提到
  'no-undef': 2,// 禁止將變數初始化為 undefined
  'no-undef-init': 2,// 禁止出現令人困惑的多行表示式
  'no-unexpected-multiline': 2,// 禁用一成不變的迴圈條件
  'no-unmodified-loop-condition': 2,// 禁止可以在有更簡單的可替代的表示式時使用三元操作符
  'no-unneeded-ternary': [2,{
   'defaultAssignment': false
  }],// 禁止在return、throw、continue 和 break語句之後出現不可達程式碼
  'no-unreachable': 2,'no-unsafe-finally': 2,// 禁止出現未使用過的變數
  'no-unused-vars': [2,{
   'vars': 'all','args': 'none'
  }],// 禁止不必要的 .call() 和 .apply()
  'no-useless-call': 2,// 禁止不必要的計算效能鍵物件的文字
  'no-useless-computed-key': 2,'no-useless-constructor': 2,// 禁用不必要的轉義字元
  'no-useless-escape': 0,// 禁止屬性前有空白
  'no-whitespace-before-property': 2,// 禁用 with 語句
  'no-with': 2,// 強制函式中的變數要麼一起宣告要麼分開宣告
  'one-var': [2,{
   'initialized': 'never'
  }],// 強制操作符使用一致的換行符
  'operator-linebreak': [2,'after',{
   'overrides': {
    '?': 'before',':': 'before'
   }
  }],// 要求或禁止塊內填充
  'padded-blocks': [2,// 強制使用一致的反勾號、雙引號或單引號
  'quotes': [2,'single',{
   'avoidEscape': true,'allowTemplateLiterals': true
  }],// 要求或禁止使用分號而不是 ASI（這個才是控制行尾部分號的，）
  'semi': [2,// 強制分號之前和之後使用一致的空格
  'semi-spacing': [2,// 強制在塊之前使用一致的空格
  'space-before-blocks': [2,// 強制在 function的左括號之前使用一致的空格
  'space-before-function-paren': [2,// 強制在圓括號內使用一致的空格
  'space-in-parens': [2,// 要求操作符周圍有空格
  'space-infix-ops': 2,// 強制在一元操作符前後使用一致的空格
  'space-unary-ops': [2,{
   'words': true,'nonwords': false
  }],// 強制在註釋中 // 或 /* 使用一致的空格
  'spaced-comment': [2,'always',{
   'markers': ['global','globals','eslint','eslint-disable','*package','!',',']
  }],// 要求或禁止模板字串中的嵌入表示式周圍空格的使用
  'template-curly-spacing': [2,// 要求使用 isNaN() 檢查 NaN
  'use-isnan': 2,// typeof foo === "undefimed" 錯誤
  'valid-typeof': 2,// 要求 IIFE 使用括號括起來
  'wrap-iife': [2,'any'],// 強制在 yield* 表示式中 * 周圍使用空格
  'yield-star-spacing': [2,'both'],// 要求或禁止 “Yoda” 條件
  'yoda': [2,// 要求使用 const 宣告那些聲明後不再被修改的變數
  'prefer-const': 2,// 是否允許debugger
  'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,// 強制在花括號中使用一致的空格
  'object-curly-spacing': [2,{
   objectsInObjects: false
  }],// 指定陣列的元素之間要以空格隔開(,後面)， never引數：[ 之前和 ] 之後不能帶空格，always引數：[ 之前和 ] 之後必須帶空格
  'array-bracket-spacing': [2,'never']
 }
}

忽略不必要的檔案檢測

在根目錄下新建檔案.eslintignore，對應的檔案忽略檢測。

src/assets

關閉某些程式碼的檢測

有時候程式碼裡有些特殊情況需要我們在某一行或者某幾行關閉ESLint檢測，可以使用註釋。

下面的程式碼會關閉所有規則：

/* eslint-disable */
alert('str');
/* eslint-enable */

下面的程式碼會關閉某一行的所有規則：

alert('str'); // eslint-disable-line

// eslint-disable-next-line
alert('str');

下面的程式碼在某一行關閉指定的規則：

alert('str'); // eslint-disable-line no-alert

// eslint-disable-next-line no-alert
alert('str');

開啟驗證

在根目錄的vue.config.js中，把lintOnSave設定為true。

vs code安裝外掛與設定

在vscode上安裝eslint和vetur外掛，並在file>>prefrence>>setting 或檔案>>首選項>>設定中，找到setting.json，新增如下配置，讓vscode每次保持的時候安裝eslint規範來自動格式化：

// 重新設定tabsize
"editor.tabSize": 2,// 每次儲存的時候將程式碼按eslint格式進行修復
"eslint.autoFixOnSave": true,// 新增 vue 支援
"eslint.validate": [
{
 "language": "vue","autoFix": true
},{
 "language": "html",{
 "language": "javascript","autoFix": true
}
],// 每次儲存的時候自動格式化（建議關掉，用eslint來修復）
"editor.formatOnSave": false

結語

本文章只是記錄eslint的過程，如果大家有什麼問題可以在下方反饋給我，謝謝！

到此這篇關於vue-cli3專案配置eslint程式碼規範的文章就介紹到這了,更多相關vue-cli3專案配置eslint程式碼規範內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！