Merge pull request #262 from bmish/option-url-rule-doc

Add new option `--url-rule-doc`
bmish · Nov 21, 2022 · d8aa370 · d8aa370
2 parents c11b203 + 1968ae3
commit d8aa370
Show file tree

Hide file tree

Showing 12 changed files with 175 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -135,6 +135,7 @@ There's also an optional path argument if you need to point the CLI to an ESLint
 | `--rule-list-columns` | Ordered, comma-separated list of columns to display in rule list. Empty columns will be hidden. Choices: `configsError`, `configsOff`, `configsWarn`, `deprecated`, `description`, `fixable`, `fixableAndHasSuggestions` (off by default), `hasSuggestions`, `name`, `options` (off by default), `requiresTypeChecking`, `type` (off by default). Default: `name,description,configsError,configsWarn,configsOff,fixable,hasSuggestions,requiresTypeChecking,deprecated`. |
 | `--split-by` | Rule property to split the rules list by. A separate list and header will be created for each value. Example: `meta.type`. |
 | `--url-configs` | Link to documentation about the ESLint configurations exported by the plugin. |
+| `--url-rule-doc` | Link to documentation for each rule. Useful when it differs from the rule doc path on disk (e.g. custom documentation site in use). Use `{name}` placeholder for the rule name. |
 
 ### `--rule-doc-title-format`
 

