fix: fix JSON schema with root ID not parsed correctly (#13)

Author: hugop95

src/core.ts

@@ -212,18 +212,28 @@ export async function compileRule(
     ? { type: 'array', items: meta.schema, definitions: meta.schema?.[0]?.definitions }
     : meta.schema
 
+  let overriddenRootSchemaId: string | undefined
+  let isRootSchema = true
+
   try {
     const compiled = await compileSchema(schema, id, {
       unreachableDefinitions: false,
       strictIndexSignatures: true,
       customName(schema, keyName) {
+        const canOverrideRootSchemaId = isRootSchema
+        isRootSchema = false
+
         const resolved = schema.title || schema.$id || keyName
-        if (resolved === id) {
+        if (resolved === id)
           return id
-        }
         if (!resolved)
           return undefined!
-        return `_${normalizeIdentifier(`${id}_${resolved}`)}`
+
+        const normalizedName = `_${normalizeIdentifier(`${id}_${resolved}`)}`
+        if (canOverrideRootSchemaId)
+          overriddenRootSchemaId = normalizedName
+
+        return normalizedName
       },
       ...compileOptions,
     })
@@ -249,7 +259,7 @@ export async function compileRule(
   return {
     name: ruleName,
     jsdoc,
-    typeName: id,
+    typeName: overriddenRootSchemaId ?? id,
     typeDeclarations: lines,
   }
 }

test/index.test.ts

@@ -2,6 +2,7 @@ import { vue } from '@antfu/eslint-config'
 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'
 
 it('pluginsToRuleOptions', async () => {
   await expect(await pluginsToRulesDTS({
@@ -35,6 +36,13 @@ it('invalid JSON schema plugin', async () => {
     .toMatchFileSnapshot('./output/invalid-json-schema-plugin.d.ts')
 })
 
+it('json schema with ids', async () => {
+  await expect(await pluginsToRulesDTS({
+    plugin: pluginWithSchemaIds,
+  }))
+    .toMatchFileSnapshot('./output/plugin-with-schema-ids.d.ts')
+})
+
 it('flatConfigsToRuleOptions', async () => {
   await expect(await flatConfigsToRulesDTS(await vue() as any))
     .toMatchFileSnapshot('./output/flat-config-vue.d.ts')

test/input/plugin-with-schema-ids.ts

@@ -0,0 +1,51 @@
+import type { ESLint, Rule } from 'eslint'
+
+export const pluginWithSchemaIds: ESLint.Plugin = {
+  rules: {
+    'schema-with-id-at-root': {
+      create: () => null as unknown as Rule.RuleListener,
+      meta: {
+        schema: {
+          id: 'schemaId',
+          type: 'object',
+          additionalProperties: false,
+          properties: {
+            a: {
+              id: 'aId',
+              type: 'string',
+            },
+            b: {
+              id: 'bId',
+              additionalProperties: false,
+              type: 'object',
+              properties: {
+                b1: {
+                  type: 'string',
+                },
+              },
+            },
+            c: {
+              additionalProperties: false,
+              type: 'object',
+              properties: {
+                c1: {
+                  type: 'string',
+                  id: 'c1Id',
+                },
+              },
+            },
+            d: {
+              additionalProperties: false,
+              type: 'object',
+              properties: {
+                da: {
+                  type: 'string',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+}

test/output/plugin-with-schema-ids.d.ts

@@ -0,0 +1,31 @@
+/* eslint-disable */
+/* prettier-ignore */
+import type { Linter } from 'eslint'
+
+declare module 'eslint' {
+  namespace Linter {
+    interface RulesRecord extends RuleOptions {}
+  }
+}
+
+export interface RuleOptions {
+  'plugin/schema-with-id-at-root'?: Linter.RuleEntry<_PluginSchemaWithIdAtRootSchemaId>
+}
+
+/* ======= Declarations ======= */
+// ----- plugin/schema-with-id-at-root -----
+type _PluginSchemaWithIdAtRootAId = string
+type _PluginSchemaWithIdAtRootC1Id = string
+interface _PluginSchemaWithIdAtRootSchemaId {
+  a?: _PluginSchemaWithIdAtRootAId
+  b?: _PluginSchemaWithIdAtRootBId
+  c?: {
+    c1?: _PluginSchemaWithIdAtRootC1Id
+  }
+  d?: {
+    da?: string
+  }
+}
+interface _PluginSchemaWithIdAtRootBId {
+  b1?: string
+}