編程風格這個東西,說實在的對於剛加入團隊的新成員來講仍是很難讓人徹底適應的。由於每人的編程風格都不一樣,徹底是各有千秋的既視感啊javascript
到了新公司後團隊中的每一個人也都有各自一套的編程習慣,擼起代碼來是擋也擋不住啊,什麼都別問,老夫就是幹,哈哈,每一個coder的代碼風格都截然不同前端
不過話說回來,在團隊開發中,全部的代碼看起來風格一致是極其重要的,因此咱們也須要一些代碼檢查工具,從JSLint,JSHint到今天的主角ESLint,都是很是好用的檢查工具java
那麼閒言少敘,直接進入主題,投入ESLint的懷抱吧!!!node
放眼望去,在前端,但凡是有個項目,不管大小,都會看到它的身影。並不是爲了提升比格,讓別人暗贊專業,而是它確確實實幫咱們檢測出不易察覺的錯誤,避免N多個線上bugjquery
也經過其規則,讓整個團隊有了整齊劃一的代碼輸出風格,也有業界的最佳實踐寫法,深刻其中,受益不淺.....好處優勢很少說,用過都說好webpack
既然都說好了,那還廢話那麼多,小二趕忙上菜啊es6
如今前端項目開發中,都用到了webpack此等屌屌的構建工具(若是有對webpack不熟悉使用的可移步這裏),那麼就結合着一塊兒來看下如何使用到項目裏吧web
// 安裝eslint
// 安裝eslint-loader 在webpack中解析
// 安裝babel-eslint 對Babel解析器的包裝與ESLint兼容
// -D 安裝在開發依賴環境 devDependencies 原--save-dev的簡寫
npm i eslint eslint-loader babel-eslint -D
複製代碼
友情提示:ESLint是基於Node的(固然webpack也是),因此在使用以前,請確保Node已經安裝正則表達式
// .eslintrc.js module.exports = { // 指定解析器 'parse': '', // 指定解析器選項 'parserOptions': {}, // 指定腳本的運行環境 'env': {}, // 別人能夠直接使用你配置好的ESLint 'root': true, // 腳本在執行期間訪問的額外的全局變量 'globals': {}, // 啓用的規則及其各自的錯誤級別 'rules': {} }; 複製代碼
// webpack.config.js module.exports = { entry: '', output: {}, module: { rules: [ { test: /\.js$/, use: ['babel-loader', 'eslint-loader'] } ] }, plugins: [], devServer: {} }; 複製代碼
按照上面的三步曲寫完後,應該給本身撒花的,哈哈express
然並卵啊,高興的太早了
正所謂人在江湖飄啊,哪有不挨刀的道理。誰敢說寫的代碼放到ESLint裏徹底不報錯,報錯純屬正常,不必慌張
如今針對一些比較常見的規範來簡單梳理一下,這麼多規則,其實看的我也吃了一鯨
如今來看看編譯過程當中報錯的規則吧
非友情提示:每一個規則對應的0,1,2分別表示off, warning, error三個錯誤級別
// 錯誤寫法 function fn (key) { if (key === 'a') return 1; } fn('a'); // 正確寫法 function fn (key) { if (key === 'a') { return 1; } if (key === 'b') return 2; } fn('a'); 複製代碼
// 錯誤寫法 function fn (key) { let str = ''; switch (key) { case 'a': str = 'a'; break; case 'b': str = 'b'; break; } return str; } // 正確寫法 function fn (key) { let str = ''; switch(key) { case 'a': str = 'a'; break; case 'b': str = 'b'; break; default: str = 'c'; break; } return str; } 複製代碼
// 正確寫法 if () { if () { if () { if () { if () { } } } } } 複製代碼
好了還有一些就須要你們在使用中來去體會了,下面我將我司工做當中用到的ESLint規則貼出來,方便你們去作代碼檢查了
// .eslintrc.js module.exports = { // 解析ES6 'parser': 'babel-eslint', 'parserOptions': { // 啓用ES8語法支持 'ecmaVersion': 2017, // module表示ECMAScript模塊 'sourceType': 'module', // 使用額外的語言特性 'ecmaFeatures': { 'experimentalObjectRestSpread': true, 'jsx': true, 'modules': true, } }, // 這些環境並非互斥的,因此你能夠同時定義多個 'env': { 'browser': true, 'jquery': true, 'node': true, 'commonjs': true, 'es6': true, }, 'root': true, // 當訪問當前源文件內未定義的變量時,no-undef 規則將發出警告 // 因此須要定義這些額外的全局變量 'globals': { 'OnlySVG': true, 'monitor': true, 'CanvasRender': true, 'Vue': true, 'VueRouter': true }, 'rules': { // 設置了 setter ,必須相應設置 getter ,反之沒必要須 'accessor-pairs': 2, // 數組方括號先後的換行符使用規則 // @off 不關心 'array-bracket-newline': 0, // 數組方括號先後的空格使用規則 // @off 不關心 'array-bracket-spacing': 0, // 數組的 map、filter、sort 等方法,回調函數必須有返回值 'array-callback-return': 2, // 每一個數組項是否獨佔一行 // @off 不關心 'array-element-newline': 0, // 箭頭函數的書寫規則 // @off 不限制 'arrow-body-style': 0, // 箭頭函數的圓括號使用規則 // @off 不限制 'arrow-parens': 0, // 箭頭函數的空格使用規則 // @off 不限制 'arrow-spacing': 0, // 不能在塊外使用塊做用域內 var 定義的變量 'block-scoped-var': 2, // 代碼塊花括號先後的空格規則 // @off 不關心 'block-spacing': 0, // if else 的花括號換行規則 // @off 不關心 'brace-style': 0, // callback 以後必須當即 return // @off 不必 'callback-return': 0, // 變量名必須使用駝峯式 // @off 暫不限制 'camelcase': 0, // 註釋的首字母應該大寫 // @off 不必 'capitalized-comments': 0, // class 的非靜態方法必須包含 this 關鍵字 'class-methods-use-this': 2, // 對象的最後一項後面是否寫逗號 // @off 此項目不關心 // @fixable 對於 PC 項目考慮兼容性時須要設置 'comma-dangle': 0, // 逗號先後是否有空格 // @off 不關心 'comma-spacing': 0, // 逗號寫在行首仍是行尾 // @off 不關心 'comma-style': 0, // 禁止函數 if ... else if ... else 的複雜度超過 20 'complexity': 2, // 使用方括號訪問對象屬性時,方括號先後的空格規則 // @off 不關心 'computed-property-spacing': 0, // 禁止函數在不一樣條件下返回不一樣類型的值 // @off 有時候會但願經過參數獲取不一樣類型的返回值 'consistent-return': 0, // this 的別名規則,只容許 self 或 that 'consistent-this': [2, 'self', 'that'], // 構造函數中必須調用 super // @off 不必 'constructor-super': 0, // if 後必須包含 { ,單行 if 除外 'curly': [2, 'multi-line', 'consistent'], // switch 語句必須包含 default 'default-case': 2, // 鏈式操做時,點的位置,是在上一行結尾仍是下一行開頭 // @off 不關心 'dot-location': 0, // 文件最後必須有空行 // @off 不限制 'eol-last': 0, // 必須使用 === 和 !== ,和 null 對比時除外 'eqeqeq': [2, 'always', { 'null': 'ignore' }], // for 循環不得因方向錯誤形成死循環 'for-direction': 2, // 執行函數的圓括號先後的空格規則 // @off 不關心 'func-call-spacing': 0, // 把函數賦給變量或對象屬性時,函數名和變量名或對象屬性名必須一致 // @off 不限制 'func-name-matching': 0, // 不容許匿名函數 // @off 不限制 'func-names': 0, // 必須只使用函數申明或只使用函數表達式 // @off 不限制 'func-style': 0, // generator 的 * 先後空格使用規則 // @off 不限制 'generator-star-spacing': 0, // getter 必須有返回值,容許返回 undefined 'getter-return': [2, { allowImplicit: true }], // require 必須在全局做用域下 // @off 條件加載很常見 'global-require': 0, // for in 時需檢測 hasOwnProperty 'guard-for-in': 2, // callback 中的 err、error 參數和變量必須被處理 'handle-callback-err': 2, // id 黑名單 // @off 暫時沒有 'id-blacklist': 0, // 變量名長度限制 // @off 長度不是重點,清晰易讀纔是關鍵 'id-length': 0, // 限制變量名必須匹配指定的正則表達式 // @off 不必限制變量名 'id-match': 0, // 縮進使用 tab 仍是空格 // @off 不關心 'indent': 0, // 變量必須在定義的時候賦值 // @off 先定義後賦值很常見 'init-declarations': 0, // jsx 語法中,屬性的值必須使用雙引號 'jsx-quotes': [2, 'prefer-double'], // 對象字面量冒號先後的空格使用規則 // @off 不關心 'key-spacing': 0, // 關鍵字先後必須有空格 'keyword-spacing': 2, // 換行符使用規則 // @off 不關心 'linebreak-style': 0, // 單行註釋必須寫在前一行仍是行尾 // @off 不限制 'line-comment-position': 0, // 註釋先後是否要空一行 // @off 不限制 'lines-around-comment': 0, // 最大塊嵌套深度爲 5 層 'max-depth': [2, 5], // 限制單行代碼的長度 // @off 不限制 'max-len': 0, // 限制單個文件最大行數 // @off 不限制 'max-lines': 0, // 最大回調深度爲 3 層 'max-nested-callbacks': [2, 3], // 函數的形參不能多於8個 'max-params': [2, 8], // 限制一行中的語句數量 // @off 不必限制 'max-statements-per-line': 0, // 限制函數塊中的語句數量 // @off 不必限制 'max-statements': 0, // 三元表達式的換行規則 // @off 不限制 'multiline-ternary': 0, // new關鍵字後類名應首字母大寫 'new-cap': [2, { 'capIsNew': false, // 容許大寫開頭的函數直接執行 }], // new 關鍵字後類應包含圓括號 'new-parens': 2, // 鏈式調用是否要換行 // @off 不限制 'newline-per-chained-call': 0, // 禁止 alert,提醒開發者,上線時要去掉 'no-alert': 1, // 禁止使用 Array 構造函數,使用 Array(num) 直接建立長度爲 num 的數組時能夠 'no-array-constructor': 2, // 禁止將 await 寫在循環裏 'no-await-in-loop': 2, // 禁止位運算 // @off 不限制 'no-bitwise': 0, // 禁止在 Node.js 中直接調用 Buffer 構造函數 'no-buffer-constructor': 2, // 禁止使用 arguments.caller 和 arguments.callee 'no-caller': 2, // switch的條件中出現 var、let、const、function、class 等關鍵字,必須使用花括號把內容括起來 'no-case-declarations': 2, // catch中不得使用已定義的變量名 'no-catch-shadow': 2, // class定義的類名不得與其它變量重名 'no-class-assign': 2, // 禁止與 -0 作比較 'no-compare-neg-zero': 2, // 禁止在 if、for、while 中出現賦值語句,除非用圓括號括起來 'no-cond-assign': [2, 'except-parens'], // 禁止出現難以理解的箭頭函數,除非用圓括號括起來 'no-confusing-arrow': [2, { 'allowParens': true }], // 禁止使用 console,提醒開發者,上線時要去掉 'no-console': 1, // 禁止使用常量做爲判斷條件 'no-constant-condition': [2, { 'checkLoops': false }], // 禁止對 const 定義從新賦值 'no-const-assign': 2, // 禁止 continue // @off 很經常使用 'no-continue': 0, // 禁止正則表達式中出現 Ctrl 鍵的 ASCII 表示,即/\x1f/ 'no-control-regex': 2, // 禁止 debugger 語句,提醒開發者,上線時要去掉 'no-debugger': 1, // 禁止對變量使用 delete 關鍵字,刪除對象的屬性不受限制 'no-delete-var': 2, // 禁止在正則表達式中出現形似除法操做符的開頭,如 let a = /=foo/ // @off 有代碼高亮的話,在閱讀這種代碼時,也徹底不會產生歧義或理解上的困難 'no-div-regex': 0, // 函數參數禁止重名 'no-dupe-args': 2, // 禁止對象出現重名鍵值 'no-dupe-keys': 2, // 類方法禁止重名 'no-dupe-class-members': 2, // 禁止 switch 中出現相同的 case 'no-duplicate-case': 2, // 禁止重複 import 'no-duplicate-imports': 2, // 禁止出現 if (cond) { return a } else { return b },應該寫爲 if (cond) { return a } return b // @off 有時前一種寫法更清晰易懂 'no-else-return': 0, // 正則表達式中禁止出現空的字符集[] 'no-empty-character-class': 2, // 禁止空的 function // 包含註釋的狀況下容許 'no-empty-function': 2, // 禁止解構中出現空 {} 或 [] 'no-empty-pattern': 2, // 禁止出現空代碼塊 'no-empty': [2, { 'allowEmptyCatch': true }], // 禁止 == 和 != 與 null 作比較,必須用 === 或 !== // @off 非嚴格相等能夠同時判斷 null 和 undefined 'no-eq-null': 0, // 禁止使用 eval 'no-eval': 2, // catch 定義的參數禁止賦值 'no-ex-assign': 2, // 禁止擴展原生對象 'no-extend-native': [2, { 'exceptions': ['Array', 'Object'] }], // 禁止額外的 bind 'no-extra-bind': 2, // 禁止額外的布爾值轉換 'no-extra-boolean-cast': 2, // 禁止額外的 label 'no-extra-label': 2, // 禁止額外的括號,僅針對函數體 'no-extra-parens': [2, 'functions'], // 禁止額外的分號 'no-extra-semi': 2, // 每個 switch 的 case 都須要有 break, return 或 throw // 包含註釋的狀況下容許 'no-fallthrough': [2, { 'commentPattern': '.' }], // 不容許使用 2. 或 .5 來表示數字,須要用 二、2.0、0.5 的格式 'no-floating-decimal': 2, // 禁止對函數聲明從新賦值 'no-func-assign': 2, // 禁止對全局變量賦值 'no-global-assign': 2, // 禁止使用隱式類型轉換 'no-implicit-coercion': [2, { 'allow': ['+', '!!'] // 容許 + 轉數值 '' + 轉字符串和 !! 轉布爾值 }], // 禁止在 setTimeout 和 setInterval 中傳入字符串,因會觸發隱式 eval 'no-implied-eval': 2, // 禁止隱式定義全局變量 'no-implicit-globals': 2, // 禁止行內註釋 // @off 很經常使用 'no-inline-comments': 0, // 禁止在塊做用域內使用 var 或函數聲明 'no-inner-declarations': [2, 'both'], // 禁止使用非法的正則表達式 'no-invalid-regexp': 2, // 禁止在類以外的地方使用 this // @off this 的使用很靈活,事件回調中能夠表示當前元素,函數也能夠先用 this,等之後被調用的時候再 call 'no-invalid-this': 0, // 禁止使用不規範空格 'no-irregular-whitespace': [2, { 'skipStrings': true, // 容許在字符串中使用 'skipComments': true, // 容許在註釋中使用 'skipRegExps': true, // 容許在正則表達式中使用 'skipTemplates': true, // 容許在模板字符串中使用 }], // 禁止使用 __iterator__ 'no-iterator': 2, // label 不得與已定義的變量重名 'no-label-var': 2, // 禁止使用 label // @off 禁止了將很難 break 多重循環和多重 switch 'no-labels': 0, // 禁止使用無效的塊做用域 'no-lone-blocks': 2, // 禁止 else 中只有一個單獨的 if // @off 單獨的 if 能夠把邏輯表達的更清楚 'no-lonely-if': 0, // 禁止 for (var i) { function() { use i } },使用 let 則能夠 'no-loop-func': 2, // 禁止魔法數字 'no-magic-numbers': 0, // 禁止使用混合的邏輯判斷,必須把不一樣的邏輯用圓括號括起來 'no-mixed-operators': [2, { "groups": [ ["&&", "||"] ] }], // 相同類型的 require 必須放在一塊兒 // @off 不限制 'no-mixed-requires': 0, // 禁止混用空格和 tab 來作縮進,必須統一 'no-mixed-spaces-and-tabs': 2, // 禁止連等賦值 'no-multi-assign': 2, // 禁止使用連續的空格 'no-multi-spaces': 2, // 禁止使用 \ 來定義多行字符串,統一使用模板字符串來作 'no-multi-str': 2, // 連續空行的數量限制 'no-multiple-empty-lines': [2, { max: 3, // 文件內最多連續 3 個 maxEOF: 1, // 文件末尾最多連續 1 個 maxBOF: 1 // 文件頭最多連續 1 個 }], // 禁止 if 中出現否認表達式 !== // @off 否認的表達式能夠把邏輯表達的更清楚 'no-negated-condition': 0, // 禁止嵌套的三元表達式 // @off 沒有必要限制 'no-nested-ternary': 0, // 禁止 new Function // @off 有時會用它來解析非標準格式的 JSON 數據 'no-new-func': 0, // 禁止使用 new Object 'no-new-object': 2, // 禁止使用 new require 'no-new-require': 2, // 禁止使用 new Symbol 'no-new-symbol': 2, // 禁止 new Boolean、Number 或 String 'no-new-wrappers': 2, // 禁止 new 一個類而不存儲該實例 'no-new': 2, // 禁止把原生對象 Math、JSON、Reflect 當函數使用 'no-obj-calls': 2, // 禁止使用八進制轉義符 'no-octal-escape': 2, // 禁止使用0開頭的數字表示八進制 'no-octal': 2, // 禁止使用 __dirname + 'file' 的形式拼接路徑,應該使用 path.join 或 path.resolve 來代替 'no-path-concat': 2, // 禁止對函數的參數從新賦值 'no-param-reassign': 2, // 禁止 ++ 和 -- // @off 很經常使用 'no-plusplus': 0, // 禁止使用 process.env.NODE_ENV // @off 使用很常見 'no-process-env': 0, // 禁止使用 process.exit(0) // @off 使用很常見 'no-process-exit': 0, // 禁止使用 hasOwnProperty, isPrototypeOf 或 propertyIsEnumerable // @off 與 guard-for-in 規則衝突,且沒有必要 'no-prototype-builtins': 0, // 禁止使用 __proto__ 'no-proto': 2, // 禁止重複聲明 'no-redeclare': 2, // 禁止在正則表達式中出現連續空格 'no-regex-spaces': 2, // 禁止特定的全局變量 // @off 暫時沒有 'no-restricted-globals': 0, // 禁止 import 特定的模塊 // @off 暫時沒有 'no-restricted-imports': 0, // 禁止使用特定的模塊 // @off 暫時沒有 'no-restricted-modules': 'off', // 禁止特定的對象屬性 // @off 暫時沒有 'no-restricted-properties': 0, // 禁止使用特定的語法 // @off 暫時沒有 'no-restricted-syntax': 0, // 禁止在return中賦值 'no-return-assign': 2, // 禁止在 return 中使用 await 'no-return-await': 2, // 禁止 location.href = 'javascript:void' 'no-script-url': 2, // 禁止將本身賦值給本身 'no-self-assign': 2, // 禁止本身與本身做比較 'no-self-compare': 2, // 禁止逗號操做符 'no-sequences': 2, // 禁止使用保留字做爲變量名 'no-shadow-restricted-names': 2, // 禁止在嵌套做用域中出現重名的定義,如 let a; function b() { let a } 'no-shadow': 2, // 禁止數組中出現連續逗號 'no-sparse-arrays': 2, // 禁止使用 node 中的同步的方法,好比 fs.readFileSync // @off 使用很常見 'no-sync': 0, // 禁止使用 tabs // @off 不限制 'no-tabs': 0, // 禁止普通字符串中出現模板字符串語法 'no-template-curly-in-string': 2, // 禁止三元表達式 // @off 很經常使用 'no-ternary': 0, // 禁止在構造函數的 super 以前使用 this 'no-this-before-super': 2, // 禁止 throw 字面量,必須 throw 一個 Error 對象 'no-throw-literal': 2, // 禁止行尾空格 'no-trailing-spaces': [2, { "skipBlankLines": true, // 不檢查空行 "ignoreComments": true // 不檢查註釋 }], // 禁止將 undefined 賦值給變量 'no-undef-init': 2, // 禁止訪問未定義的變量或方法 'no-undef': 2, // 禁止使用 undefined,如需判斷一個變量是否爲 undefined,請使用 typeof a === 'undefined' 'no-undefined': 2, // 禁止變量名中使用下劃線 // @off 暫不限制 'no-underscore-dangle': 0, // 禁止出現難以理解的多行代碼 'no-unexpected-multiline': 2, // 循環體內必須對循環條件進行修改 'no-unmodified-loop-condition': 2, // 禁止沒必要要的三元表達式 'no-unneeded-ternary': [2, { 'defaultAssignment': false }], // 禁止出現不可到達的代碼,如在 return、throw 以後的代碼 'no-unreachable': 2, // 禁止在finally塊中出現 return、throw、break、continue 'no-unsafe-finally': 2, // 禁止出現不安全的否認,如 for (!key in obj} {},應該寫爲 for (!(key in obj)} {} 'no-unsafe-negation': 2, // 禁止出現無用的表達式 'no-unused-expressions': [2, { 'allowShortCircuit': true, // 容許使用 a() || b 或 a && b() 'allowTernary': true, // 容許在表達式中使用三元運算符 'allowTaggedTemplates': true, // 容許標記模板字符串 } ], // 禁止定義不使用的 label 'no-unused-labels': 2, // 禁止定義不使用的變量 'no-unused-vars': [2, { 'vars': 'all', // 變量定義必須被使用 'args': 'none', // 對於函數形參不檢測 'ignoreRestSiblings': true, // 忽略剩餘子項 fn(...args),{a, b, ...coords} 'caughtErrors': 'none', // 忽略 catch 語句的參數使用 } ], // 禁止在變量被定義以前使用它 'no-use-before-define': [2, { 'functions': false, // 容許函數在定義以前被調用 'classes': false, // 容許類在定義以前被引用 } ], // 禁止沒必要要的 call 和 apply 'no-useless-call': 2, // 禁止使用沒必要要計算的key,如 var a = { ['0']: 0 } 'no-useless-computed-key': 2, // 禁止沒必要要的字符串拼接 'no-useless-concat': 2, // 禁止無用的構造函數 'no-useless-constructor': 2, // 禁止無用的轉義 'no-useless-escape': 2, // 禁止無效的重命名,如 import {a as a} from xxx 'no-useless-rename': 2, // 禁止沒有必要的 return // @off 沒有必要限制 'no-useless-return': 0, // 禁止使用 var,必須用 let 或 const 'no-var': 2, // 禁止使用void 'no-void': 2, // 禁止註釋中出現 TODO 或 FIXME,用這個來提醒開發者,寫了 TODO 就必定要作完 'no-warning-comments': 1, // 禁止屬性前出現空格,如 foo. bar() 'no-whitespace-before-property': 2, // 禁止 with 'no-with': 2, // 禁止 if 語句在沒有花括號的狀況下換行 'nonblock-statement-body-position': 2, // 定義對象的花括號先後是否要加空行 // @off 不關心 'object-curly-newline': 0, // 定義對象的花括號先後是否要加空格 // @off 不關心 'object-curly-spacing': 0, // 對象每一個屬性必須獨佔一行 // @off 不限制 'object-property-newline': 0, // obj = { a: a } 必須轉換成 obj = { a } // @off 不必 'object-shorthand': 0, // 每一個變量聲明必須獨佔一行 // @off 有 one-var 就不須要此規則了 'one-var-declaration-per-line': 0, // 是否容許使用逗號一次聲明多個變量 'one-var': [2, { 'const': 'never' // 全部 const 聲明必須獨佔一行,不容許用逗號定義多個 }], // 必須使用 x = x + y 而不是 x += y // @off 不必限制 'operator-assignment': 0, // 斷行時操做符位於行首仍是行尾 // @off 不關心 'operator-linebreak': 0, // 代碼塊首尾必需要空行 // @off 不必限制 'padded-blocks': 0, // 限制語句之間的空行規則,好比變量定義完以後必需要空行 // @off 不必限制 'padding-line-between-statements': 0, // 必須使用箭頭函數做爲回調 // @off 不必 'prefer-arrow-callback': 0, // 聲明後再也不修改的變量必須使用 const // @off 不必 'prefer-const': 0, // 必須使用解構 // @off 不必 'prefer-destructuring': 0, // 必須使用 0b11111011 而不是 parseInt('111110111', 2) // @off 不必 'prefer-numeric-literals': 0, // promise 的 reject 中必須傳入 Error 對象,而不容許使用字面量 'prefer-promise-reject-errors': 2, // 必須使用解構 ...args 來代替 arguments 'prefer-rest-params': 2, // 必須使用 func(...args) 來代替 func.apply(args) // @off 不必 'prefer-spread': 0, // 必須使用模板字符串來代替字符串拼接 // @off 不限制 'prefer-template': 0, // 字符串必須使用單引號 'quotes': [2, 'single', { 'avoidEscape': true, // 容許包含單引號的字符串使用雙引號 'allowTemplateLiterals': true, // 容許使用模板字符串 }], // 對象字面量的鍵名禁止用引號括起來 // @off 不必限制 'quote-props': 0, // parseInt方法必須傳進制參數 'radix': 2, // async 函數中必須存在 await 語句 // @off async function 中沒有 await 的寫法很常見,好比 koa 的示例中就有這種用法 'require-await': 0, // 必須使用 jsdoc 風格的註釋 // @off 暫不考慮開啓 'require-jsdoc': 0, // generator 函數內必須有 yield 'require-yield': 2, // ...後面不容許有空格 'rest-spread-spacing': [2, 'never'], // 分號先後的空格規則 // @off 不限制 'semi-spacing': 0, // 禁止行首出現分號 'semi-style': [2, 'last'], // 行尾必須使用分號結束 'semi': 2, // imports 必須排好序 // @off 不必限制 'sort-imports': 0, // 對象字面量的鍵名必須排好序 // @off 不必限制 'sort-keys': 0, // 變量聲明必須排好序 // @off 不必限制 'sort-vars': 0, // function 等的花括號以前是否使用空格 // @off 不關心 'space-before-blocks': 0, // function 的圓括號以前是否使用空格 // @off 不關心 'space-before-function-paren': 0, // 圓括號內的空格使用規則 // @off 不關心 'space-in-parens': 0, // 操做符先後要加空格 'space-infix-ops': 2, // new, delete, typeof, void, yield 等表達式先後必須有空格,-, +, --, ++, !, !! 等表達式先後不準有空格 'space-unary-ops': [2, { 'words': true, 'nonwords': false, }], // 註釋的斜線和星號後要加空格 'spaced-comment': [2, 'always', { 'block': { exceptions: ['*'], balanced: true } }], // 禁用嚴格模式,禁止在任何地方出現 'use strict' 'strict': [2, 'never'], // switch 中冒號先後的空格規則 // @off 不關心 'switch-colon-spacing': 0, // 建立 Symbol 的時候必須傳入描述 'symbol-description': 2, // 模板字符串 ${} 先後的空格規則 // @off 不限制 'template-curly-spacing': 0, // 模板字符串先後的空格規則 // @off 不限制 'template-tag-spacing': 0, // 全部文件頭禁止出現 BOM 'unicode-bom': 2, // 禁止直接對 NaN 進行判斷,必須使用 isNaN 'use-isnan': 2, // 註釋必須符合 jsdoc 的規範 // @off 暫不考慮開啓 'valid-jsdoc': 0, // typeof 判斷條件只能是 "undefined", "object", "boolean", "number", "string", "function" 或 "symbol" 'valid-typeof': 2, // var 必須在做用域的最前面 // @off var 不在最前面也是很常見的用法 'vars-on-top': 0, // 自執行函數必須使用圓括號括起來,如 (function(){do something...})() 'wrap-iife': [2, 'inside'], // 正則表達式必須用圓括號括起來 // @off 不限制 'wrap-regex': 0, // yield 的 * 先後空格規則 // @off 不限制 'yield-star-spacing': 0, // 禁止Yoda格式的判斷條件,如 if (true === a),應使用 if (a === true) 'yoda': 2, } }; 複製代碼
以上內容就是我在公司項目中使用到的ESLint規則,你們能夠也運用到本身的項目中試試看,固然上面的規則都是可配置的,若是你有用不到的,直接把對應的規則賦爲0就能夠了
咱們要作一個頗有規範的Coder,讓別人看到咱們寫的代碼閱讀起來無障礙,上手快,這纔算是高效的開發了
哈哈,就說到這裏吧,感謝你們了!