1. 程式人生 > >webstorm引用ESLint進行靜態程式碼檢查

webstorm引用ESLint進行靜態程式碼檢查

規範程式碼
JavaScript 的程式碼檢查工具有:JSLint,JSHint, JSCS, ESLint,本文著重介紹 ESLint。
ESLint 在一系列的程式碼質量檢查工具中,是最年輕的一個,當然也是最現代化的。配置多樣,支援 JavaScript, JSON 以及 YAML 格式的 .eslintrc.*檔案,同時也支援在package.json用eslintConfig欄位配置(Configuration File Formats)。
一、安裝
ESLint 基於 Node 平臺,所以 Nodejs 是必須安裝的,然後通過 npm 安裝 ESLint 包,至於全域性安裝還是作為開發依賴安裝,取決於個人。
然後在 WebStorm 中,開啟設定(File>Setting或者Alt+F7),按路徑進入 ESLint 的配置介面(Languages&Frameworks>JavaScript>Code Quality Tools>ESLint)。開啟 ESLint,並配置相應路徑,配置檔案預設使用.eslintrc。
 
二、配置
ESLint 的配置分為六大塊,分別是:
1.Parser Options(解析器選項)。涉及語言版本等引數。ESLin t預設只支援 ES5,如果需要支援 ES6,需要在這配置。
2.Parser(解析器選擇)。可以讓你自己選擇ESLint的解析器。ESLint 預設使用Espress作為作為解析器,強烈不推薦修改
3.Environments(語言環境選項)。比如borwser,node,jquery,meteor等等
4.Globals(全域性變數)。比如你自己寫了外掛,需要全域性使用,需要在這個選項中宣告。
5.Plugins(第三方外掛)。引入的第三方外掛,為了防止誤殺,需要在這個選項中申明(但限於 npm 外掛,如果是 jquery 外掛等前端外掛,建議在Globals選擇中宣告)。
6.Rules(語法規則)。這個是 ESLint 的重點,同時也是整個配置中最豐富的地方,比如結尾分號檢測,單雙引號,嚴格格式等。
語法規則(Rules)配置
在官方文件中,語法規則的配置又分六大類:
1.Possible Errors,常見錯誤。
2.Best Practices,最佳實踐
3.Strict Mode,嚴格模式
4.Variables,變數宣告相關,比如不允許未定義的變數
5.Node.js and CommonJS
6.Stylistic Issues,程式碼樣式,比如單雙引號,單行長度,巢狀深度等等
7.ECMAScript 6,ES6相關語法,箭頭函式,生成器等等。
語法規則配置的寫法
使用鍵值對編寫,語言規則欄位(rule ID)作為鍵,通過不同的值來影響規則欄位。規則字型的值必須是以下三種之一:
•"off" 或者0——不檢查這個規則
•"warn"或者1——開啟這個規則,規則生效時,作為提醒告訴使用者
•"error"或者2——開啟這個規則,規則生效時,作為錯誤告訴使用者
用以下簡短的規則配置做說明:
1
2
3
4
5
6
7{
  "rules": {
    "quotes": ["2", "single"],
    "no-undef": [2],
    "no-multi-spaces": [1]
  }
}
這個配置規則對應如下:
•要求使用單引號,如果不是,顯示錯誤資訊
•如果使用了未宣告的變數,顯示錯誤資訊
•如果變數與操作符之間出現多個空格,顯示提醒資訊
.eslintignore
如果你有 Git 的使用經驗,那.eslintignore檔案的功能也就很容易理解了。類似於.gitignore,用於排除檔案與目錄,比如npm的node_modules目錄等,以及一些第三方外掛。對於這些目錄與檔案,不執行程式碼質量檢查。
 
開始介紹EsLint的詳細用法
parserOptions
EsLint通過parserOptions,允許指定校驗的ecma的版本,及ecma的一些特性
{
    "parserOptions": {
        "ecmaVersion": 6, //指定ECMAScript支援的版本,6為ES6
        "sourceType": "module", //指定來源的型別,有兩種”script”或”module”
        "ecmaFeatures": {
            "jsx": true//啟動JSX
        },
    }
}


