Merge pull request #126 from bmish/notice-type-info

Author: bmish

lib/rule-notices.ts

@@ -4,6 +4,7 @@ import {
   EMOJI_FIXABLE,
   EMOJI_HAS_SUGGESTIONS,
   EMOJI_CONFIGS,
+  EMOJI_REQUIRES_TYPE_CHECKING,
 } from './emojis.js';
 import { getConfigsForRule } from './configs.js';
 import type {
@@ -22,6 +23,7 @@ enum MESSAGE_TYPE {
   DEPRECATED = 'deprecated',
   FIXABLE = 'fixable',
   HAS_SUGGESTIONS = 'hasSuggestions',
+  REQUIRES_TYPE_CHECKING = 'requiresTypeChecking',
 }
 
 /**
@@ -96,6 +98,7 @@ const RULE_NOTICES: {
   // Simple strings.
   [MESSAGE_TYPE.FIXABLE]: `${EMOJI_FIXABLE} This rule is automatically fixable by the [\`--fix\` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).`,
   [MESSAGE_TYPE.HAS_SUGGESTIONS]: `${EMOJI_HAS_SUGGESTIONS} This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).`,
+  [MESSAGE_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} This rule requires type information.`,
 };
 
 /**
@@ -118,6 +121,8 @@ function getNoticesForRule(rule: RuleModule, configsEnabled: string[]) {
     [MESSAGE_TYPE.DEPRECATED]: rule.meta.deprecated || false,
     [MESSAGE_TYPE.FIXABLE]: Boolean(rule.meta.fixable),
     [MESSAGE_TYPE.HAS_SUGGESTIONS]: rule.meta.hasSuggestions || false,
+    [MESSAGE_TYPE.REQUIRES_TYPE_CHECKING]:
+      rule.meta.docs?.requiresTypeChecking || false,
   };
 
   return notices;

test/lib/__snapshots__/generator-test.ts.snap

@@ -79,20 +79,6 @@ exports[`generator #generate Scoped plugin name determines the correct plugin pr
 "
 `;
 
-exports[`generator #generate adds extra column to rules table for TypeScript rules updates the documentation 1`] = `
-"<!-- begin rules list -->
-
-💼 Configurations enabled in.\\
-💭 Requires type information.
-
-| Name                           | Description            | 💼       | 💭  |
-| :----------------------------- | :--------------------- | :------- | :-- |
-| [no-bar](docs/rules/no-bar.md) | Description of no-bar. |          | 💭  |
-| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | ![all][] |     |
-
-<!-- end rules list -->"
-`;
-
 exports[`generator #generate config that extends another config generates the documentation 1`] = `
 "## Rules
 <!-- begin rules list -->
@@ -474,6 +460,38 @@ exports[`generator #generate rules that are disabled generates the documentation
 "
 `;
 
+exports[`generator #generate shows column and notice for requiresTypeChecking updates the documentation 1`] = `
+"<!-- begin rules list -->
+
+💼 Configurations enabled in.\\
+💭 Requires type information.
+
+| Name                           | Description            | 💼       | 💭  |
+| :----------------------------- | :--------------------- | :------- | :-- |
+| [no-bar](docs/rules/no-bar.md) | Description of no-bar. |          | 💭  |
+| [no-foo](docs/rules/no-foo.md) | Description of no-foo. | ![all][] |     |
+
+<!-- end rules list -->"
+`;
+
+exports[`generator #generate shows column and notice for requiresTypeChecking updates the documentation 2`] = `
+"# Description of no-foo (\`test/no-foo\`)
+
+💼 This rule is enabled in the \`all\` config.
+
+<!-- end rule header -->
+"
+`;
+
+exports[`generator #generate shows column and notice for requiresTypeChecking updates the documentation 3`] = `
+"# Description of no-bar (\`test/no-bar\`)
+
+💭 This rule requires type information.
+
+<!-- end rule header -->
+"
+`;
+
 exports[`generator #generate successful updates the documentation 1`] = `
 "# eslint-plugin-test
 Description.

test/lib/generator-test.ts

@@ -495,7 +495,7 @@ describe('generator', function () {
       });
     });
 
-    describe('adds extra column to rules table for TypeScript rules', function () {
+    describe('shows column and notice for requiresTypeChecking', function () {
       beforeEach(function () {
         mockFs({
           'package.json': JSON.stringify({
@@ -546,6 +546,8 @@ describe('generator', function () {
         await generate('.');
 
         expect(readFileSync('README.md', 'utf8')).toMatchSnapshot();
+        expect(readFileSync('docs/rules/no-foo.md', 'utf8')).toMatchSnapshot();
+        expect(readFileSync('docs/rules/no-bar.md', 'utf8')).toMatchSnapshot();
       });
     });