ESLint規(guī)范說(shuō)明1、工具簡(jiǎn)介ESLint是一個(gè)QA工具，用來(lái)避免低級(jí)錯(cuò)誤和統(tǒng)一代碼的風(fēng)格。ESLint被設(shè)計(jì)為完全可配置?？梢允褂脙?nèi)置的規(guī)則，也可以自己開發(fā)對(duì)應(yīng)的插件規(guī)則。內(nèi)置規(guī)則可以被配置的信息主要分為3類：

Environments：你的 JavaScript 腳步將要運(yùn)行在什么環(huán)境（如：nodejs，browser，commonjs等）中。
Globals：執(zhí)行代碼時(shí)腳步需要訪問(wèn)的額外全局變量。
Rules：開啟某些規(guī)則，也可以設(shè)置規(guī)則的等級(jí)

安裝方法：
npm install eslint –g
使用方法：
eslint –init
eslintexample.js

重點(diǎn)需要關(guān)注規(guī)則。在配置文件中可以設(shè)置一些規(guī)則。規(guī)則的錯(cuò)誤等級(jí)有三種：
1."off"或者 0：關(guān)閉規(guī)則。
2."warn"或者 1：打開規(guī)則，并且作為一個(gè)警告（不影響exit code）。
3."error"或者 2：打開規(guī)則，并且作為一個(gè)錯(cuò)誤（exit code將會(huì)是1）。
同時(shí)可以通過(guò)設(shè)定具體rule的參數(shù)來(lái)進(jìn)行條件控制。

默認(rèn)不會(huì)打開任何規(guī)則，所以全部需要手動(dòng)建立。

2、規(guī)則列表 以下為翻譯并收集的全部規(guī)則列表，選擇我們需要的規(guī)則，進(jìn)行等級(jí)配置和條件配置。具體文檔參照。其中我標(biāo)志為推薦的，是可以默認(rèn)進(jìn)行推薦配置，通過(guò)配置eslint:recommended，可以直接使用。其余規(guī)則按需要配置。
官方中文文檔http://eslint.cn/docs/rules/。

