Add link to typed linting in generated docs

bmish · Feb 3, 2024 · 20e1743 · 20e1743
1 parent d86b890
commit 20e1743
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 7 deletions.
diff --git a/docs/examples/eslint-plugin-test/README.md b/docs/examples/eslint-plugin-test/README.md
@@ -27,7 +27,7 @@ This plugin is for x purpose.
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
 ⚙️ Has configuration options.\
-💭 Requires type information.\
+💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).\
 🗂️ The type of rule.\
 ❗ Identifies problems that could cause errors or unexpected behavior.\
 📖 Identifies potential improvements.\

diff --git a/docs/examples/eslint-plugin-test/docs/rules/no-foo.md b/docs/examples/eslint-plugin-test/docs/rules/no-foo.md
@@ -6,7 +6,7 @@
 
 ⚙️ This rule is configurable.
 
-💭 This rule requires type information.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 ❗ This rule identifies problems that could cause errors or unexpected behavior.
 

diff --git a/docs/examples/eslint-plugin-test/docs/rules/prefer-bar.md b/docs/examples/eslint-plugin-test/docs/rules/prefer-bar.md
@@ -4,7 +4,7 @@
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
-💭 This rule requires type information.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 📖 This rule identifies potential improvements.
 

diff --git a/lib/rule-doc-notices.ts b/lib/rule-doc-notices.ts
@@ -253,7 +253,7 @@ const RULE_NOTICES: {
   [NOTICE_TYPE.HAS_SUGGESTIONS]: NOTICE_HAS_SUGGESTIONS,
 
   [NOTICE_TYPE.OPTIONS]: `${EMOJI_OPTIONS} This rule is configurable.`,
-  [NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} This rule requires type information.`,
+  [NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).`,
 };
 
 /**

diff --git a/lib/rule-list-legend.ts b/lib/rule-list-legend.ts
@@ -144,7 +144,7 @@ const LEGENDS: {
   [COLUMN_TYPE.NAME]: undefined,
   [COLUMN_TYPE.OPTIONS]: [`${EMOJI_OPTIONS} Has configuration options.`],
   [COLUMN_TYPE.REQUIRES_TYPE_CHECKING]: [
-    `${EMOJI_REQUIRES_TYPE_CHECKING} Requires type information.`,
+    `${EMOJI_REQUIRES_TYPE_CHECKING} Requires [type information](https://typescript-eslint.io/linting/typed-linting).`,
   ],
 };
 

diff --git a/test/lib/generate/__snapshots__/option-rule-list-columns-test.ts.snap b/test/lib/generate/__snapshots__/option-rule-list-columns-test.ts.snap
@@ -48,7 +48,7 @@ exports[`generate (--rule-list-columns) shows column and notice for requiresType
 
 💼 Configurations enabled in.\\
 🌐 Set in the \`all\` configuration.\\
-💭 Requires type information.
+💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 | Name                           | Description            | 💼 | 💭 |
 | :----------------------------- | :--------------------- | :- | :- |
@@ -70,7 +70,7 @@ exports[`generate (--rule-list-columns) shows column and notice for requiresType
 exports[`generate (--rule-list-columns) shows column and notice for requiresTypeChecking updates the documentation 3`] = `
 "# Description of no-bar (\`test/no-bar\`)
 
-💭 This rule requires type information.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
 "