← Back to rules

eslint/symbol-description 厳格

何をするか

シンボルの説明を必須にする。

なぜ悪いのか

Symbol 関数には任意の説明を指定できる。

var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);

description を使用することで、デバッグがしやすくなる：シンボルをログ出力した際に、説明が利用される。

var foo = Symbol("some description");

console.log(foo);
// 出力結果 - Symbol(some description)

例

このルールに対して 誤った コードの例：

var foo = Symbol();

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

var foo = Symbol("some description");

使い方

設定ファイルまたは CLI でこのルールを 有効化 するには、以下のようにする。

Config (.oxlintrc.json)

{
  "rules": {
    "symbol-description": "error"
  }
}

CLI

oxlint --deny symbol-description

参照

• ルールのソース