Skip to content

Commit 2b12bea

Browse files
ntnyqntnyq
authored
feat: add meta.docs.url to all rules (#341)
1 parent abb2404 commit 2b12bea

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+111
-0
lines changed

‎packages/eslint-plugin/lib/rules/attrs-newline.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
const { RULE_CATEGORY } = require("../constants");
1616
const { createVisitors } = require("./utils/visitors");
17+
const { getRuleUrl } = require("./utils/rule");
1718

1819
/**
1920
* @type {MessageId}
@@ -34,6 +35,7 @@ module.exports = {
3435
description: "Enforce newline between attributes",
3536
category: RULE_CATEGORY.STYLE,
3637
recommended: true,
38+
url: getRuleUrl("attrs-newline"),
3739
},
3840

3941
fixable: true,

‎packages/eslint-plugin/lib/rules/element-newline.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ const {
2929
isStyle,
3030
} = require("./utils/node");
3131
const { createVisitors } = require("./utils/visitors");
32+
const { getRuleUrl } = require("./utils/rule");
33+
3234
const MESSAGE_IDS = {
3335
EXPECT_NEW_LINE_AFTER: "expectAfter",
3436
};
@@ -84,6 +86,7 @@ module.exports = {
8486
description: "Enforce newline between elements.",
8587
category: RULE_CATEGORY.STYLE,
8688
recommended: true,
89+
url: getRuleUrl("element-newline"),
8790
},
8891

8992
fixable: true,

‎packages/eslint-plugin/lib/rules/id-naming-convention.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ const {
2020
} = require("./utils/naming");
2121
const { findAttr, isAttributesEmpty, hasTemplate } = require("./utils/node");
2222
const { createVisitors } = require("./utils/visitors");
23+
const { getRuleUrl } = require("./utils/rule");
2324

2425
const MESSAGE_IDS = {
2526
WRONG: "wrong",
@@ -51,6 +52,7 @@ module.exports = {
5152
description: "Enforce consistent naming id attributes",
5253
category: RULE_CATEGORY.STYLE,
5354
recommended: false,
55+
url: getRuleUrl("id-naming-convention"),
5456
},
5557

5658
fixable: null,

‎packages/eslint-plugin/lib/rules/lowercase.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const { RULE_CATEGORY } = require("../constants");
1010
const SVG_CAMEL_CASE_ATTRIBUTES = require("../constants/svg-camel-case-attributes");
1111
const { createVisitors } = require("./utils/visitors");
1212
const { hasTemplate } = require("./utils/node");
13+
const { getRuleUrl } = require("./utils/rule");
1314

1415
const MESSAGE_IDS = {
1516
UNEXPECTED: "unexpected",
@@ -26,6 +27,7 @@ module.exports = {
2627
description: "Enforce to use lowercase for tag and attribute names.",
2728
category: RULE_CATEGORY.STYLE,
2829
recommended: false,
30+
url: getRuleUrl("lowercase"),
2931
},
3032

3133
fixable: "code",

‎packages/eslint-plugin/lib/rules/max-element-depth.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
const { RULE_CATEGORY } = require("../constants");
1212
const { createVisitors } = require("./utils/visitors");
13+
const { getRuleUrl } = require("./utils/rule");
1314

1415
const MESSAGE_IDS = {
1516
MAX_DEPTH_EXCEEDED: "maxDepthExceeded",
@@ -26,6 +27,7 @@ module.exports = {
2627
description: "Enforce element maximum depth",
2728
category: RULE_CATEGORY.STYLE,
2829
recommended: false,
30+
url: getRuleUrl("max-element-depth"),
2931
},
3032

3133
fixable: null,

‎packages/eslint-plugin/lib/rules/no-abstract-roles.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
const { RULE_CATEGORY } = require("../constants");
99
const { findAttr } = require("./utils/node");
1010
const { createVisitors } = require("./utils/visitors");
11+
const { getRuleUrl } = require("./utils/rule");
1112

1213
const MESSAGE_IDS = {
1314
UNEXPECTED: "unexpected",
@@ -39,6 +40,7 @@ module.exports = {
3940
description: "Disallow to use of abstract roles",
4041
category: RULE_CATEGORY.ACCESSIBILITY,
4142
recommended: false,
43+
url: getRuleUrl("no-abstract-roles"),
4244
},
4345

4446
fixable: null,

‎packages/eslint-plugin/lib/rules/no-accesskey-attrs.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
const { RULE_CATEGORY } = require("../constants");
99
const { findAttr } = require("./utils/node");
1010
const { createVisitors } = require("./utils/visitors");
11+
const { getRuleUrl } = require("./utils/rule");
1112

1213
const MESSAGE_IDS = {
1314
UNEXPECTED: "unexpected",
@@ -24,6 +25,7 @@ module.exports = {
2425
description: "Disallow to use of accesskey attribute",
2526
category: RULE_CATEGORY.ACCESSIBILITY,
2627
recommended: false,
28+
url: getRuleUrl("no-accesskey-attrs"),
2729
},
2830

2931
fixable: null,

‎packages/eslint-plugin/lib/rules/no-aria-hidden-body.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
const { RULE_CATEGORY } = require("../constants");
66
const { findAttr } = require("./utils/node");
77
const { createVisitors } = require("./utils/visitors");
8+
const { getRuleUrl } = require("./utils/rule");
89

910
const MESSAGE_IDS = {
1011
UNEXPECTED: "unexpected",
@@ -22,6 +23,7 @@ module.exports = {
2223
"Disallow to use aria-hidden attributes on the `body` element.",
2324
category: RULE_CATEGORY.ACCESSIBILITY,
2425
recommended: false,
26+
url: getRuleUrl("no-aria-hidden-body"),
2527
},
2628

2729
fixable: null,

‎packages/eslint-plugin/lib/rules/no-duplicate-attrs.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
const { RULE_CATEGORY } = require("../constants");
1111
const { createVisitors } = require("./utils/visitors");
12+
const { getRuleUrl } = require("./utils/rule");
1213

1314
const MESSAGE_IDS = {
1415
DUPLICATE_ATTRS: "duplicateAttrs",
@@ -26,6 +27,7 @@ module.exports = {
2627
description: "Disallow to use duplicate attributes",
2728
category: RULE_CATEGORY.BEST_PRACTICE,
2829
recommended: true,
30+
url: getRuleUrl("no-duplicate-attrs"),
2931
},
3032

3133
fixable: null,

‎packages/eslint-plugin/lib/rules/no-duplicate-class.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
const { NodeTypes } = require("es-html-parser");
1414
const { RULE_CATEGORY } = require("../constants");
1515
const { createVisitors } = require("./utils/visitors");
16+
const { getRuleUrl } = require("./utils/rule");
1617

1718
const MESSAGE_IDS = {
1819
DUPLICATE_CLASS: "duplicateClass",
@@ -28,6 +29,7 @@ module.exports = {
2829
description: "Disallow to use duplicate class",
2930
category: RULE_CATEGORY.BEST_PRACTICE,
3031
recommended: false,
32+
url: getRuleUrl("no-duplicate-class"),
3133
},
3234
fixable: "code",
3335
schema: [],

‎packages/eslint-plugin/lib/rules/no-duplicate-id.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ const {
1414
shouldCheckTemplateLiteral,
1515
} = require("./utils/settings");
1616
const { getSourceCode } = require("./utils/source-code");
17+
const { getRuleUrl } = require("./utils/rule");
1718

1819
const MESSAGE_IDS = {
1920
DUPLICATE_ID: "duplicateId",
@@ -30,6 +31,7 @@ module.exports = {
3031
description: "Disallow to use duplicate id",
3132
category: RULE_CATEGORY.BEST_PRACTICE,
3233
recommended: true,
34+
url: getRuleUrl("no-duplicate-id"),
3335
},
3436

3537
fixable: null,

‎packages/eslint-plugin/lib/rules/no-extra-spacing-attrs.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ const { RULE_CATEGORY } = require("../constants");
2323
const { getLocBetween } = require("./utils/node");
2424
const { getSourceCode } = require("./utils/source-code");
2525
const { createVisitors } = require("./utils/visitors");
26+
const { getRuleUrl } = require("./utils/rule");
2627

2728
const MESSAGE_IDS = {
2829
EXTRA_BETWEEN: "unexpectedBetween",
@@ -49,6 +50,7 @@ module.exports = {
4950
description: "Disallow an extra spacing around attributes",
5051
category: RULE_CATEGORY.STYLE,
5152
recommended: true,
53+
url: getRuleUrl("no-extra-spacing-attrs"),
5254
},
5355

5456
fixable: true,

‎packages/eslint-plugin/lib/rules/no-extra-spacing-text.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const { RULE_CATEGORY } = require("../constants");
1515
const { isTag, isOverlapWithTemplates } = require("./utils/node");
1616
const { getSourceCode } = require("./utils/source-code");
1717
const { createVisitors } = require("./utils/visitors");
18+
const { getRuleUrl } = require("./utils/rule");
1819

1920
const MESSAGE_IDS = {
2021
UNEXPECTED: "unexpected",
@@ -31,6 +32,7 @@ module.exports = {
3132
description: "Disallow unnecessary consecutive spaces",
3233
category: RULE_CATEGORY.BEST_PRACTICE,
3334
recommended: false,
35+
url: getRuleUrl("no-extra-spacing-text"),
3436
},
3537

3638
fixable: true,

‎packages/eslint-plugin/lib/rules/no-heading-inside-button.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
const { RULE_CATEGORY } = require("../constants");
66
const { findParent, isTag } = require("./utils/node");
77
const { createVisitors } = require("./utils/visitors");
8+
const { getRuleUrl } = require("./utils/rule");
9+
810
const MESSAGE_IDS = {
911
UNEXPECTED: "unexpected",
1012
};
@@ -22,6 +24,7 @@ module.exports = {
2224
description: "Disallows the use of heading elements inside <button>.",
2325
category: RULE_CATEGORY.ACCESSIBILITY,
2426
recommended: false,
27+
url: getRuleUrl("no-heading-inside-button"),
2528
},
2629

2730
fixable: null,

‎packages/eslint-plugin/lib/rules/no-inline-styles.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
const { RULE_CATEGORY } = require("../constants");
66
const { findAttr } = require("./utils/node");
77
const { createVisitors } = require("./utils/visitors");
8+
const { getRuleUrl } = require("./utils/rule");
9+
810
const MESSAGE_IDS = {
911
INLINE_STYLE: "unexpectedInlineStyle",
1012
};
@@ -20,6 +22,7 @@ module.exports = {
2022
description: "Disallow using inline style",
2123
category: RULE_CATEGORY.BEST_PRACTICE,
2224
recommended: false,
25+
url: getRuleUrl("no-inline-styles"),
2326
},
2427

2528
fixable: null,

‎packages/eslint-plugin/lib/rules/no-invalid-role.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ const { NodeTypes } = require("es-html-parser");
66
const { RULE_CATEGORY } = require("../constants");
77
const { findAttr } = require("./utils/node");
88
const { createVisitors } = require("./utils/visitors");
9+
const { getRuleUrl } = require("./utils/rule");
10+
911
const MESSAGE_IDS = {
1012
INVALID: "invalid",
1113
INVALID_PRESENTATION: "invalidPresentation",
@@ -235,6 +237,7 @@ module.exports = {
235237
description: "Disallows use of invalid role.",
236238
category: RULE_CATEGORY.ACCESSIBILITY,
237239
recommended: false,
240+
url: getRuleUrl("no-invalid-role"),
238241
},
239242

240243
fixable: null,

‎packages/eslint-plugin/lib/rules/no-multiple-empty-lines.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ const {
2121
isRangesOverlap,
2222
getTemplateTokens,
2323
} = require("./utils/node");
24+
const { getRuleUrl } = require("./utils/rule");
2425

2526
const MESSAGE_IDS = {
2627
UNEXPECTED: "unexpected",
@@ -37,6 +38,7 @@ module.exports = {
3738
description: "Disallow multiple empty lines",
3839
category: RULE_CATEGORY.STYLE,
3940
recommended: false,
41+
url: getRuleUrl("no-multiple-empty-lines"),
4042
},
4143

4244
fixable: "whitespace",

‎packages/eslint-plugin/lib/rules/no-multiple-h1.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
*/
55

66
const { RULE_CATEGORY } = require("../constants");
7+
const { getRuleUrl } = require("./utils/rule");
78

89
const MESSAGE_IDS = {
910
MULTIPLE_H1: "unexpectedMultiH1",
@@ -20,6 +21,7 @@ module.exports = {
2021
description: "Disallow multiple `<h1></h1>`.",
2122
category: RULE_CATEGORY.SEO,
2223
recommended: true,
24+
url: getRuleUrl("no-multiple-h1"),
2325
},
2426

2527
fixable: null,

‎packages/eslint-plugin/lib/rules/no-nested-interactive.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
const { RULE_CATEGORY } = require("../constants");
77
const { findAttr } = require("./utils/node");
88
const { createVisitors } = require("./utils/visitors");
9+
const { getRuleUrl } = require("./utils/rule");
910

1011
const MESSAGE_IDS = {
1112
UNEXPECTED: "unexpected",
@@ -65,6 +66,7 @@ module.exports = {
6566
description: "Disallows nested interactive elements",
6667
category: RULE_CATEGORY.BEST_PRACTICE,
6768
recommended: false,
69+
url: getRuleUrl("no-nested-interactive"),
6870
},
6971

7072
fixable: null,

‎packages/eslint-plugin/lib/rules/no-non-scalable-viewport.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
const { RULE_CATEGORY } = require("../constants");
66
const { findAttr } = require("./utils/node");
7+
const { getRuleUrl } = require("./utils/rule");
78

89
const MESSAGE_IDS = {
910
UNEXPECTED: "unexpected",
@@ -21,6 +22,7 @@ module.exports = {
2122
'Disallow use of `user-scalable=no` in `<meta name="viewport">`.',
2223
category: RULE_CATEGORY.ACCESSIBILITY,
2324
recommended: false,
25+
url: getRuleUrl("no-non-scalable-viewport"),
2426
},
2527

2628
fixable: null,

‎packages/eslint-plugin/lib/rules/no-obsolete-tags.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
const { RULE_CATEGORY, OBSOLETE_TAGS } = require("../constants");
66
const { createVisitors } = require("./utils/visitors");
7+
const { getRuleUrl } = require("./utils/rule");
78

89
const OBSOLETE_TAGS_SET = new Set(OBSOLETE_TAGS);
910

@@ -22,6 +23,7 @@ module.exports = {
2223
description: "Disallow to use obsolete elements in HTML5",
2324
category: RULE_CATEGORY.BEST_PRACTICE,
2425
recommended: true,
26+
url: getRuleUrl("no-obsolete-tags"),
2527
},
2628

2729
fixable: null,

‎packages/eslint-plugin/lib/rules/no-positive-tabindex.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
const { RULE_CATEGORY } = require("../constants");
99
const { findAttr } = require("./utils/node");
1010
const { createVisitors } = require("./utils/visitors");
11+
const { getRuleUrl } = require("./utils/rule");
1112

1213
const MESSAGE_IDS = {
1314
UNEXPECTED: "unexpected",
@@ -24,6 +25,7 @@ module.exports = {
2425
description: "Disallow use of positive `tabindex`.",
2526
category: RULE_CATEGORY.ACCESSIBILITY,
2627
recommended: false,
28+
url: getRuleUrl("no-positive-tabindex"),
2729
},
2830

2931
fixable: null,

‎packages/eslint-plugin/lib/rules/no-restricted-attr-values.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
const { RULE_CATEGORY } = require("../constants");
1111
const { createVisitors } = require("./utils/visitors");
12+
const { getRuleUrl } = require("./utils/rule");
1213

1314
const MESSAGE_IDS = {
1415
RESTRICTED: "restricted",
@@ -25,6 +26,7 @@ module.exports = {
2526
description: "Disallow specified attributes",
2627
category: RULE_CATEGORY.BEST_PRACTICE,
2728
recommended: false,
29+
url: getRuleUrl("no-restricted-attr-values"),
2830
},
2931

3032
fixable: null,

‎packages/eslint-plugin/lib/rules/no-restricted-attrs.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
const { NODE_TYPES } = require("@html-eslint/parser");
1212
const { RULE_CATEGORY } = require("../constants");
1313
const { createVisitors } = require("./utils/visitors");
14+
const { getRuleUrl } = require("./utils/rule");
1415

1516
const MESSAGE_IDS = {
1617
RESTRICTED: "restricted",
@@ -27,6 +28,7 @@ module.exports = {
2728
description: "Disallow specified attributes",
2829
category: RULE_CATEGORY.BEST_PRACTICE,
2930
recommended: false,
31+
url: getRuleUrl("no-restricted-attrs"),
3032
},
3133

3234
fixable: null,

0 commit comments

Comments
 (0)