Skip to content

Commit e669f76

Browse files
Add link to typed linting in generated docs (#516)
1 parent d86b890 commit e669f76

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

docs/examples/eslint-plugin-test/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This plugin is for x purpose.
2727
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
2828
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
2929
⚙️ Has configuration options.\
30-
💭 Requires type information.\
30+
💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).\
3131
🗂️ The type of rule.\
3232
❗ Identifies problems that could cause errors or unexpected behavior.\
3333
📖 Identifies potential improvements.\

docs/examples/eslint-plugin-test/docs/rules/no-foo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
⚙️ This rule is configurable.
88

9-
💭 This rule requires type information.
9+
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
1010

1111
❗ This rule identifies problems that could cause errors or unexpected behavior.
1212

docs/examples/eslint-plugin-test/docs/rules/prefer-bar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
66

7-
💭 This rule requires type information.
7+
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
88

99
📖 This rule identifies potential improvements.
1010

lib/rule-doc-notices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ const RULE_NOTICES: {
253253
[NOTICE_TYPE.HAS_SUGGESTIONS]: NOTICE_HAS_SUGGESTIONS,
254254

255255
[NOTICE_TYPE.OPTIONS]: `${EMOJI_OPTIONS} This rule is configurable.`,
256-
[NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} This rule requires type information.`,
256+
[NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).`,
257257
};
258258

259259
/**

lib/rule-list-legend.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ const LEGENDS: {
144144
[COLUMN_TYPE.NAME]: undefined,
145145
[COLUMN_TYPE.OPTIONS]: [`${EMOJI_OPTIONS} Has configuration options.`],
146146
[COLUMN_TYPE.REQUIRES_TYPE_CHECKING]: [
147-
`${EMOJI_REQUIRES_TYPE_CHECKING} Requires type information.`,
147+
`${EMOJI_REQUIRES_TYPE_CHECKING} Requires [type information](https://typescript-eslint.io/linting/typed-linting).`,
148148
],
149149
};
150150

test/lib/generate/__snapshots__/option-rule-list-columns-test.ts.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ exports[`generate (--rule-list-columns) shows column and notice for requiresType
4848
4949
💼 Configurations enabled in.\\
5050
🌐 Set in the \`all\` configuration.\\
51-
💭 Requires type information.
51+
💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).
5252
5353
| Name | Description | 💼 | 💭 |
5454
| :----------------------------- | :--------------------- | :- | :- |
@@ -70,7 +70,7 @@ exports[`generate (--rule-list-columns) shows column and notice for requiresType
7070
exports[`generate (--rule-list-columns) shows column and notice for requiresTypeChecking updates the documentation 3`] = `
7171
"# Description of no-bar (\`test/no-bar\`)
7272
73-
💭 This rule requires type information.
73+
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
7474
7575
<!-- end auto-generated rule header -->
7676
"

0 commit comments

Comments
 (0)