前提:如果沒有安裝package control,可以參考sublime插件推薦
以下按照順序安裝:
- 安裝SublimeLinter
- 安裝SublimeLinter-contrib-eslint
- 安裝EditorConfig,希望安裝
如果是用atom:
- 安裝linter-eslint
demo github 地址
官方配置文檔
rules地址
EditorConfig介紹
簡單概念
一些需要了解的吧,從官網拷貝出來
1,rule的配置,值說明
- "off"或 0 - 關閉規則
- "warn"或 1 - 開啟規則,使用警告級別的錯誤:warn(不會導致程序退出)
- "error"或 2 - 開啟規則,使用錯誤級別的錯誤:error (當被觸發的時候,程序會退出)
2,層級問題,優先級規則是就近原則
下面是文檔中的例子:
your-project
├── .eslintrc
├── lib
│ └── source.js
└─┬ tests
├── .eslintrc
└── test.js
1)層疊配置使用離要檢測的文件最近的 .eslintrc
文件作為最高優先級,然后才是父目錄里的配置文件,等等。當你在這個項目中允許 ESLint 時,lib/下面的所有文件將使用項目根目錄里的.eslintrc 文件作為它的配置文件。當 ESLint 遍歷到 test/ 目錄,your-project/.eslintrc之外,它還會用到 your-project/tests/.eslintrc。所以 your-project/tests/test.js 是基于它的目錄層次結構中的兩個.eslintrc 文件的組合,并且離的最近的一個優先。通過這種方式,你可以有項目級 ESLint 設置,也有覆蓋特定目錄的 ESLint 設置。
2)同樣的,如果在根目錄的 package.json 文件中有一個 eslintConfig 字段,其中的配置將使用于所有子目錄,但是當 tests 目錄下的 .eslintrc 文件中的規則與之發生沖突時,就會覆蓋它。
3)如果同一目錄下 .eslintrc 和 package.json 同時存在,.eslintrc 優先級高會被使用,package.json 文件將不會被使用。
4)默認情況下,ESLint 會在所有父級目錄里尋找配置文件,一直到根目錄。如果你想要你所有項目都遵循一個特定的約定時,這將會很有用,但有時候會導致意想不到的結果。為了將 ESLint 限制到一個特定的項目,在你項目根目錄下的 package.json 文件或者 .eslintrc.* 文件里的eslintConfig 字段下設置 "root": true。ESLint 一旦發現配置文件中有 "root": true,它就會停止在父級目錄中尋找。
3,配置文件繼承
"extends": "airbnb",
以下是規則說明
下面的規則指出了你可能犯錯誤的地方:
- comma-dangle: 要求或禁止末尾逗號
- no-cond-assign: 禁止條件表達式中出現賦值操作符
- no-console: 禁用 console
- no-constant-condition: 禁止在條件中使用常量表達式
- no-control-regex: 禁止在正則表達式中使用控制字符
- no-debugger: 禁用 debugger
- no-dupe-args: 禁止 function 定義中出現重名參數
- no-dupe-keys: 禁止對象字面量中出現重復的 key
- no-duplicate-case: 禁止重復的 case 標簽
- no-empty: 禁止空語句塊
- no-empty-character-class: 禁止在正則表達式中使用空字符集
- no-ex-assign: 禁止對 catch 子句的參數重新賦值
- no-extra-boolean-cast: 禁止不必要的布爾轉換
- no-extra-parens: 禁止不必要的括號
- no-extra-semi: 禁止不必要的分號
- no-func-assign: 禁止對 function 聲明重新賦值
- no-inner-declarations: 禁止在嵌套的塊中出現 function 或 var 聲明
- no-invalid-regexp: 禁止 RegExp 構造函數中無效的正則表達式字符串
- no-irregular-whitespace: 禁止在字符串和注釋之外不規則的空白
- no-negated-in-lhs: 禁止在 in 表達式中出現否定的左操作數
- no-obj-calls: 禁止把全局對象 (Math 和 JSON) 作為函數調用
- no-prototype-builtins: 禁止直接使用 Object.prototypes 的內置屬性
- no-regex-spaces: 禁止正則表達式字面量中出現多個空格
- no-sparse-arrays: 禁用稀疏數組
- no-unexpected-multiline: 禁止出現令人困惑的多行表達式
- no-unreachable: 禁止在return、throw、continue 和 break語句之后出現不可達代碼
- no-unsafe-finally: 禁止在 finally 語句塊中出現控制流語句
- use-isnan: 要求使用 isNaN() 檢查 NaN
- valid-jsdoc: 強制使用有效的 JSDoc 注釋
- valid-typeof: 強制 typeof 表達式與有效的字符串進行比較
這些規則是關于最佳實踐的,幫助你避免一些問題:
- accessor-pairs: 強制 getter 和 setter 在對象中成對出現
- array-callback-return: 強制數組方法的回調函數中有 return 語句
- block-scoped-var: 強制把變量的使用限制在其定義的作用域范圍內
- complexity: 指定程序中允許的最大環路復雜度
- consistent-return: 要求 return 語句要么總是指定返回的值,要么不指定
- curly: 強制所有控制語句使用一致的括號風格
- default-case: 要求 switch 語句中有 default 分支
- dot-location: 強制在點號之前和之后一致的換行
- dot-notation: 強制在任何允許的時候使用點號
- eqeqeq: 要求使用 === 和 !==
- guard-for-in: 要求 for-in 循環中有一個 if 語句
- no-alert: 禁用 alert、confirm 和 prompt
- no-caller: 禁用 arguments.caller 或 arguments.callee
- no-case-declarations: 不允許在 case 子句中使用詞法聲明
- no-div-regex: 禁止除法操作符顯式的出現在正則表達式開始的位置
- no-else-return: 禁止 if 語句中有 return 之后有 else
- no-empty-function: 禁止出現空函數
- no-empty-pattern: 禁止使用空解構模式
- no-eq-null: 禁止在沒有類型檢查操作符的情況下與 null 進行比較
- no-eval: 禁用 eval()
- no-extend-native: 禁止擴展原生類型
- no-extra-bind: 禁止不必要的 .bind() 調用
- no-extra-label: 禁用不必要的標簽
- no-fallthrough: 禁止 case 語句落空
- no-floating-decimal: 禁止數字字面量中使用前導和末尾小數點
- no-implicit-coercion: 禁止使用短符號進行類型轉換
- no-implicit-globals: 禁止在全局范圍內使用 var 和命名的 function 聲明
- no-implied-eval: 禁止使用類似 eval() 的方法
- no-invalid-this: 禁止 this 關鍵字出現在類和類對象之外
- no-iterator: 禁用 iterator 屬性
- no-labels: 禁用標簽語句
- no-lone-blocks: 禁用不必要的嵌套塊
- no-loop-func: 禁止在循環中出現 function 聲明和表達式
- no-magic-numbers: 禁用魔術數字
- no-multi-spaces: 禁止使用多個空格
- no-multi-str: 禁止使用多行字符串
- no-native-reassign: 禁止對原生對象賦值
- no-new: 禁止在非賦值或條件語句中使用 new 操作符
- no-new-func: 禁止對 Function 對象使用 new 操作符
- no-new-wrappers: 禁止對 String,Number 和 Boolean 使用 new 操作符
- no-octal: 禁用八進制字面量
- no-octal-escape: 禁止在字符串中使用八進制轉義序列
- no-param-reassign: 不允許對 function 的參數進行重新賦值
- no-proto: 禁用 proto 屬性
- no-redeclare: 禁止使用 var 多次聲明同一變量
- no-return-assign: 禁止在 return 語句中使用賦值語句
- no-script-url: 禁止使用 javascript: url
- no-self-assign: 禁止自我賦值
- no-self-compare: 禁止自身比較
- no-sequences: 禁用逗號操作符
- no-throw-literal: 禁止拋出非異常字面量
- no-unmodified-loop-condition: 禁用一成不變的循環條件
- no-unused-expressions: 禁止出現未使用過的表達式
- no-unused-labels: 禁用未使用過的標簽
- no-useless-call: 禁止不必要的 .call() 和 .apply()
- no-useless-concat: 禁止不必要的字符串字面量或模板字面量的連接
- no-useless-escape: 禁用不必要的轉義字符
- no-void: 禁用 void 操作符
- no-warning-comments: 禁止在注釋中使用特定的警告術語
- no-with: 禁用 with 語句
- radix: 強制在parseInt()使用基數參數
- vars-on-top: 要求所有的 var 聲明出現在它們所在的作用域頂部
- wrap-iife: 要求 IIFE 使用括號括起來
- yoda: 要求或禁止 “Yoda” 條件
這些規則與變量聲明有關:
- init-declarations: 要求或禁止 var 聲明中的初始化
- no-catch-shadow: 不允許 catch 子句的參數與外層作用域中的變量同名
- no-delete-var: 禁止刪除變量
- no-label-var: 不允許標簽與變量同名
- no-restricted-globals: 禁用特定的全局變量
- no-shadow: 禁止 var 聲明 與外層作用域的變量同名
- no-shadow-restricted-names: 禁止覆蓋受限制的標識符
- no-undef: 禁用未聲明的變量,除非它們在 /*global */ 注釋中被提到
- no-undef-init: 禁止將變量初始化為 undefined
- no-undefined: 禁止將 undefined 作為標識符
- no-unused-vars: 禁止出現未使用過的變量
- no-use-before-define: 不允許在變量定義之前使用它們
這些規則是關于Node.js 或 在瀏覽器中使用CommonJS 的:
- callback-return: require return statements after callbacks
- global-require: 要求 require() 出現在頂層模塊作用域中
- handle-callback-err: 要求回調函數中有容錯處理
- no-mixed-requires: 禁止混合常規 var 聲明和 require 調用
- no-new-require: 禁止調用 require 時使用 new 操作符
- no-path-concat: 禁止對 __dirname 和 __filename進行字符串連接
- no-process-env: 禁用 process.env
- no-process-exit: 禁用 process.exit()
- no-restricted-modules: 禁用指定的通過 require 加載的模塊
- no-sync: 禁用同步方法
這些規則是關于風格指南的,而且是非常主觀的:
- array-bracket-spacing: 強制數組方括號中使用一致的空格
- block-spacing: 強制在單行代碼塊中使用一致的空格
- brace-style: 強制在代碼塊中使用一致的大括號風格
- camelcase: 強制使用駱駝拼寫法命名約定
- comma-spacing: 強制在逗號前后使用一致的空格
- comma-style: 強制使用一致的逗號風格
- computed-property-spacing: 強制在計算的屬性的方括號中使用一致的空格
- consistent-this: 當獲取當前執行環境的上下文時,強制使用一致的命名
- eol-last: 強制文件末尾至少保留一行空行
- func-names: 強制使用命名的 function 表達式
- func-style: 強制一致地使用函數聲明或函數表達式
- id-blacklist: 禁止使用指定的標識符
- id-length: 強制標識符的最新和最大長度
- id-match: 要求標識符匹配一個指定的正則表達式
- indent: 強制使用一致的縮進
- jsx-quotes: 強制在 JSX 屬性中一致地使用雙引號或單引號
- key-spacing: 強制在對象字面量的屬性中鍵和值之間使用一致的間距
- keyword-spacing: 強制在關鍵字前后使用一致的空格
- linebreak-style: 強制使用一致的換行風格
- lines-around-comment: 要求在注釋周圍有空行
- max-depth: 強制可嵌套的塊的最大深度
- max-len: 強制一行的最大長度
- max-lines: 強制最大行數
- max-nested-callbacks: 強制回調函數最大嵌套深度
- max-params: 強制 function 定義中最多允許的參數數量
- max-statements: 強制 function 塊最多允許的的語句數量
- max-statements-per-line: 強制每一行中所允許的最大語句數量
- new-cap: 要求構造函數首字母大寫
- new-parens: 要求調用無參構造函數時有圓括號
- newline-after-var: 要求或禁止 var 聲明語句后有一行空行
- newline-before-return: 要求 return 語句之前有一空行
- newline-per-chained-call: 要求方法鏈中每個調用都有一個換行符
- no-array-constructor: 禁止使用 Array 構造函數
- no-bitwise: 禁用按位運算符
- no-continue: 禁用 continue 語句
- no-inline-comments: 禁止在代碼行后使用內聯注釋
- no-lonely-if: 禁止 if 作為唯一的語句出現在 else 語句中
- no-mixed-operators: 禁止混合使用不同的操作符
- no-mixed-spaces-and-tabs: 不允許空格和 tab 混合縮進
- no-multiple-empty-lines: 不允許多個空行
- no-negated-condition: 不允許否定的表達式
- no-nested-ternary: 不允許使用嵌套的三元表達式
- no-new-object: 禁止使用 Object 的構造函數
- no-plusplus: 禁止使用一元操作符 ++ 和 --
- no-restricted-syntax: 禁止使用特定的語法
- no-spaced-func: 禁止 function 標識符和括號之間出現空格
- no-ternary: 不允許使用三元操作符
- no-trailing-spaces: 禁用行尾空格
- no-underscore-dangle: 禁止標識符中有懸空下劃線
- no-unneeded-ternary: 禁止可以在有更簡單的可替代的表達式時使用三元操作符
- no-whitespace-before-property: 禁止屬性前有空白
- object-curly-newline: 強制花括號內換行符的一致性
- object-curly-spacing: 強制在花括號中使用一致的空格
- object-property-newline: 強制將對象的屬性放在不同的行上
- one-var: 強制函數中的變量要么一起聲明要么分開聲明
- one-var-declaration-per-line: 要求或禁止在 var 聲明周圍換行
- operator-assignment: 要求或禁止在可能的情況下要求使用簡化的賦值操作符
- operator-linebreak: 強制操作符使用一致的換行符
- padded-blocks: 要求或禁止塊內填充
- quote-props: 要求對象字面量屬性名稱用引號括起來
- quotes: 強制使用一致的反勾號、雙引號或單引號
- require-jsdoc: 要求使用 JSDoc 注釋
- semi: 要求或禁止使用分號而不是 ASI
- semi-spacing: 強制分號之前和之后使用一致的空格
- sort-vars: 要求同一個聲明塊中的變量按順序排列
- space-before-blocks: 強制在塊之前使用一致的空格
- space-before-function-paren: 強制在 function的左括號之前使用一致的空格
- space-in-parens: 強制在圓括號內使用一致的空格
- space-infix-ops: 要求操作符周圍有空格
- space-unary-ops: 強制在一元操作符前后使用一致的空格
- spaced-comment: 強制在注釋中 // 或 /* 使用一致的空格
- unicode-bom: 要求或禁止 Unicode BOM
- wrap-regex: 要求正則表達式被括號括起來
這些規則只與 ES6 有關, 即通常所說的 ES2015:
- arrow-body-style: 要求箭頭函數體使用大括號
- arrow-parens: 要求箭頭函數的參數使用圓括號
- arrow-spacing: 強制箭頭函數的箭頭前后使用一致的空格
- constructor-super: 要求在構造函數中有 super() 的調用
- generator-star-spacing: 強制 generator 函數中 * 號周圍使用一致的空格
- no-class-assign: 禁止修改類聲明的變量
- no-confusing-arrow: disallow arrow functions where they could be confused with comparisons
- no-const-assign: 禁止修改 const 聲明的變量
- no-dupe-class-members: 禁止類成員中出現重復的名稱
- no-duplicate-imports: disallow duplicate module imports
- no-new-symbol: disallow new operators with the Symbol object
- no-restricted-imports: disallow specified modules when loaded by import
- no-this-before-super: 禁止在構造函數中,在調用 super() 之前使用 this 或 super
- no-useless-computed-key: disallow unnecessary computed property keys in object literals
- no-useless-constructor: 禁用不必要的構造函數
- no-useless-rename: disallow renaming import, export, and destructured assignments to the same name
- no-var: 要求使用 let 或 const 而不是 var
- object-shorthand: 要求或禁止對象字面量中方法和屬性使用簡寫語法
- prefer-arrow-callback: 要求使用箭頭函數作為回調
- prefer-const: 要求使用 const 聲明那些聲明后不再被修改的變量
- prefer-reflect: 要求在合適的地方使用 Reflect 方法
- prefer-rest-params: require rest parameters instead of arguments
- prefer-spread: 要求使用擴展運算符而非 .apply()
- prefer-template: 要求使用模板字面量而非字符串連接
- require-yield: 要求generator 函數內有 yield
- rest-spread-spacing: enforce spacing between rest and spread operators and their expressions
- sort-imports: 強制模塊內的 import 排序
- template-curly-spacing: 要求或禁止模板字符串中的嵌入表達式周圍空格的使用
- yield-star-spacing: 強制在 yield* 表達式中 * 周圍使用空格