eslint/no-warning-comments Pedantic

何をするか

コード内に TODO、FIXME、XXX のような警告コメントを禁止します。

なぜ問題なのか

開発者はしばしば未完了の作業や注意が必要な箇所を示すために TODO や FIXME のようなコメントを追加します。開発中には役立ちますが、これらのコメントは本番環境に投入してはいけない未完了のコードを示している可能性があります。このルールにより、このようなコメントが本番コードに含まれる前に検出できます。

例

このルールに対して誤りなコードの例：

javascript

// TODO: これの機能を実装する
function doSomething() {}

// FIXME: これは壊れている
const x = 1;

/* XXX: ハッキング */
let y = 2;

このルールに対して正しいコードの例：

javascript

// これは通常のコメントです
function doSomething() {}

// メモ: これについて説明します
const x = 1;

オプション

このルールは以下のデフォルト値を持つオプションオブジェクトを持ちます：

json

{
  "terms": ["todo", "fixme", "xxx"],
  "location": "start",
  "decoration": []
}

`terms`

一致させる用語の配列。一致判定は大文字小文字を無視します。

`location`

用語のチェック場所：

"start"（デフォルト）：用語はコメントの先頭に出現しなければならない（任意の装飾の後に）
"anywhere"：用語はコメント内のどこにでも出現してもよい

`decoration`

location が "start" である場合、コメントの先頭で無視する文字の配列。特に JSDoc 形式のコメントにおける * のような一般的なコメント装飾を無視するのに有用です。

使用方法

設定ファイルまたは CLI でこのルールを有効化するには、次のように使用できます：

Config (.oxlintrc.json)CLI

json

{
  "rules": {
    "no-warning-comments": "error"
  }
}

bash

oxlint --deny no-warning-comments

参照

ルールのソース

何をするか ​

なぜ問題なのか ​

例 ​

オプション ​

terms ​

location ​

decoration ​

使用方法 ​

参照 ​