Parser
EsLint預設使用esprima做指令碼解析,當然你也切換他,比如切換成babel-eslint解析
{
    "parser": "esprima" //預設,可以設定成babel-eslint,支援jsx
}
Environments
Environment可以預設好的其他環境的全域性變數,如brower、node環境變數、es6環境變數、mocha環境變數等
{
    "env": {
        "browser": true,
        "node": true
    }
}
如果你想使用外掛中的環境變數,你可以使用plugins指定,如下
{
    "plugins": ["example"],
    "env": {
        "example/custom": true
    }
}




Globals
指定你所要使用的全域性變數,true代表允許重寫、false代表不允許重寫




{
    "globals": {
        "var1": true,
        "var2": false
    }
}
Plugins
EsLint允許使用第三方外掛
{
    "plugins": [
        "react"    
     ]
}
Rules
自定義規則,一般格式:”規則名稱”:error級別係數。係數0為不提示(off)、1為警告(warn)、2為錯誤丟擲(error),可指定範圍,如[1,4]
可以包括Strict模式、也可以是code的方式提醒,如符號等。還可以是第三方的校驗,如react。
預設校驗的地址http://eslint.org/docs/rules/


{
    "plugins": [
        "react"
    ],
    "rules": {
         //Javascript code 預設校驗
        "eqeqeq": "off", //off = 0
        "curly": "error", //error = 2
        "quotes": ["warn", "double"], //warn = 1
         //使用第三方外掛的校驗規則
        "react/jsx-quotes": 0
    }
}