diff --git a/lib/cli.ts b/lib/cli.ts
@@ -67,6 +67,7 @@ async function loadConfigFileOptions() {
       ruleListColumns: { type: 'string' },
       splitBy: { type: 'string' },
       urlConfigs: { type: 'string' },
+      urlRuleDoc: { type: 'string' },
     };
     const schema = {
       type: 'object',
@@ -204,6 +205,10 @@ export async function run(
       '--url-configs <url>',
       '(optional) Link to documentation about the ESLint configurations exported by the plugin.'
     )
+    .option(
+      '--url-rule-doc <url>',
+      '(optional) Link to documentation for each rule. Useful when it differs from the rule doc path on disk (e.g. custom documentation site in use). Use `{name}` placeholder for the rule name.'
+    )
     .action(async function (path, options: GenerateOptions) {
       // Load config file options and merge with CLI options.
       // CLI options take precedence.

diff --git a/lib/generator.ts b/lib/generator.ts
@@ -123,6 +123,8 @@ export async function generate(path: string, options?: GenerateOptions) {
   const splitBy = options?.splitBy ?? OPTION_DEFAULTS[OPTION_TYPE.SPLIT_BY];
   const urlConfigs =
     options?.urlConfigs ?? OPTION_DEFAULTS[OPTION_TYPE.URL_CONFIGS];
+  const urlRuleDoc =
+    options?.urlRuleDoc ?? OPTION_DEFAULTS[OPTION_TYPE.URL_RULE_DOC];
 
   // Gather details about rules.
   const details: RuleDetails[] = Object.entries(plugin.rules)
@@ -188,7 +190,8 @@ export async function generate(path: string, options?: GenerateOptions) {
       ignoreConfig,
       ruleDocNotices,
       ruleDocTitleFormat,
-      urlConfigs
+      urlConfigs,
+      urlRuleDoc
     );
 
     const contents = readFileSync(pathToDoc).toString();
@@ -260,6 +263,7 @@ export async function generate(path: string, options?: GenerateOptions) {
     ignoreConfig,
     ruleListColumns,
     urlConfigs,
+    urlRuleDoc,
     splitBy
   );
 

diff --git a/lib/options.ts b/lib/options.ts
@@ -51,6 +51,7 @@ export enum OPTION_TYPE {
   RULE_LIST_COLUMNS = 'ruleListColumns',
   SPLIT_BY = 'splitBy',
   URL_CONFIGS = 'urlConfigs',
+  URL_RULE_DOC = 'urlRuleDoc',
 }
 
 const DEFAULT_RULE_DOC_TITLE_FORMAT: RuleDocTitleFormat =
@@ -82,6 +83,7 @@ export const OPTION_DEFAULTS = {
     .join(','),
   [OPTION_TYPE.SPLIT_BY]: undefined,
   [OPTION_TYPE.URL_CONFIGS]: undefined,
+  [OPTION_TYPE.URL_RULE_DOC]: undefined,
   // eslint-disable-next-line prettier/prettier -- TODO: waiting on prettier support for TypeScript 4.9: https://github.com/prettier/prettier/issues/13516.
 } satisfies Record<OPTION_TYPE, unknown>; // Satisfies is used to ensure all options are included, but without losing type information.
 
@@ -101,4 +103,5 @@ export type GenerateOptions = {
   ruleListColumns?: string;
   splitBy?: string;
   urlConfigs?: string;
+  urlRuleDoc?: string;
 };
diff --git a/lib/rule-list.ts b/lib/rule-list.ts
@@ -125,7 +125,8 @@ function buildRuleRow(
   pluginPrefix: string,
   pathRuleDoc: string,
   configEmojis: ConfigEmojis,
-  ignoreConfig: string[]
+  ignoreConfig: string[],
+  urlRuleDoc?: string
 ): string[] {
   const columns: {
     [key in COLUMN_TYPE]: string;
@@ -164,7 +165,7 @@ function buildRuleRow(
     [COLUMN_TYPE.HAS_SUGGESTIONS]: rule.hasSuggestions
       ? EMOJI_HAS_SUGGESTIONS
       : '',
-    [COLUMN_TYPE.NAME]: `[${rule.name}](${pathRuleDoc.replace(
+    [COLUMN_TYPE.NAME]: `[${rule.name}](${(urlRuleDoc ?? pathRuleDoc).replace(
       /{name}/g,
       rule.name
     )})`,
@@ -190,7 +191,8 @@ function generateRulesListMarkdown(
   pluginPrefix: string,
   pathRuleDoc: string,
   configEmojis: ConfigEmojis,
-  ignoreConfig: string[]
+  ignoreConfig: string[],
+  urlRuleDoc?: string
 ): string {
   const listHeaderRow = (
     Object.entries(columns) as [COLUMN_TYPE, boolean][]
@@ -221,7 +223,8 @@ function generateRulesListMarkdown(
             pluginPrefix,
             pathRuleDoc,
             configEmojis,
-            ignoreConfig
+            ignoreConfig,
+            urlRuleDoc
           )
         ),
     ],
@@ -241,7 +244,8 @@ function generateRulesListMarkdownWithSplitBy(
   pathRuleDoc: string,
   configEmojis: ConfigEmojis,
   ignoreConfig: string[],
-  splitBy: string
+  splitBy: string,
+  urlRuleDoc?: string
 ): string {
   const values = new Set(
     details.map((detail) => getPropertyFromRule(plugin, detail.name, splitBy))
@@ -278,7 +282,8 @@ function generateRulesListMarkdownWithSplitBy(
         pluginPrefix,
         pathRuleDoc,
         configEmojis,
-        ignoreConfig
+        ignoreConfig,
+        urlRuleDoc
       )
     );
   }
@@ -309,7 +314,8 @@ function generateRulesListMarkdownWithSplitBy(
         pluginPrefix,
         pathRuleDoc,
         configEmojis,
-        ignoreConfig
+        ignoreConfig,
+        urlRuleDoc
       )
     );
   }
@@ -330,6 +336,7 @@ export function updateRulesList(
   ignoreConfig: string[],
   ruleListColumns: COLUMN_TYPE[],
   urlConfigs?: string,
+  urlRuleDoc?: string,
   splitBy?: string
 ): string {
   let listStartIndex = markdown.indexOf(BEGIN_RULE_LIST_MARKER);
@@ -399,7 +406,8 @@ export function updateRulesList(
         pathRuleDoc,
         configEmojis,
         ignoreConfig,
-        splitBy
+        splitBy,
+        urlRuleDoc
       )
     : generateRulesListMarkdown(
         columns,
@@ -408,7 +416,8 @@ export function updateRulesList(
         pluginPrefix,
         pathRuleDoc,
         configEmojis,
-        ignoreConfig
+        ignoreConfig,
+        urlRuleDoc
       );
 
   const newContent = `${legend ? `${legend}\n\n` : ''}${list}`;

diff --git a/lib/rule-notices.ts b/lib/rule-notices.ts
@@ -83,6 +83,7 @@ const RULE_NOTICES: {
         replacedBy: readonly string[] | undefined;
         pluginPrefix: string;
         type?: RULE_TYPE;
+        urlRuleDoc?: string;
       }) => string);
 } = {
   // Configs notice varies based on whether the rule is configured in one or more configs.
@@ -152,7 +153,12 @@ const RULE_NOTICES: {
   },
 
   // Deprecated notice has optional "replaced by" rules list.
-  [NOTICE_TYPE.DEPRECATED]: ({ replacedBy, pluginPrefix, ruleName }) => {
+  [NOTICE_TYPE.DEPRECATED]: ({
+    replacedBy,
+    pluginPrefix,
+    ruleName,
+    urlRuleDoc,
+  }) => {
     // Determine the relative path to the rule doc root so that any replacement rule links can account for this.
     const slashesInCurrentRuleName = ruleName.match(/\//g);
     const nestingDepthOfCurrentRule = slashesInCurrentRuleName?.length ?? 0;
@@ -163,7 +169,8 @@ const RULE_NOTICES: {
         ? ` It was replaced by ${ruleNamesToList(
             replacedBy,
             pluginPrefix,
-            relativePathToRuleDocRoot
+            relativePathToRuleDocRoot,
+            urlRuleDoc
           )}.`
         : ''
     }`;
@@ -206,7 +213,8 @@ const RULE_NOTICES: {
 function ruleNamesToList(
   ruleNames: readonly string[],
   pluginPrefix: string,
-  relativePathToRuleDocRoot: string
+  relativePathToRuleDocRoot: string,
+  urlRuleDoc?: string
 ) {
   return ruleNames
     .map((ruleName) => {
@@ -218,8 +226,10 @@ function ruleNamesToList(
         ? ruleName.slice(pluginPrefix.length + 1)
         : ruleName;
       return `[\`${ruleNameWithoutPluginPrefix}\`](${
-        relativePathToRuleDocRoot + ruleNameWithoutPluginPrefix
-      }.md)`;
+        urlRuleDoc
+          ? urlRuleDoc.replace(/{name}/g, ruleName)
+          : `${relativePathToRuleDocRoot + ruleNameWithoutPluginPrefix}.md`
+      })`;
     })
     .join(', ');
 }
@@ -273,7 +283,8 @@ function getRuleNoticeLines(
   configEmojis: ConfigEmojis,
   ignoreConfig: string[],
   ruleDocNotices: NOTICE_TYPE[],
-  urlConfigs?: string
+  urlConfigs?: string,
+  urlRuleDoc?: string
 ) {
   const lines: string[] = [];
 
@@ -352,6 +363,7 @@ function getRuleNoticeLines(
             replacedBy: rule.meta?.replacedBy,
             pluginPrefix,
             type: rule.meta?.type as RULE_TYPE, // Convert union type to enum.
+            urlRuleDoc,
           })
         : ruleNoticeStrOrFn
     );
@@ -435,7 +447,8 @@ export function generateRuleHeaderLines(
   ignoreConfig: string[],
   ruleDocNotices: NOTICE_TYPE[],
   ruleDocTitleFormat: RuleDocTitleFormat,
-  urlConfigs?: string
+  urlConfigs?: string,
+  urlRuleDoc?: string
 ): string {
   return [
     makeTitle(name, description, pluginPrefix, ruleDocTitleFormat),
@@ -447,7 +460,8 @@ export function generateRuleHeaderLines(
       configEmojis,
       ignoreConfig,
       ruleDocNotices,
-      urlConfigs
+      urlConfigs,
+      urlRuleDoc
     ),
     '',
     END_RULE_HEADER_MARKER,

diff --git a/test/lib/__snapshots__/cli-test.ts.snap b/test/lib/__snapshots__/cli-test.ts.snap
@@ -36,7 +36,8 @@ exports[`cli all CLI options and all config files options merges correctly, with
     "ruleDocTitleFormat": "name",
     "ruleListColumns": "type",
     "splitBy": "meta.docs.foo-from-cli",
-    "urlConfigs": "www.example.com/configs-from-cli",
+    "urlConfigs": "https://example.com/configs-url-from-cli",
+    "urlRuleDoc": "https://example.com/rule-doc-url-from-cli",
   },
 ]
 `;
@@ -70,7 +71,8 @@ exports[`cli all CLI options, no config file options is called correctly 1`] = `
     "ruleDocTitleFormat": "name",
     "ruleListColumns": "type",
     "splitBy": "meta.docs.foo-from-cli",
-    "urlConfigs": "www.example.com/configs-from-cli",
+    "urlConfigs": "https://example.com/configs-url-from-cli",
+    "urlRuleDoc": "https://example.com/rule-doc-url-from-cli",
   },
 ]
 `;
@@ -104,7 +106,8 @@ exports[`cli all config files options, no CLI options is called correctly 1`] =
     "ruleDocTitleFormat": "desc",
     "ruleListColumns": "fixable,hasSuggestions",
     "splitBy": "meta.docs.foo-from-config-file",
-    "urlConfigs": "www.example.com/configs-from-config-file",
+    "urlConfigs": "https://example.com/configs-url-from-config-file",
+    "urlRuleDoc": "https://example.com/rule-doc-url-from-config-file",
   },
 ]
 `;

diff --git a/test/lib/cli-test.ts b/test/lib/cli-test.ts
@@ -27,7 +27,8 @@ const configFileOptionsAll: { [key in OPTION_TYPE]: unknown } = {
   ruleDocTitleFormat: 'desc',
   ruleListColumns: 'fixable,hasSuggestions',
   splitBy: 'meta.docs.foo-from-config-file',
-  urlConfigs: 'www.example.com/configs-from-config-file',
+  urlConfigs: 'https://example.com/configs-url-from-config-file',
+  urlRuleDoc: 'https://example.com/rule-doc-url-from-config-file',
 };
 
 const cliOptionsAll: { [key in OPTION_TYPE]: string[] } = {
@@ -85,7 +86,12 @@ const cliOptionsAll: { [key in OPTION_TYPE]: string[] } = {
 
   [OPTION_TYPE.URL_CONFIGS]: [
     '--url-configs',
-    'www.example.com/configs-from-cli',
+    'https://example.com/configs-url-from-cli',
+  ],
+
+  [OPTION_TYPE.URL_RULE_DOC]: [
+    '--url-rule-doc',
+    'https://example.com/rule-doc-url-from-cli',
   ],
 };
 

diff --git a/test/lib/generate/__snapshots__/url-configs-test.ts.snap b/test/lib/generate/__snapshots__/url-configs-test.ts.snap
@@ -4,8 +4,8 @@ exports[`generate (--url-configs) basic includes the config link 1`] = `
 "## Rules
 <!-- begin auto-generated rules list -->
 
-💼 [Configurations](http://example.com/configs) enabled in.\\
-✅ Set in the \`recommended\` [configuration](http://example.com/configs).
+💼 [Configurations](https://example.com/configs) enabled in.\\
+✅ Set in the \`recommended\` [configuration](https://example.com/configs).
 
 | Name                           | Description             | 💼                      |
 | :----------------------------- | :---------------------- | :---------------------- |
@@ -19,7 +19,7 @@ exports[`generate (--url-configs) basic includes the config link 1`] = `
 exports[`generate (--url-configs) basic includes the config link 2`] = `
 "# Description for no-foo (\`test/no-foo\`)
 
-💼 This rule is enabled in the ✅ \`recommended\` [config](http://example.com/configs).
+💼 This rule is enabled in the ✅ \`recommended\` [config](https://example.com/configs).
 
 <!-- end auto-generated rule header -->
 "
@@ -28,7 +28,7 @@ exports[`generate (--url-configs) basic includes the config link 2`] = `
 exports[`generate (--url-configs) basic includes the config link 3`] = `
 "# Description for no-bar (\`test/no-bar\`)
 
-💼 This rule is enabled in the \`customConfig\` [config](http://example.com/configs).
+💼 This rule is enabled in the \`customConfig\` [config](https://example.com/configs).
 
 <!-- end auto-generated rule header -->
 "
@@ -38,8 +38,8 @@ exports[`generate (--url-configs) with only recommended config includes the conf
 "## Rules
 <!-- begin auto-generated rules list -->
 
-💼 [Configurations](http://example.com/configs) enabled in.\\
-✅ Set in the \`recommended\` [configuration](http://example.com/configs).
+💼 [Configurations](https://example.com/configs) enabled in.\\
+✅ Set in the \`recommended\` [configuration](https://example.com/configs).
 
 | Name                           | Description             | 💼 |
 | :----------------------------- | :---------------------- | :- |
@@ -52,7 +52,7 @@ exports[`generate (--url-configs) with only recommended config includes the conf
 exports[`generate (--url-configs) with only recommended config includes the config link 2`] = `
 "# Description for no-foo (\`test/no-foo\`)
 
-💼 This rule is enabled in the ✅ \`recommended\` [config](http://example.com/configs).
+💼 This rule is enabled in the ✅ \`recommended\` [config](https://example.com/configs).
 
 <!-- end auto-generated rule header -->
 "