Add option to include the jsdoc of the rule options

src/core.ts

@@ -25,6 +25,13 @@ export interface RulesTypeGenOptions {
    */
   includeAugmentation?: boolean
 
+  /**
+   * Include JSDoc comments for rule options.
+   *
+   * @default false
+   */
+  includeRuleOptionsJsDoc?: boolean
+
   /**
    * Augment the `DefaultConfigNamesMap` interface for `eslint-flat-config-utils`
    * For auto-completion of config names etc.
@@ -99,6 +106,7 @@ export async function pluginsToRulesDTS(
     includeTypeImports = true,
     includeIgnoreComments = true,
     includeAugmentation = true,
+    includeRuleOptionsJsDoc = false,
     augmentFlatConfigUtils = false,
     exportTypeName = 'RuleOptions',
     compileOptions = {},
@@ -122,7 +130,7 @@ export async function pluginsToRulesDTS(
 
   rules.sort(([a], [b]) => a.localeCompare(b))
   const resolved = await Promise.all(rules
-    .map(([name, rule]) => compileRule(name, rule, compileOptions)))
+    .map(([name, rule]) => compileRule(name, rule, compileOptions, { includeRuleOptionsJsDoc })))
 
   const exports = [
     ...(includeIgnoreComments
@@ -181,6 +189,7 @@ export async function compileRule(
   ruleName: string,
   rule: Rule.RuleModule,
   compileOptions: Partial<CompileOptions> = {},
+  typeGenOptions: RulesTypeGenOptions = {},
 ) {
   const meta = rule.meta ?? {}
   let schemas = meta.schema as JSONSchema4[] ?? []
@@ -237,10 +246,11 @@ export async function compileRule(
       },
       ...compileOptions,
     })
-    lines.push(
-      compiled
-        .replace(/\/\*[\s\S]*?\*\//g, ''),
-    )
+
+    if (typeGenOptions?.includeRuleOptionsJsDoc)
+      lines.push(compiled)
+    else
+      lines.push(compiled.replace(/\/\*[\s\S]*?\*\//g, ''))
   }
   catch (error) {
     console.warn(`Failed to compile schema ${ruleName} for rule ${ruleName}. Falling back to unknown.`)

test/index.test.ts

@@ -3,6 +3,7 @@ import { expect, it } from 'vitest'
 import { flatConfigsToRulesDTS, pluginsToRulesDTS } from '../src/core'
 import { invalidJsonSchemaPlugin } from './input/invalid-json-schema-plugin'
 import { pluginWithSchemaIds } from './input/plugin-with-schema-ids'
+import { ruleWithDescriptionInJsdoc } from './input/rule-with-description-in-jsdoc'
 
 it('pluginsToRuleOptions', async () => {
   await expect(await pluginsToRulesDTS({
@@ -43,6 +44,15 @@ it('json schema with ids', async () => {
     .toMatchFileSnapshot('./output/plugin-with-schema-ids.d.ts')
 })
 
+it('rule with description in jsdoc', async () => {
+  await expect(await pluginsToRulesDTS({
+    plugin: ruleWithDescriptionInJsdoc,
+  }, {
+    includeRuleOptionsJsDoc: true,
+  }))
+    .toMatchFileSnapshot('./output/rule-with-description-in-jsdoc.d.ts')
+})
+
 it('flatConfigsToRuleOptions', async () => {
   await expect(await flatConfigsToRulesDTS(await vue() as any))
     .toMatchFileSnapshot('./output/flat-config-vue.d.ts')

test/input/rule-with-description-in-jsdoc.ts

@@ -0,0 +1,30 @@
+import type { ESLint, Rule } from 'eslint'
+
+export const ruleWithDescriptionInJsdoc: ESLint.Plugin = {
+  rules: {
+    'rule-with-description-in-properties-schema': {
+      create: () => null as unknown as Rule.RuleListener,
+      meta: {
+        schema: {
+          id: 'schemaId',
+          type: 'object',
+          additionalProperties: false,
+          properties: {
+            a: {
+              id: 'aId',
+              type: 'boolean',
+              default: false,
+              description: 'This is a boolean property',
+            },
+            b: {
+              id: 'bId',
+              type: 'string',
+              default: 'default',
+              description: 'This is a string property',
+            },
+          },
+        },
+      },
+    },
+  },
+}

test/output/rule-with-description-in-jsdoc.d.ts

@@ -0,0 +1,28 @@
+/* eslint-disable */
+/* prettier-ignore */
+import type { Linter } from 'eslint'
+
+declare module 'eslint' {
+  namespace Linter {
+    interface RulesRecord extends RuleOptions {}
+  }
+}
+
+export interface RuleOptions {
+  'plugin/rule-with-description-in-properties-schema'?: Linter.RuleEntry<_PluginRuleWithDescriptionInPropertiesSchemaSchemaId>
+}
+
+/* ======= Declarations ======= */
+// ----- plugin/rule-with-description-in-properties-schema -----
+/**
+ * This is a boolean property
+ */
+type _PluginRuleWithDescriptionInPropertiesSchemaAId = boolean
+/**
+ * This is a string property
+ */
+type _PluginRuleWithDescriptionInPropertiesSchemaBId = string
+interface _PluginRuleWithDescriptionInPropertiesSchemaSchemaId {
+  a?: _PluginRuleWithDescriptionInPropertiesSchemaAId
+  b?: _PluginRuleWithDescriptionInPropertiesSchemaBId
+}