參考配置如下:
{
  "parserOptions": {
    "ecmaVersion": 6,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true
    }
  },
  "env": {
    "browser": true,
    "node": true,
    "commonjs": true,
    "meteor": true,
    "mongo": true,
    "jquery": true,
    "amd": true
  },
  "globals": {},
  "rules": {
     "no-alert": 0,//禁止使用alert confirm prompt
     "no-array-constructor": 2,//禁止使用陣列構造器
     "no-bitwise": 0,//禁止使用按位運算子
     "no-caller": 1,//禁止使用arguments.caller或arguments.callee
     "no-catch-shadow": 2,//禁止catch子句引數與外部作用域變數同名
     "no-class-assign": 2,//禁止給類賦值
     "no-cond-assign": 2,//禁止在條件表示式中使用賦值語句
     "no-console": 2,//禁止使用console
     "no-const-assign": 2,//禁止修改const宣告的變數
     "no-constant-condition": 2,//禁止在條件中使用常量表達式 if(true) if(1)
     "no-continue": 0,//禁止使用continue
     "no-control-regex": 2,//禁止在正則表示式中使用控制字元
     "no-debugger": 2,//禁止使用debugger
     "no-delete-var": 2,//不能對var宣告的變數使用delete操作符
     "no-div-regex": 1,//不能使用看起來像除法的正則表示式/=foo/
     "no-dupe-keys": 2,//在建立物件字面量時不允許鍵重複 {a:1,a:1}
     "no-dupe-args": 2,//函式引數不能重複
     "no-duplicate-case": 2,//switch中的case標籤不能重複
     "no-else-return": 2,//如果if語句裡面有return,後面不能跟else語句
     "no-empty": 2,//塊語句中的內容不能為空
     "no-empty-character-class": 2,//正則表示式中的[]內容不能為空
     "no-empty-label": 2,//禁止使用空label
     "no-eq-null": 2,//禁止對null使用==或!=運算子
     "no-eval": 1,//禁止使用eval
     "no-ex-assign": 2,//禁止給catch語句中的異常引數賦值
     "no-extend-native": 2,//禁止擴充套件native物件
     "no-extra-bind": 2,//禁止不必要的函式繫結
     "no-extra-boolean-cast": 2,//禁止不必要的bool轉換
     "no-extra-parens": 2,//禁止非必要的括號
     "no-extra-semi": 2,//禁止多餘的冒號
     "no-fallthrough": 1,//禁止switch穿透
     "no-floating-decimal": 2,//禁止省略浮點數中的0 .5 3.
     "no-func-assign": 2,//禁止重複的函式宣告
     "no-implicit-coercion": 1,//禁止隱式轉換
     "no-implied-eval": 2,//禁止使用隱式eval
     "no-inline-comments": 0,//禁止行內備註
     "no-inner-declarations": [2, "functions"],//禁止在塊語句中使用宣告(變數或函式)
     "no-invalid-regexp": 2,//禁止無效的正則表示式
     "no-invalid-this": 2,//禁止無效的this,只能用在構造器,類,物件字面量
     "no-irregular-whitespace": 2,//不能有不規則的空格
     "no-iterator": 2,//禁止使用__iterator__ 屬性
     "no-label-var": 2,//label名不能與var宣告的變數名相同
     "no-labels": 2,//禁止標籤宣告
     "no-lone-blocks": 2,//禁止不必要的巢狀塊
     "no-lonely-if": 2,//禁止else語句內只有if語句
     "no-loop-func": 1,//禁止在迴圈中使用函式(如果沒有引用外部變數不形成閉包就可以)
     "no-mixed-requires": [0, false],//宣告時不能混用宣告型別
     "no-mixed-spaces-and-tabs": [2, false],//禁止混用tab和空格
     "linebreak-style": [0, "windows"],//換行風格
     "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構造一個例項後不賦值
     "no-new-func": 1,//禁止使用new Function
     "no-new-object": 2,//禁止使用new Object()
     "no-new-require": 2,//禁止使用new require
     "no-new-wrappers": 2,//禁止使用new建立包裝例項,new String new Boolean new Number
     "no-obj-calls": 2,//不能呼叫內建的全域性物件,比如Math() JSON()
     "no-octal": 2,//禁止使用八進位制數字
     "no-octal-escape": 2,//禁止使用八進位制轉義序列
     "no-param-reassign": 2,//禁止給引數重新賦值
     "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,//禁止重複宣告變數
     "no-regex-spaces": 2,//禁止在正則表示式字面量中使用多個空格 /foo bar/
     "no-restricted-modules": 0,//如果禁用了指定模組,使用就會報錯
     "no-return-assign": 1,//return 語句中不能有賦值表示式
     "no-script-url": 0,//禁止使用javascript:void(0)
     "no-self-compare": 2,//不能比較自身
     "no-sequences": 0,//禁止使用逗號運算子
     "no-shadow": 2,//外部作用域中的變數不能與它所包含的作用域中的變數或引數同名
     "no-shadow-restricted-names": 2,//嚴格模式中規定的限制識別符號不能作為宣告時的變數名使用
     "no-spaced-func": 2,//函式呼叫時 函式名與()之間不能有空格
     "no-sparse-arrays": 2,//禁止稀疏陣列, [1,,2]
     "no-sync": 0,//nodejs 禁止同步方法
     "no-ternary": 0,//禁止使用三目運算子
     "no-trailing-spaces": 1,//一行結束後面不要有空格
     "no-this-before-super": 0,//在呼叫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,//避免多行表示式
     "no-underscore-dangle": 1,//識別符號不能以_開頭或結尾
     "no-unneeded-ternary": 2,//禁止不必要的巢狀 var isYes = answer === 1 ? true : false;
     "no-unreachable": 2,//不能有無法執行的程式碼
     "no-unused-expressions": 2,//禁止無用的表示式
     "no-unused-vars": [2, {"vars": "all", "args": "after-used"}],//不能有聲明後未被使用的變數或引數
     "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" }],//不能有警告備註
     "no-with": 2,//禁用with


     "array-bracket-spacing": [2, "never"],//是否允許非空數組裡面有多餘的空格
     "arrow-parens": 0,//箭頭函式用小括號括起來
     "arrow-spacing": 0,//=>的前/後括號
     "accessor-pairs": 0,//在物件中使用getter/setter
     "block-scoped-var": 0,//塊語句中使用var
     "brace-style": [1, "1tbs"],//大括號風格
     "callback-return": 1,//避免多次呼叫回撥什麼的
     "camelcase": 2,//強制駝峰法命名
     "comma-dangle": [2, "never"],//物件字面量項尾不能有逗號
     "comma-spacing": 0,//逗號前後的空格
     "comma-style": [2, "last"],//逗號風格,換行時在行首還是行尾
     "complexity": [0, 11],//迴圈複雜度
     "computed-property-spacing": [0, "never"],//是否允許計算後的鍵名什麼的
     "consistent-return": 0,//return 後面是否允許省略
     "consistent-this": [2, "that"],//this別名
     "constructor-super": 0,//非派生類不能呼叫super,派生類必須呼叫super
     "curly": [2, "all"],//必須使用 if(){} 中的{}
     "default-case": 2,//switch語句最後必須有default
     "dot-location": 0,//物件訪問符的位置,換行的時候在行首還是行尾
     "dot-notation": [0, { "allowKeywords": true }],//避免不必要的方括號
     "eol-last": 0,//檔案以單一的換行符結束
     "eqeqeq": 2,//必須使用全等
     "func-names": 0,//函式表示式必須有名字
     "func-style": [0, "declaration"],//函式風格,規定只能使用函式宣告/函式表示式
     "generator-star-spacing": 0,//生成器函式*的前後空格
     "guard-for-in": 0,//for in迴圈要用if語句過濾
     "handle-callback-err": 2,//nodejs 處理錯誤
     "id-length": 0,//變數名長度
     "indent": [2, 4],//縮排風格
     "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],//回撥巢狀深度
     "max-params": [0, 3],//函式最多隻能有3個引數
     "max-statements": [0, 10],//函式內最多有幾個宣告
     "new-cap": 2,//函式名首行大寫必須使用new方式呼叫,首行小寫必須用不帶new方式呼叫
     "new-parens": 2,//new時必須加小括號
     "newline-after-var": 2,//變數聲明後是否需要空一行
     "object-curly-spacing": [0, "never"],//大括號內是否允許不必要的空格
     "object-shorthand": 0,//強制物件字面量縮寫語法
     "one-var": 1,//連續宣告
     "operator-assignment": [0, "always"],//賦值運算子 += -=什麼的
     "operator-linebreak": [2, "after"],//換行時運算子在行尾還是行首
     "padded-blocks": 0,//塊語句內行首行尾是否要空行
     "prefer-const": 0,//首選const
     "prefer-spread": 0,//首選展開運算
     "prefer-reflect": 0,//首選Reflect的方法
     "quotes": [1, "single"],//引號型別 `` "" ''
     "quote-props":[2, "always"],//物件字面量中的屬性名是否強制雙引號
     "radix": 2,//parseInt必須指定第二個引數
     "id-match": 0,//命名檢測
     "require-yield": 0,//生成器函式必須有yield
     "semi": [2, "always"],//語句強制分號結尾
     "semi-spacing": [0, {"before": false, "after": true}],//分號前後空格
     "sort-vars": 0,//變數宣告時排序
     "space-after-keywords": [0, "always"],//關鍵字後面是否要空一格
     "space-before-blocks": [0, "always"],//不以新行開始的塊{前面要不要有空格
     "space-before-function-paren": [0, "always"],//函式定義時括號前面要不要有空格
     "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,//註釋風格要不要有空格什麼的
     "strict": 2,//使用嚴格模式
     "use-isnan": 2,//禁止比較時使用NaN,只能用isNaN()
     "valid-jsdoc": 0,//jsdoc規則
     "valid-typeof": 2,//必須使用合法的typeof的值
     "vars-on-top": 2,//var必須放在作用域頂部
     "wrap-iife": [2, "inside"],//立即執行函式表示式的小括號風格
     "wrap-regex": 0,//正則表示式字面量用小括號包起來
     "yoda": [2, "never"]//禁止尤達條件
  }
}
所有引用規則均可參考:
http://eslint.org/docs/rules/