10000 docs: clarify that boolean is still allowed for rule `meta.deprecated… · eslint/eslint@4112fd0 · GitHub
[go: up one dir, main page]
Skip to content

Commit 4112fd0

Browse files
bmishbmish
authored
docs: clarify that boolean is still allowed for rule meta.deprecated (#19866)
docs: clarify that boolean is still allowed for rule meta.deprecated
1 parent edf232b commit 4112fd0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

‎docs/src/extend/rule-deprecation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Rule Deprecation
33
---
44

55
The rule deprecation metadata describes whether a rule is deprecated and how the rule can be replaced if there is a replacement.
6-
The legacy format used the two top-level [rule meta](./custom-rules#rule-structure) properties `deprecated: true` and `replacedBy`.
7-
In the new format `deprecated` is an object of type `DeprecatedInfo` and `replacedBy` should be defined inside `deprecated` instead of the top-level.
6+
The legacy format used the two top-level [rule meta](./custom-rules#rule-structure) properties `deprecated` (as a boolean only) and `replacedBy`.
7+
In the new format, `deprecated` is a boolean or an object of type `DeprecatedInfo`, and `replacedBy` should be defined inside `deprecated` instead of at the top-level.
88

99
## ◆ DeprecatedInfo type
1010

0 commit comments

Comments
 (0)
0