"no-alert": 0,//禁止使用alert confirmprompt
"no-array-constructor": 2,//禁止使用數(shù)組構(gòu)造器
"no-bitwise": 0,//禁止使用按位運(yùn)算符
"no-caller": 1,//禁止使用arguments.caller或arguments.callee
"no-catch-shadow": 2,//禁止catch子句參數(shù)與外部作用域變量同名
(推薦)"no-case-declarations": 2,// 不允許在 case 子句中使用詞法聲明
(推薦)"no-class-assign": 2,//禁止給類賦值
(推薦)"no-cond-assign": 2,//禁止在條件表達(dá)式中使用賦值語(yǔ)句
(推薦)"no-console": 2,//禁止使用console
(推薦)"no-const-assign": 2,//禁止修改const聲明的變量
(推薦)"no-constant-condition": 2,//禁止在條件中使用常量表達(dá)式 if(true) if(1)
"no-continue": 0,//禁止使用continue
(推薦)"no-control-regex": 2,//禁止在正則表達(dá)式中使用控制字符
(推薦)"no-debugger": 2,//禁止使用debugger
(推薦)"no-delete-var": 2,//不能對(duì)var聲明的變量使用delete操作符
"no-div-regex": 1,//不能使用看起來(lái)像除法的正則表達(dá)式/=foo/
(推薦)"no-dupe-keys": 2,//在創(chuàng)建對(duì)象字面量時(shí)不允許鍵重復(fù) {a:1,a:1}
(推薦)"no-dupe-args": 2,//函數(shù)參數(shù)不能重復(fù)
(推薦)" no-dupe-class-members": 2,// 禁止類成員中出現(xiàn)重復(fù)的名稱
"no-duplicate-case": 2,//switch中的case標(biāo)簽不能重復(fù)
"no-else-return": 2,//如果if語(yǔ)句里面有return,后面不能跟else語(yǔ)句
(推薦)"no-empty": 2,//塊語(yǔ)句中的內(nèi)容不能為空
(推薦)"no-empty-character-class": 2,//正則表達(dá)式中的[]內(nèi)容不能為空
"no-empty-label": 2,//禁止使用空l(shuí)abel
(推薦)"no-empty-pattern": 2,// 禁止使用空解構(gòu)模式
"no-eq-null": 2,//禁止對(duì)null使用==或!=運(yùn)算符
"no-eval": 1,//禁止使用eval
(推薦)"no-ex-assign": 2,//禁止給catch語(yǔ)句中的異常參數(shù)賦值
"no-extend-native": 2,//禁止擴(kuò)展native對(duì)象
"no-extra-bind": 2,//禁止不必要的函數(shù)綁定
(推薦)"no-extra-boolean-cast": 2,//禁止不必要的bool轉(zhuǎn)換
"no-extra-parens": 2,//禁止非必要的括號(hào)
(推薦)"no-extra-semi": 2,//禁止多余的冒號(hào)
(推薦)"no-fallthrough": 1,//禁止switch穿透
"no-floating-decimal": 2,//禁止省略浮點(diǎn)數(shù)中的0 .5 3.
(推薦)"no-func-assign": 2,//禁止重復(fù)的函數(shù)聲明
"no-implicit-coercion": 1,//禁止隱式轉(zhuǎn)換
"no-implied-eval": 2,//禁止使用隱式eval
"no-inline-comments": 0,//禁止行內(nèi)備注
(推薦)"no-inner-declarations": [2, "functions"],//禁止在塊語(yǔ)句中使用聲明（變量或函數(shù)）
(推薦)"no-invalid-regexp": 2,//禁止無(wú)效的正則表達(dá)式
"no-invalid-this": 2,//禁止無(wú)效的this，只能用在構(gòu)造器，類，對(duì)象字面量
(推薦)"no-irregular-whitespace": 2,//不能有不規(guī)則的空格
"no-iterator": 2,//禁止使用iterator 屬性
"no-label-var": 2,//label名不能與var聲明的變量名相同
"no-labels": 2,//禁止標(biāo)簽聲明
"no-lone-blocks": 2,//禁止不必要的嵌套塊
"no-lonely-if": 2,//禁止else語(yǔ)句內(nèi)只有if語(yǔ)句
"no-loop-func": 1,//禁止在循環(huán)中使用函數(shù)（如果沒(méi)有引用外部變量不形成閉包就可以）
"no-mixed-requires": [0, false],//聲明時(shí)不能混用聲明類型
(推薦)"no-mixed-spaces-and-tabs": [2, false],//禁止混用tab和空格
"linebreak-style": [0, "windows"],//換行風(fēng)格
"no-multi-spaces": 1,//不能用多余的空格
"no-multi-str": 2,//字符串不能用\換行
"no-multiple-empty-lines": [1, {"max": 2}],//空行最多不能超過(guò)2行
"no-native-reassign": 2,//不能重寫native對(duì)象
"no-negated-in-lhs": 2,//in 操作符的左邊不能有!
"no-nested-ternary": 0,//禁止使用嵌套的三目運(yùn)算
"no-new": 1,//禁止在使用new構(gòu)造一個(gè)實(shí)例后不賦值
"no-new-func": 1,//禁止使用new Function
"no-new-object": 2,//禁止使用new Object()
"no-new-require": 2,//禁止使用new require
"no-new-wrappers": 2,//禁止使用new創(chuàng)建包裝實(shí)例，new String newBoolean new Number
(推薦)"no-new-symbol": 2,// disallow new operators with the Symbol object
(推薦)"no-obj-calls": 2,//不能調(diào)用內(nèi)置的全局對(duì)象，比如Math() JSON()
(推薦)"no-octal": 2,//禁止使用八進(jìn)制數(shù)字
"no-octal-escape": 2,//禁止使用八進(jìn)制轉(zhuǎn)義序列
"no-param-reassign": 2,//禁止給參數(shù)重新賦值
"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,//禁止重復(fù)聲明變量
(推薦)"no-regex-spaces": 2,//禁止在正則表達(dá)式字面量中使用多個(gè)空格 /foo bar/
"no-restricted-modules": 0,//如果禁用了指定模塊，使用就會(huì)報(bào)錯(cuò)
"no-return-assign": 1,//return 語(yǔ)句中不能有賦值表達(dá)式
"no-script-url": 0,//禁止使用JavaScript:void(0)
(推薦)"no-self-assign": 2,//禁止自我賦值
"no-self-compare": 2,//不能比較自身
"no-sequences": 0,//禁止使用逗號(hào)運(yùn)算符
"no-shadow": 2,//外部作用域中的變量不能與它所包含的作用域中的變量或參數(shù)同名
"no-shadow-restricted-names": 2,//嚴(yán)格模式中規(guī)定的限制標(biāo)識(shí)符不能作為聲明時(shí)的變量名使用
"no-spaced-func": 2,//函數(shù)調(diào)用時(shí) 函數(shù)名與()之間不能有空格
(推薦)"no-sparse-arrays": 2,//禁止稀疏數(shù)組， [1,,2]
"no-sync": 0,//nodejs 禁止同步方法
"no-ternary": 0,//禁止使用三目運(yùn)算符
"no-trailing-spaces": 1,//一行結(jié)束后面不要有空格
(推薦)"no-this-before-super": 0,//在調(diào)用super()之前不能使用this或super
"no-throw-literal": 2,//禁止拋出字面量錯(cuò)誤 throw"error";
(推薦)"no-undef": 1,//不能有未定義的變量
"no-undef-init": 2,//變量初始化時(shí)不能直接給它賦值為undefined
"no-undefined": 2,//不能使用undefined
(推薦)"no-unused-labels": 2,// 禁用出現(xiàn)未使用過(guò)的標(biāo)
(推薦)"no-unexpected-multiline": 2,//避免多行表達(dá)式
"no-underscore-dangle": 1,//標(biāo)識(shí)符不能以開頭或結(jié)尾
"no-unneeded-ternary": 2,//禁止不必要的嵌套 var isYes =answer === 1 ? true : false;
(推薦)"no-unreachable": 2,//不能有無(wú)法執(zhí)行的代碼
(推薦)"no-unsafe-finally":2,//禁止在finally語(yǔ)塊中出現(xiàn)控制流語(yǔ)句
"no-unused-expressions": 2,//禁止無(wú)用的表達(dá)式
(推薦)"no-unused-vars": [2, {"vars": "all", "args": "after-used"}],//不能有聲明后未被使用的變量或參數(shù)
"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" }],//不能有警告?zhèn)渥?br> "no-with": 2,//禁用with
"array-bracket-spacing": [2, "never"],//是否允許非空數(shù)組里面有多余的空格
"arrow-parens": 0,//箭頭函數(shù)用小括號(hào)括起來(lái)
"arrow-spacing": 0,//=>的前/后括號(hào)
"accessor-pairs": 0,//在對(duì)象中使用getter/setter
"block-scoped-var": 0,//塊語(yǔ)句中使用var
"brace-style": [1, "1tbs"],//大括號(hào)風(fēng)格
"callback-return": 1,//避免多次調(diào)用回調(diào)什么的
"camelcase": 2,//強(qiáng)制駝峰法命名
"comma-dangle": [2, "never"],//對(duì)象字面量項(xiàng)尾不能有逗號(hào)
"comma-spacing": 0,//逗號(hào)前后的空格
"comma-style": [2, "last"],//逗號(hào)風(fēng)格，換行時(shí)在行首還是行尾
"complexity": [0, 11],//循環(huán)復(fù)雜度
"computed-property-spacing": [0, "never"],//是否允許計(jì)算后的鍵名什么的
"consistent-return": 0,//return 后面是否允許省略
"consistent-this": [2, "that"],//this別名
(推薦)"constructor-super": 0,//非派生類不能調(diào)用super，派生類必須調(diào)用super
"curly": [2, "all"],//必須使用 if(){} 中的{}
"default-case": 2,//switch語(yǔ)句最后必須有default
"dot-location": 0,//對(duì)象訪問(wèn)符的位置，換行的時(shí)候在行首還是行尾
"dot-notation": [0, { "allowKeywords": true }],//避免不必要的方括號(hào)
"eol-last": 0,//文件以單一的換行符結(jié)束
"eqeqeq": 2,//必須使用全等
"func-names": 0,//函數(shù)表達(dá)式必須有名字
"func-style": [0, "declaration"],//函數(shù)風(fēng)格，規(guī)定只能使用函數(shù)聲明/函數(shù)表達(dá)式
"generator-star-spacing": 0,//生成器函數(shù)*的前后空格
"guard-for-in": 0,//for in循環(huán)要用if語(yǔ)句過(guò)濾
"handle-callback-err": 0,//nodejs 處理錯(cuò)誤
"id-length": 0,//變量名長(zhǎng)度
"indent": [2, 4],//縮進(jìn)風(fēng)格
"init-declarations": 0,//聲明時(shí)必須賦初值
"key-spacing": [0, { "beforeColon": false, "afterColon": true }],//對(duì)象字面量中冒號(hào)的前后空格
"lines-around-comment": 0,//行前/行后備注
"max-depth": [0, 4],//嵌套塊深度
"max-len": [0, 80, 4],//字符串最大長(zhǎng)度
"max-nested-callbacks": [0, 2],//回調(diào)嵌套深度
"max-params": [0, 3],//函數(shù)最多只能有3個(gè)參數(shù)
"max-statements": [0, 10],//函數(shù)內(nèi)最多有幾個(gè)聲明
"new-cap": 2,//函數(shù)名首行大寫必須使用new方式調(diào)用，首行小寫必須用不帶new方式調(diào)用
"new-parens": 2,//new時(shí)必須加小括號(hào)
"newline-after-var": 2,//變量聲明后是否需要空一行
"object-curly-spacing": [0, "never"],//大括號(hào)內(nèi)是否允許不必要的空格
"object-shorthand": 0,//強(qiáng)制對(duì)象字面量縮寫語(yǔ)法
"one-var": 1,//連續(xù)聲明
"operator-assignment": [0, "always"],//賦值運(yùn)算符 += -=什么的
"operator-linebreak": [2, "after"],//換行時(shí)運(yùn)算符在行尾還是行首
"padded-blocks": 0,//塊語(yǔ)句內(nèi)行首行尾是否要空行
"prefer-const": 0,//首選const
"prefer-spread": 0,//首選展開運(yùn)算
"prefer-reflect": 0,//首選Reflect的方法
"quotes": [1, "single"],//引號(hào)類型 `` ""''
"quote-props":[2, "always"],//對(duì)象字面量中的屬性名是否強(qiáng)制雙引號(hào)
"radix": 2,//parseInt必須指定第二個(gè)參數(shù)
"id-match": 0,//命名檢測(cè)
(推薦)"require-yield": 0,//生成器函數(shù)必須有yield
"semi": [2, "always"],//語(yǔ)句強(qiáng)制分號(hào)結(jié)尾
"semi-spacing": [0, {"before": false, "after": true}],//分號(hào)前后空格
"sort-vars": 0,//變量聲明時(shí)排序
"space-after-keywords": [0, "always"],//關(guān)鍵字后面是否要空一格
"space-before-blocks": [0, "always"],//不以新行開始的塊{前面要不要有空格
"space-before-function-paren": [0, "always"],//函數(shù)定義時(shí)括號(hào)前面要不要有空格
"space-in-parens": [0, "never"],//小括號(hào)里面要不要有空格
"space-infix-ops": 0,//中綴操作符周圍要不要有空格
"space-return-throw-case": 2,//return throwcase后面要不要加空格
"space-unary-ops": [0, { "words": true, "nonwords": false }],//一元運(yùn)算符的前/后要不要加空格
"spaced-comment": 0,//注釋風(fēng)格要不要有空格什么的
"strict": 2,//使用嚴(yán)格模式
(推薦)"use-isnan": 2,//禁止比較時(shí)使用NaN，只能用isNaN()
"valid-jsdoc": 0,//jsdoc規(guī)則
(推薦)"valid-typeof": 2,//必須使用合法的typeof的值
"vars-on-top": 2,//var必須放在作用域頂部
"wrap-iife": [2, "inside"],//立即執(zhí)行函數(shù)表達(dá)式的小括號(hào)風(fēng)格
"wrap-regex": 0,//正則表達(dá)式字面量用小括號(hào)包起來(lái)
"yoda": [2, "never"]//禁止尤達(dá)條件

