針對單個 js 文件禁用 ESLint 語法校驗

在代碼頂部添加一行注釋

/* eslint-disable */

ESLint 在校驗的時候就會跳過后面的代碼

 

還可以在注釋后加入詳細規則，這樣就能避開指定的校驗規則了

/* eslint-disable no-new */

以下是摘抄的詳細內容

 

1.安裝

1.1本地安裝(運用到此項目)

$ npm install eslint --save-dev

1.2全局安裝（運用到所有項目）

$ npm install -g eslint

2.配置

2.1使用 .eslintrc 文件

$ eslint --init

2.2在 package.json 中添加 eslintConfig配置塊

2.3直接在代碼文件中定義

2.3.1 禁用 ESLint：

/* eslint-disable */
var a = 100;
console.log(a);  
/* eslint-enable */

2.3.2 禁用一條規則：

/*eslint-disable no-console */
var a = 100;
console.log(a);
/*eslint-enable no-console */

2.3.3 調整規則：

/* eslint no-console:0 */
var a = 100;
console.log(a);

3.錯誤級別

“off” or 0 - 關閉(禁用)規則
“warn” or 1 - 將規則視為一個警告（並不會導致檢查不通過）
“error” or 2 - 將規則視為一個錯誤 (退出碼為1，檢查不通過)
有些規則還帶有可選的參數。

4.常用規則
類別 描述
Possible Errors 可能的錯誤或邏輯錯誤
no-cond-assign 禁止條件表達式中出現模棱兩可的賦值操作符
no-console 禁用console
no-constant-condition 禁止在條件中使用常量表達式
no-debugger 禁用 debugger
no-dupe-args 禁止 function 定義中出現重名參數
no-dupe-keys 禁止對象字面量中出現重復的 key
no-duplicate-case 禁止出現重復的 case 標簽
no-empty 禁止出現空語句塊
no-ex-assign 禁止對 catch 子句的參數重新賦值
no-extra-boolean-cast 禁止不必要的布爾轉換
no-extra-parens 禁止不必要的括號
no-extra-semi 禁止不必要的分號
no-func-assign 禁止對 function 聲明重新賦值
no-inner-declarations 禁止在嵌套的塊中出現變量聲明或 function 聲明
no-irregular-whitespace 禁止在字符串和注釋之外不規則的空白
no-obj-calls 禁止把全局對象作為函數調用
no-sparse-arrays 禁用稀疏數組
no-prototype-builtins 禁止直接使用Object.prototypes 的內置屬性
no-unexpected-multiline 禁止出現令人困惑的多行表達式
no-unreachable 禁止在return、throw、continue 和 break語句之后出現不可達代碼
use-isnan 要求使用 isNaN() 檢查 NaN
valid-typeof 強制 typeof 表達式與有效的字符串進行比較
—– —–
Best Practices 最佳實踐
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-case-declarations 不允許在 case 子句中使用詞法聲明
no-else-return 禁止 if 語句中有 return 之后有 else
no-empty-function 禁止出現空函數
no-eq-null 禁止在沒有類型檢查操作符的情況下與 null 進行比較
no-eval 禁用 eval()
no-extra-bind 禁止不必要的 .bind() 調用
no-fallthrough 禁止 case 語句落空
no-floating-decimal 禁止數字字面量中使用前導和末尾小數點
no-implicit-coercion 禁止使用短符號進行類型轉換
no-implicit-globals 禁止在全局范圍內使用 var 和命名的 function 聲明
no-invalid-this: 禁止 this 關鍵字出現在類和類對象之外
no-lone-blocks 禁用不必要的嵌套塊
no-loop-func 禁止在循環中出現 function 聲明和表達式
no-magic-numbers 禁用魔術數字
no-multi-spaces 禁止使用多個空格
no-multi-str 禁止使用多行字符串
no-new 禁止在非賦值或條件語句中使用 new 操作符
no-new-func 禁止對 Function 對象使用 new 操作符
no-new-wrappers 禁止對 String，Number 和 Boolean 使用 new 操作符
no-param-reassign 不允許對 function 的參數進行重新賦值
no-redeclare 禁止使用 var 多次聲明同一變量
no-return-assign 禁止在 return 語句中使用賦值語句
no-script-url 禁止使用 javascript: url
no-self-assign 禁止自我賦值
no-self-compare 禁止自身比較
no-sequences 禁用逗號操作符
no-unmodified-loop-condition 禁用一成不變的循環條件
no-unused-expressions 禁止出現未使用過的表達式
no-useless-call 禁止不必要的 .call() 和 .apply()
no-useless-concat 禁止不必要的字符串字面量或模板字面量的連接
vars-on-top 要求所有的 var 聲明出現在它們所在的作用域頂部
—– —–
Strict Mode 使用嚴格模式和嚴格模式指
strict 要求或禁止使用嚴格模式指令
—– —–
Variables 變量聲明
init-declarations 要求或禁止 var 聲明中的初始化
no-catch-shadow 不允許 catch 子句的參數與外層作用域中的變量同名
no-restricted-globals 禁用特定的全局變量
no-shadow 禁止 var 聲明 與外層作用域的變量同名
no-undef 禁用未聲明的變量，除非它們在 /global / 注釋中被提到
no-undef-init 禁止將變量初始化為 undefined
no-unused-vars 禁止出現未使用過的變量
no-use-before-define 不允許在變量定義之前使用它們
—– —–
Nodejs and CommonJS Node.js,CommonJS
global-require 要求 require() 出現在頂層模塊作用域中
handle-callback-err 要求回調函數中有容錯處理
no-mixed-requires 禁止混合常規 var 聲明和 require 調用
no-new-require 禁止調用 require 時使用 new 操作符
no-path-concat 禁止對 dirname 和 filename進行字符串連接
no-restricted-modules 禁用指定的通過 require 加載的模塊
—– —–
Stylistic Issues 風格指南
array-bracket-spacing 強制數組方括號中使用一致的空格
block-spacing 強制在單行代碼塊中使用一致的空格
brace-style 強制在代碼塊中使用一致的大括號風格
camelcase 強制使用駱駝拼寫法命名約定
comma-spacing 強制在逗號前后使用一致的空格
comma-style 強制使用一致的逗號風格
computed-property-spacing 強制在計算的屬性的方括號中使用一致的空格
eol-last 強制文件末尾至少保留一行空行
func-names 強制使用命名的 function 表達式
func-style 強制一致地使用函數聲明或函數表達式
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-continue 禁用 continue 語句
no-inline-comments 禁止在代碼行后使用內聯注釋
no-lonely-if 禁止 if 作為唯一的語句出現在 else 語句中
no-mixed-spaces-and-tabs 不允許空格和 tab 混合縮進
no-multiple-empty-lines 不允許多個空行
no-negated-condition 不允許否定的表達式
no-plusplus 禁止使用一元操作符 ++ 和 –
no-spaced-func 禁止 function 標識符和括號之間出現空格
no-ternary 不允許使用三元操作符
no-trailing-spaces 禁用行尾空格
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 強制操作符使用一致的換行符
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 強制在注釋中 // 或 /* 使用一致的空格

