feat: compiled types now include inlined literal docs

Things like `description` and `recommended` are now visible in the types/intellisense directly, instead of needing to read the source code.

Author: JasonWeinzierl

src/utils/rule-creator.ts

@@ -1,19 +1,21 @@
 import { ESLintUtils, TSESLint } from '@typescript-eslint/utils';
 import { version } from '../../package.json';
 
-export interface RxjsXRuleDocs<Options extends readonly unknown[]> {
-  description: string;
+export interface RxjsXRuleDocs<Options extends readonly unknown[], Desc extends string> {
+  description: Desc;
   recommended?: TSESLint.RuleRecommendation | TSESLint.RuleRecommendationAcrossConfigs<Options>;
   requiresTypeChecking?: boolean;
 }
 
 const REPO_URL = 'https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x';
 
-export const ruleCreator = ESLintUtils.RuleCreator<RxjsXRuleDocs<unknown[]>>(
+export const ruleCreator = ESLintUtils.RuleCreator<RxjsXRuleDocs<unknown[], string>>(
   (name) =>
     `${REPO_URL}/blob/v${version}/docs/rules/${name}.md`,
 // Ensure the Options type is passed to RxjsXRuleDocs.
 ) as <
   Options extends readonly unknown[],
   MessageIds extends string,
->({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, RxjsXRuleDocs<Options>>>) => TSESLint.RuleModule<MessageIds, Options, RxjsXRuleDocs<Options>>;
+  Desc extends string,
+  Docs extends RxjsXRuleDocs<Options, Desc>,
+>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, Docs>>) => TSESLint.RuleModule<MessageIds, Options, Docs>;

tests/package.test.ts

@@ -1,6 +1,7 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import plugin from '../src';
+import { RxjsXRuleDocs } from '../src/utils';
 
 function isSourceFile(value: string): boolean {
   const ext = path.extname(value);
@@ -51,14 +52,16 @@ describe('package', () => {
     const namespace = 'rxjs-x';
     const fullRuleName = `${namespace}/${ruleName}`;
 
-    if (!rule.meta.docs?.recommended) {
+    const ruleRec = (rule.meta.docs as RxjsXRuleDocs<unknown[], string>)?.recommended;
+
+    if (!ruleRec) {
       // Rule is not included in any configuration.
       expect(plugin.configs.recommended.rules).not.toHaveProperty(fullRuleName);
       expect(plugin.configs.strict.rules).not.toHaveProperty(fullRuleName);
-    } else if (typeof rule.meta.docs.recommended === 'string') {
+    } else if (typeof ruleRec === 'string') {
       // Rule specifies only a configuration name.
-      expect(rule.meta.docs.recommended).toMatch(/^(recommended|strict)$/);
-      if (rule.meta.docs.recommended === 'recommended') {
+      expect(ruleRec).toMatch(/^(recommended|strict)$/);
+      if (ruleRec === 'recommended') {
         expect(plugin.configs.recommended.rules).toHaveProperty(fullRuleName);
       } else {
         expect(plugin.configs.recommended.rules).not.toHaveProperty(fullRuleName);
@@ -69,12 +72,12 @@ describe('package', () => {
       expect(plugin.configs.strict.rules).toHaveProperty(fullRuleName, expect.any(String));
     } else {
       // Rule specifies non-default options for strict.
-      if (rule.meta.docs.recommended.recommended) {
+      if (ruleRec.recommended) {
         expect(plugin.configs.recommended.rules).toHaveProperty(fullRuleName);
       } else {
         expect(plugin.configs.recommended.rules).not.toHaveProperty(fullRuleName);
       }
-      expect(plugin.configs.strict.rules).toHaveProperty(fullRuleName, [expect.any(String), rule.meta.docs.recommended.strict[0]]);
+      expect(plugin.configs.strict.rules).toHaveProperty(fullRuleName, [expect.any(String), ruleRec.strict[0]]);
     }
   });
 });