三、代碼示例具體規(guī)則可以自己定義，也可以使用別人配置好的。比如airbnb使用的規(guī)則
https://www.npmjs.com/package/eslint-config-airbnb。
目前我們項(xiàng)目中引入的是推薦規(guī)則。
module.exports = {
"extends": ["eslint:recommended","angular"],
"rules": {
// 額外規(guī)則
"indent": ["error", 4],
"linebreak-style": ["error", "unix"],
"quotes": ["error", "double"],
"semi": ["error", "always"],
//覆蓋已有規(guī)則
"comma-dangle": ["error", "always"],
"no-cond-assign": ["error", "always"],
// 禁用已有規(guī)則
"no-console": "off",
}
}

四、代碼自動(dòng)格式化eslint –fix:用該命令可依照ESLint的配置來(lái)格式化代碼，你怎么定義代碼規(guī)范的，他就怎么格式化。主要是對(duì)一些空格和空白的格式化。
eslint test.js --fix
能夠進(jìn)行自動(dòng)格式化的規(guī)則，在官方文檔中標(biāo)注為 ，這里將能夠自動(dòng)格式化的全部總結(jié)如下：
no-extra-parens禁止不必要的括號(hào)
no-extra-semi禁止不必要的分號(hào)
no-regex-spaces禁止正則表達(dá)式字面量中出現(xiàn)多個(gè)空格
no-unsafe-negation disallow negating the left operand ofrelational operators
curly強(qiáng)制所有控制語(yǔ)句使用一致的括號(hào)風(fēng)格
dot-location強(qiáng)制在點(diǎn)號(hào)之前和之后一致的換行
dot-notation強(qiáng)制盡可能地使用點(diǎn)號(hào)
no-extra-bind 禁止不必要的 .bind() 調(diào)用
no-floating-decimal禁止數(shù)字字面量中使用前導(dǎo)和末尾小數(shù)點(diǎn)
no-implicit-coercion禁止使用短符號(hào)進(jìn)行類型轉(zhuǎn)換
no-multi-spaces禁止使用多個(gè)空格
no-useless-return disallow redundant return statements
wrap-iife要求 IIFE 使用括號(hào)括起來(lái)
yoda要求或禁止 “Yoda” 條件
strict要求或禁止使用嚴(yán)格模式指令
no-undef-init禁止將變量初始化為 undefined
array-bracket-spacing強(qiáng)制數(shù)組方括號(hào)中使用一致的空格
block-spacing強(qiáng)制在單行代碼塊中使用一致的空格
brace-style強(qiáng)制在代碼塊中使用一致的大括號(hào)風(fēng)格
comma-dangle要求或禁止末尾逗號(hào)
comma-spacing強(qiáng)制在逗號(hào)前后使用一致的空格
comma-style強(qiáng)制使用一致的逗號(hào)風(fēng)格
computed-property-spacing強(qiáng)制在計(jì)算的屬性的方括號(hào)中使用一致的空格
eol-last要求或禁止文件末尾存在空行
func-call-spacing //require or disallow spacing betweenfunction identifiers and their invocations
indent強(qiáng)制使用一致的縮進(jìn)
jsx-quotes強(qiáng)制在JSX 屬性中一致地使用雙引號(hào)或單引號(hào)
key-spacing強(qiáng)制在對(duì)象字面量的屬性中鍵和值之間使用一致的間距
keyword-spacing強(qiáng)制在關(guān)鍵字前后使用一致的空格
linebreak-style強(qiáng)制使用一致的換行風(fēng)格
lines-around-comment要求在注釋周圍有空行
lines-around-directive //require or disallow newlinesaround directives
new-parens要求調(diào)用無(wú)參構(gòu)造函數(shù)時(shí)有圓括號(hào)
newline-after-var要求或禁止變量聲明語(yǔ)句后有一行空行
newline-before-return要求 return 語(yǔ)句之前有一空行
no-lonely-if禁止if 作為唯一的語(yǔ)句出現(xiàn)在 else 語(yǔ)句中
no-multiple-empty-lines禁止出現(xiàn)多行空行
no-trailing-spaces禁用行尾空格
no-whitespace-before-property禁止屬性前有空白
object-curly-newline強(qiáng)制大括號(hào)內(nèi)換行符的一致性
object-curly-spacing強(qiáng)制在大括號(hào)中使用一致的空格
one-var-declaration-per-line要求或禁止在變量聲明周圍換行
padded-blocks要求或禁止塊內(nèi)填充
quote-props要求對(duì)象字面量屬性名稱用引號(hào)括起來(lái)
quotes強(qiáng)制使用一致的反勾號(hào)、雙引號(hào)或單引號(hào)
semi-spacing強(qiáng)制分號(hào)之前和之后使用一致的空格
semi要求或禁止使用分號(hào)而不是 ASI
space-before-blocks強(qiáng)制在塊之前使用一致的空格
space-before-function-paren強(qiáng)制在 function的左括號(hào)之前使用一致的空格
space-in-parens強(qiáng)制在圓括號(hào)內(nèi)使用一致的空格
space-infix-ops要求操作符周圍有空格
space-unary-ops強(qiáng)制在一元操作符前后使用一致的空格
spaced-comment強(qiáng)制在注釋中 // 或 /* 使用一致的空格
unicode-bom要求或禁止 Unicode 字節(jié)順序標(biāo)記 (BOM)
wrap-regex要求正則表達(dá)式被括號(hào)括起來(lái)
arrow-body-style要求箭頭函數(shù)體使用大括號(hào)
arrow-parens要求箭頭函數(shù)的參數(shù)使用圓括號(hào)
arrow-spacing強(qiáng)制箭頭函數(shù)的箭頭前后使用一致的空格
generator-star-spacing強(qiáng)制 generator 函數(shù)中 * 號(hào)周圍使用一致的空格
no-useless-computed-key //disallow unnecessary computedproperty keys in object literals
no-useless-rename //disallow renaming import, export, anddestructured assignments to the same name
no-var要求使用let 或 const 而不是 var
object-shorthand要求或禁止對(duì)象字面量中方法和屬性使用簡(jiǎn)寫語(yǔ)法
prefer-arrow-callback要求使用箭頭函數(shù)作為回調(diào)
prefer-const要求使用const 聲明那些聲明后不再被修改的變量
prefer-numeric-literals //disallow parseInt() in favor ofbinary, octal, and hexadecimal literals
prefer-spread要求使用擴(kuò)展運(yùn)算符而非 .apply()
prefer-template要求使用模板字面量而非字符串連接
rest-spread-spacing //enforce spacing between rest andspread operators and their expressions
template-curly-spacing要求或禁止模板字符串中的嵌入表達(dá)式周圍空格的使用
yield-star-spacing強(qiáng)制在 yield* 表達(dá)式中 * 周圍使用空格
五、生成代碼規(guī)范檢測(cè)報(bào)告可生成各種格式的報(bào)告，也可同時(shí)生成多種格式的報(bào)告.html、markdown等格式。自己比較喜歡的插件,美化命令行輸出的插件eslint-friendly-formatter、eslint-formatter-pretty，支持Markdown格式的插件eslint-formatter-markdown

just make sure you pass the path tothe module to the format option of eslint

eslint.js --format './node_modules/eslint-friendly-formatter/index.js' index.js test/-c './eslint.json'

具體使用文檔參考：
https://npm.taobao.org/package/eslint-friendly-formatter

六、結(jié)合Git Hook來(lái)實(shí)現(xiàn)代碼檢測(cè)不通過(guò)則不允許提交https://github.com/brigade/overcommit