eslint/symbol-description Pedantic

要求符号描述。

Symbol 函数可以带有可选的描述。

var foo = Symbol("some description");

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

使用 description 可以更轻松地调试：当输出一个 symbol 时，会使用该描述：

var foo = Symbol("some description");

console.log(foo);
// 输出 - Symbol(some description)

以下是此规则的错误代码示例：

javascript

var foo = Symbol();

以下是此规则的正确代码示例：

javascript

var foo = Symbol("some description");

如何使用

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

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

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "symbol-description": "error",
  },
});

bash

oxlint --deny symbol-description

此规则在 v0.4.0 中添加。