← Back to rules

eslint/symbol-description 严谨

它做了什么

要求为 Symbol 提供描述。

为什么这是不好的？

Symbol 函数可以接受一个可选的描述参数。

var foo = Symbol("一些描述");

var someString = "一些描述";
var bar = Symbol(someString);

使用 description 可以提升调试体验：当符号被打印时，会显示其描述信息：

var foo = Symbol("一些描述");

console.log(foo);
// 输出 - Symbol(一些描述)

示例

此规则的错误代码示例：

var foo = Symbol();

此规则的正确代码示例：

var foo = Symbol("一些描述");

如何使用

要通过配置文件或 CLI 启用此规则，可以使用：

配置 (.oxlintrc.json)

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

CLI

oxlint --deny symbol-description

参考资料

• 规则源码