规则弃用
规则弃用元数据描述了规则是否已弃用,以及在有替代方案时如何替换该规则。旧格式使用两个顶层 规则元数据 属性 deprecated: true
和 replacedBy
。在新格式中,deprecated
是 DeprecatedInfo
类型的对象,replacedBy
应该在 deprecated
内部定义,而不是顶层。
◆ DeprecatedInfo 类型
此类型表示有关规则弃用的一般信息。每个属性都是可选的。
message
(string
)
可向用户展示的一般消息。可能包含此规则被弃用的原因或如何替换该规则。url
(string
)
包含有关此规则弃用更多信息的 URL。replacedBy
(ReplacedByInfo[]
)
有关规则可用替代方案的信息。这可能是一个空数组,明确声明没有替代方案。deprecatedSince
(string
)
Semver 弃用该规则的版本。availableUntil
(string | null
)
Semver 可能删除该规则的版本,例如下一个主要版本。特殊值null
表示该规则将不再更改,但将保持可用。
◆ ReplacedByInfo 类型
该类型描述了规则的单个可能替代方案。每个属性都是可选的。
message
(string
)
有关此规则替代方案的一般消息,例如url
(string
)
包含有关此规则替代方案更多信息的 URL。plugin
(ExternalSpecifier
)
指定哪个插件具有替代规则。名称应该是包名,如果替代方案是 ESLint 核心规则,则应为“eslint”。如果替代方案在同一插件中,则应省略此属性。rule
(ExternalSpecifier
)
指定替代规则。如果插件仅包含单个规则或具有与该规则相同的名称,则可以省略。
◆ ExternalSpecifier 类型
此类型表示外部资源。每个属性都是可选的。
name
(string
)plugin
的包名和rule
的规则 ID。url
(string
)
指向插件/规则文档的 URL…