Skip to content

Commit c9e8510

Browse files
fasttimefasttime
authored
docs: generate deprecation notice in TSDoc comments from rule metadata (#19461)
* docs: generate deprecation notice in TSDoc comments from rule metadata * move all rule types to one file * rename to `rules.d.ts` * revert accidental change
1 parent 2f386ad commit c9e8510

16 files changed

Lines changed: 5278 additions & 5351 deletions

‎Makefile.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ function generateRelease({ prereleaseId, packageTag }) {
375375
updateRuleTypeHeaders();
376376

377377
echo("Updating commit with docs data and rule types");
378-
exec("git add lib/types/rules/ docs/ && git commit --amend --no-edit");
378+
exec("git add lib/types/rules.d.ts docs/ && git commit --amend --no-edit");
379379
exec(`git tag -a -f v${releaseInfo.version} -m ${releaseInfo.version}`);
380380
}
381381

‎docs/src/_data/rules_meta.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2531,7 +2531,7 @@
25312531
"url": "https://eslint.org/docs/latest/rules/no-native-reassign"
25322532
},
25332533
"deprecated": {
2534-
"message": "Renamed rule",
2534+
"message": "Renamed rule.",
25352535
"url": "https://eslint.org/blog/2016/08/eslint-v3.3.0-released/#deprecated-rules",
25362536
"deprecatedSince": "3.3.0",
25372537
"availableUntil": null,
@@ -2562,7 +2562,7 @@
25622562
"url": "https://eslint.org/docs/latest/rules/no-negated-in-lhs"
25632563
},
25642564
"deprecated": {
2565-
"message": "Renamed rule",
2565+
"message": "Renamed rule.",
25662566
"url": "https://eslint.org/blog/2016/08/eslint-v3.3.0-released/#deprecated-rules",
25672567
"deprecatedSince": "3.3.0",
25682568
"availableUntil": null,

‎lib/rules/no-native-reassign.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module.exports = {
2222
},
2323

2424
deprecated: {
25-
message: "Renamed rule",
25+
message: "Renamed rule.",
2626
url: "https://eslint.org/blog/2016/08/eslint-v3.3.0-released/#deprecated-rules",
2727
deprecatedSince: "3.3.0",
2828
availableUntil: null,

‎lib/rules/no-negated-in-lhs.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module.exports = {
2222
},
2323

2424
deprecated: {
25-
message: "Renamed rule",
25+
message: "Renamed rule.",
2626
url: "https://eslint.org/blog/2016/08/eslint-v3.3.0-released/#deprecated-rules",
2727
deprecatedSince: "3.3.0",
2828
availableUntil: null,

0 commit comments

Comments
 (0)