5.實際項目中使用（Gulp中使用）

5.1 安裝插件

$ npm install gulp-eslint

5.2 應用

var gulp = require('gulp');
var eslint = require('gulp-eslint');
gulp.task('lint',function(){
    return gulp.src(['app/**/*.js']) //指定的校驗路徑
        .pipe(eslint({configFle:"./.eslintrc"})) //使用你的eslint校驗文件
        .pipe(eslint.format())
});

輸入命令行

$ gulp lint

就可以直接運行了相應的配置文件來校驗文件了。

5.3 忽視

你可以通過在項目根目錄創建一個 .eslintignore 文件告訴 ESLint 去忽略特定的文件和目錄。.eslintignore 文件是一個純文本文件，其中的每一行都是一個 glob 模式表明哪些路徑應該忽略檢測。例如，以下將忽略所有的 JavaScript 文件：

**/*.js 當 ESLint 運行時，在確定哪些文件要檢測之前，它會在當前工作目錄中查找一個 .eslintignore 文件。如果發現了這個文件，當遍歷目錄時，將會應用這些偏好設置。一次只有一個 .eslintignore 文件會被使用，所以，不是當前工作目錄下的 .eslintignore 文件將不會被用到。 Globs 匹配使用 node-ignore，所以大量可用的特性有：

以 # 開頭的行被當作注釋，不影響忽略模式。
路徑是相對於 .eslintignore 的位置或當前工作目錄。這也會影響通過 –ignore-pattern傳遞的路徑。
忽略模式同 .gitignore 規范
以 ! 開頭的行是否定模式，它將會重新包含一個之前被忽略的模式。

除了 .eslintignore 文件中的模式，ESLint總是忽略 /node_modules/ 和 /bower_components/ 中的文件。

例如：把下面 .eslintignore 文件放到當前工作目錄里，將忽略 node_modules，bower_components 和所有以 .ts.js 或者 .coffee.js 為擴展名的文件以及 build/ 目錄下除了 build/index.js 的所有文件。

/node_modules/ and /bower_components/ ignored by default

Ignore built files except build/index.js

build/*
!build/index.js

如果相比於當前工作目錄下 .eslintignore 文件，你更想使用一個不同的文件，你可以在命令行使用 –ignore-path 選項指定它。例如，你可以使用 .jshintignore 文件，因為它有相同的格式：

eslint –ignore-path .jshintignore file.js

你也可以使用你的 .gitignore 文件：

eslint –ignore-path .gitignore file.js

任何文件只要滿足標准忽略文件格式都可以用。記住，指定 –ignore-path 意味着任何現有的 .eslintignore 文件將不被使用。請注意，.eslintignore 中的匹配規則比 .gitignore 中的更嚴格。

使用到，記錄一下