- コードコメントを使って一部のみを警告対象から除外する方法です
パターン1:「この行だけ!このルールだけ!特別扱いして無視したい!」
記法
ある特定のルールを 特定の箇所のみで許容したいときは
許容したい行の直前にこのフォーマットでコメントを書くと、[rule-name]
に記載したルールだけが無視されます。
// eslint-disable-next-line [rule-name]
例えば
ESLintには==
での比較を禁止し、===
を使うよう促すルール「eqeqeq」というものがあります。
eqeqeqルールを有効にしている場合、以下のコードでは2箇所で警告が出ます。
javascript.js
const target = 1;
if ('2' == target) { //だめ
return;
} else if ('3' == target) { //だめ
return;
}
ここにeslint-disable-next-line
のコメントをつけると
javascript.js
const target = 1;
if ('2' == target) {
return;
// eslint-disable-next-line eqeqeq
} else if ('3' == target) {
return;
}
5行目の'3' == target
は無視されます。
パターン2:「このファイル全体的に、このルール無視したい!」
記法
このフォーマットでコメントを書くと、[rule-name]
に記載したルールだけが無視されます。
0
はoffを意味します。
ファイル内のどこに書いても、全行に適用されます。
/* eslint [rule-name]: 0 */
例えば
こうすると2箇所とも無視されます。
javascript.js
/* eslint eqeqeq: 0 */
const target = 1;
if ('2' == target) {
return;
} else if ('3' == target) {
return;
}