feat: fork json schema types for better compat with ESLint rule valid…

…ation (#6963) * feat: fork json schema types for better compat with ESLint rule validation * make the schema types a discriminated union * Also update blog --------- Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>
typescript-eslint · Jun 17, 2023 · a4967f2 · a4967f2
1 parent c456f8c
commit a4967f2
Show file tree

Hide file tree

Showing 67 changed files with 740 additions and 149 deletions.
diff --git a/docs/architecture/Utils.mdx b/docs/architecture/Utils.mdx
@@ -15,14 +15,14 @@ Any custom rules you write generally will be as well.
 
 ## Exports
 
-| Name              | Description                                                                                                                                                                                                                       |
-| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `AST_NODE_TYPES`  | An enum with the names of every single _node_ found in `TSESTree`.                                                                                                                                                                |
-| `AST_TOKEN_TYPES` | An enum with the names of every single _token_ found in `TSESTree`.                                                                                                                                                               |
-| `ASTUtils`        | Tools for operating on the ESTree AST. Also includes the [`@eslint-community/eslint-utils`](https://www.npmjs.com/package/@eslint-community/eslint-utils) package, correctly typed to work with the types found in `TSESTree`     |
-| `ESLintUtils`     | Tools for creating ESLint rules with TypeScript.                                                                                                                                                                                  |
-| `JSONSchema`      | Types from the [`@types/json-schema`](https://www.npmjs.com/package/@types/json-schema) package, re-exported to save you having to manually import them. Also ensures you're using the same version of the types as this package. |
-| `ParserServices`  | Typing for the parser services provided when parsing a file using `@typescript-eslint/typescript-estree`.                                                                                                                         |
-| `TSESLint`        | Types for ESLint, correctly typed to work with the types found in `TSESTree`.                                                                                                                                                     |
-| `TSESLintScope`   | The [`eslint-scope`](https://www.npmjs.com/package/eslint-scope) package, correctly typed to work with the types found in both `TSESTree` and `TSESLint`                                                                          |
-| `TSESTree`        | Types for the TypeScript flavor of ESTree created by `@typescript-eslint/typescript-estree`.                                                                                                                                      |
+| Name              | Description                                                                                                                                                                                                                   |
+| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `AST_NODE_TYPES`  | An enum with the names of every single _node_ found in `TSESTree`.                                                                                                                                                            |
+| `AST_TOKEN_TYPES` | An enum with the names of every single _token_ found in `TSESTree`.                                                                                                                                                           |
+| `ASTUtils`        | Tools for operating on the ESTree AST. Also includes the [`@eslint-community/eslint-utils`](https://www.npmjs.com/package/@eslint-community/eslint-utils) package, correctly typed to work with the types found in `TSESTree` |
+| `ESLintUtils`     | Tools for creating ESLint rules with TypeScript.                                                                                                                                                                              |
+| `JSONSchema`      | Strict types for the JSON Schema v4 spec - the version that ESLint uses to validate all rules with.                                                                                                                           |
+| `ParserServices`  | Typing for the parser services provided when parsing a file using `@typescript-eslint/typescript-estree`.                                                                                                                     |
+| `TSESLint`        | Types for ESLint, correctly typed to work with the types found in `TSESTree`.                                                                                                                                                 |
+| `TSESLintScope`   | The [`eslint-scope`](https://www.npmjs.com/package/eslint-scope) package, correctly typed to work with the types found in both `TSESTree` and `TSESLint`                                                                      |
+| `TSESTree`        | Types for the TypeScript flavor of ESTree created by `@typescript-eslint/typescript-estree`.                                                                                                                                  |
diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json
@@ -66,6 +66,10 @@
     "ts-api-utils": "^1.0.0"
   },
   "devDependencies": {
+    "@types/debug": "*",
+    "@types/marked": "*",
+    "@types/natural-compare": "*",
+    "@types/prettier": "*",
     "@typescript-eslint/rule-schema-to-typescript-types": "5.59.11",
     "@typescript-eslint/rule-tester": "5.59.11",
     "cross-fetch": "*",

diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -109,6 +109,7 @@ export default util.createRule<Options, MessageIds>({
       {
         $defs: {
           arrayOption: {
+            type: 'string',
             enum: ['array', 'generic', 'array-simple'],
           },
         },

diff --git a/packages/eslint-plugin/src/rules/ban-ts-comment.ts b/packages/eslint-plugin/src/rules/ban-ts-comment.ts
@@ -49,6 +49,7 @@ export default util.createRule<[Options], MessageIds>({
                 default: true,
               },
               {
+                type: 'string',
                 enum: ['allow-with-description'],
               },
               {

diff --git a/packages/eslint-plugin/src/rules/ban-types.ts b/packages/eslint-plugin/src/rules/ban-types.ts
@@ -148,11 +148,13 @@ export default util.createRule<Options, MessageIds>({
                 description: 'Bans the type with the default message',
               },
               {
+                type: 'boolean',
                 enum: [false],
                 description:
                   'Un-bans the type (useful when paired with `extendDefaults`)',
               },
               {
+                type: 'boolean',
                 enum: [true],
                 description: 'Bans the type with the default message',
               },

diff --git a/packages/eslint-plugin/src/rules/class-literal-property-style.ts b/packages/eslint-plugin/src/rules/class-literal-property-style.ts
@@ -50,7 +50,12 @@ export default util.createRule<Options, MessageIds>({
       preferFieldStyle: 'Literals should be exposed using readonly fields.',
       preferGetterStyle: 'Literals should be exposed using getters.',
     },
-    schema: [{ enum: ['fields', 'getters'] }],
+    schema: [
+      {
+        type: 'string',
+        enum: ['fields', 'getters'],
+      },
+    ],
   },
   defaultOptions: ['fields'],
   create(context, [style]) {

diff --git a/packages/eslint-plugin/src/rules/comma-dangle.ts b/packages/eslint-plugin/src/rules/comma-dangle.ts
@@ -49,9 +49,11 @@ export default util.createRule<Options, MessageIds>({
     schema: {
       $defs: {
         value: {
+          type: 'string',
           enum: OPTION_VALUE_SCHEME,
         },
         valueWithIgnore: {
+          type: 'string',
           enum: [...OPTION_VALUE_SCHEME, 'ignore'],
         },
       },
@@ -79,7 +81,7 @@ export default util.createRule<Options, MessageIds>({
           ],
         },
       ],
-      additionalProperties: false,
+      additionalItems: false,
     },
     fixable: 'code',
     hasSuggestions: baseRule.meta.hasSuggestions,

diff --git a/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts b/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts
@@ -24,6 +24,7 @@ export default createRule<Options, MessageIds>({
     fixable: 'code',
     schema: [
       {
+        type: 'string',
         enum: ['type-annotation', 'constructor'],
       },
     ],

diff --git a/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts b/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
@@ -21,6 +21,7 @@ export default createRule<Options, MessageIds>({
     fixable: 'code',
     schema: [
       {
+        type: 'string',
         enum: ['record', 'index-signature'],
       },
     ],

diff --git a/packages/eslint-plugin/src/rules/consistent-type-assertions.ts b/packages/eslint-plugin/src/rules/consistent-type-assertions.ts
@@ -48,6 +48,7 @@ export default util.createRule<Options, MessageIds>({
             type: 'object',
             properties: {
               assertionStyle: {
+                type: 'string',
                 enum: ['never'],
               },
             },
@@ -58,9 +59,11 @@ export default util.createRule<Options, MessageIds>({
             type: 'object',
             properties: {
               assertionStyle: {
+                type: 'string',
                 enum: ['as', 'angle-bracket'],
               },
               objectLiteralTypeAssertions: {
+                type: 'string',
                 enum: ['allow', 'allow-as-parameter', 'never'],
               },
             },

diff --git a/packages/eslint-plugin/src/rules/consistent-type-definitions.ts b/packages/eslint-plugin/src/rules/consistent-type-definitions.ts
@@ -18,6 +18,7 @@ export default util.createRule({
     },
     schema: [
       {
+        type: 'string',
         enum: ['interface', 'type'],
       },
     ],

diff --git a/packages/eslint-plugin/src/rules/consistent-type-imports.ts b/packages/eslint-plugin/src/rules/consistent-type-imports.ts
@@ -65,12 +65,14 @@ export default util.createRule<Options, MessageIds>({
         type: 'object',
         properties: {
           prefer: {
+            type: 'string',
             enum: ['type-imports', 'no-type-imports'],
           },
           disallowTypeAnnotations: {
             type: 'boolean',
           },
           fixStyle: {
+            type: 'string',
             enum: ['separate-type-imports', 'inline-type-imports'],
           },
         },

diff --git a/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts b/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts
@@ -51,14 +51,17 @@ export default util.createRule<Options, MessageIds>({
           accessibilityLevel: {
             oneOf: [
               {
+                type: 'string',
                 enum: ['explicit'],
                 description: 'Always require an accessor.',
               },
               {
+                type: 'string',
                 enum: ['no-public'],
                 description: 'Require an accessor except when public.',
               },
               {
+                type: 'string',
                 enum: ['off'],
                 description: 'Never check whether there is an accessor.',
               },

diff --git a/packages/eslint-plugin/src/rules/func-call-spacing.ts b/packages/eslint-plugin/src/rules/func-call-spacing.ts
@@ -29,6 +29,7 @@ export default util.createRule<Options, MessageIds>({
           type: 'array',
           items: [
             {
+              type: 'string',
               enum: ['never'],
             },
           ],
@@ -39,6 +40,7 @@ export default util.createRule<Options, MessageIds>({
           type: 'array',
           items: [
             {
+              type: 'string',
               enum: ['always'],
             },
             {

diff --git a/packages/eslint-plugin/src/rules/keyword-spacing.ts b/packages/eslint-plugin/src/rules/keyword-spacing.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES, AST_TOKEN_TYPES } from '@typescript-eslint/utils';
+import type { JSONSchema4 } from '@typescript-eslint/utils/json-schema';
 
 import * as util from '../util';
 import { getESLintCoreRule } from '../util/getESLintCoreRule';
@@ -26,7 +27,7 @@ const schema = util.deepMerge(
       },
     },
   },
-);
+) as unknown as JSONSchema4;
 
 export default util.createRule<Options, MessageIds>({
   name: 'keyword-spacing',

diff --git a/packages/eslint-plugin/src/rules/member-delimiter-style.ts b/packages/eslint-plugin/src/rules/member-delimiter-style.ts
@@ -150,9 +150,15 @@ export default util.createRule<Options, MessageIds>({
     schema: [
       {
         $defs: {
-          multiLineOption: { enum: ['none', 'semi', 'comma'] },
+          multiLineOption: {
+            type: 'string',
+            enum: ['none', 'semi', 'comma'],
+          },
           // note can't have "none" for single line delimiter as it's invalid syntax
-          singleLineOption: { enum: ['semi', 'comma'] },
+          singleLineOption: {
+            type: 'string',
+            enum: ['semi', 'comma'],
+          },
           // note - need to define this last as it references the enums
           delimiterConfig: BASE_SCHEMA,
         },
@@ -172,6 +178,7 @@ export default util.createRule<Options, MessageIds>({
             additionalProperties: false,
           },
           multilineDetection: {
+            type: 'string',
             enum: ['brackets', 'last-member'],
           },
         },

diff --git a/packages/eslint-plugin/src/rules/member-ordering.ts b/packages/eslint-plugin/src/rules/member-ordering.ts
@@ -644,7 +644,7 @@ export default util.createRule<Options, MessageIds>({
           },
           allItems: {
             type: 'string',
-            enum: allMemberTypes,
+            enum: allMemberTypes as string[],
           },
           typeItems: {
             type: 'string',

diff --git a/packages/eslint-plugin/src/rules/method-signature-style.ts b/packages/eslint-plugin/src/rules/method-signature-style.ts
@@ -22,6 +22,7 @@ export default util.createRule<Options, MessageIds>({
     },
     schema: [
       {
+        type: 'string',
         enum: ['property', 'method'],
       },
     ],

diff --git a/packages/eslint-plugin/src/rules/no-empty-function.ts b/packages/eslint-plugin/src/rules/no-empty-function.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import type { JSONSchema4 } from '@typescript-eslint/utils/json-schema';
 
 import * as util from '../util';
 import { getESLintCoreRule } from '../util/getESLintCoreRule';
@@ -18,6 +19,7 @@ const schema = util.deepMerge(
     properties: {
       allow: {
         items: {
+          type: 'string',
           enum: [
             'functions',
             'arrowFunctions',
@@ -38,7 +40,7 @@ const schema = util.deepMerge(
       },
     },
   },
-);
+) as unknown as JSONSchema4;
 
 export default util.createRule<Options, MessageIds>({
   name: 'no-empty-function',

diff --git a/packages/eslint-plugin/src/rules/no-invalid-void-type.ts b/packages/eslint-plugin/src/rules/no-invalid-void-type.ts
@@ -47,7 +47,7 @@ export default util.createRule<[Options], MessageIds>({
               {
                 type: 'array',
                 items: { type: 'string' },
-                minLength: 1,
+                minItems: 1,
               },
             ],
           },

diff --git a/packages/eslint-plugin/src/rules/no-magic-numbers.ts b/packages/eslint-plugin/src/rules/no-magic-numbers.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import type { JSONSchema4 } from '@typescript-eslint/utils/json-schema';
 
 import * as util from '../util';
 import { getESLintCoreRule } from '../util/getESLintCoreRule';
@@ -31,7 +32,7 @@ const schema = util.deepMerge(
       },
     },
   },
-);
+) as unknown as JSONSchema4;
 
 export default util.createRule<Options, MessageIds>({
   name: 'no-magic-numbers',

diff --git a/packages/eslint-plugin/src/rules/no-shadow.ts b/packages/eslint-plugin/src/rules/no-shadow.ts
@@ -43,6 +43,7 @@ export default util.createRule<Options, MessageIds>({
             type: 'boolean',
           },
           hoist: {
+            type: 'string',
             enum: ['all', 'functions', 'never'],
           },
           allow: {

diff --git a/packages/eslint-plugin/src/rules/no-type-alias.ts b/packages/eslint-plugin/src/rules/no-type-alias.ts
@@ -50,6 +50,7 @@ export default util.createRule<Options, MessageIds>({
       {
         $defs: {
           expandedOptions: {
+            type: 'string',
             enum: [
               'always',
               'never',
@@ -59,6 +60,7 @@ export default util.createRule<Options, MessageIds>({
             ] satisfies Values[],
           },
           simpleOptions: {
+            type: 'string',
             enum: ['always', 'never'],
           },
         },

diff --git a/packages/eslint-plugin/src/rules/no-unused-vars.ts b/packages/eslint-plugin/src/rules/no-unused-vars.ts
@@ -44,18 +44,21 @@ export default util.createRule<Options, MessageIds>({
       {
         oneOf: [
           {
+            type: 'string',
             enum: ['all', 'local'],
           },
           {
             type: 'object',
             properties: {
               vars: {
+                type: 'string',
                 enum: ['all', 'local'],
               },
               varsIgnorePattern: {
                 type: 'string',
               },
               args: {
+                type: 'string',
                 enum: ['all', 'after-used', 'none'],
               },
               ignoreRestSiblings: {
@@ -65,6 +68,7 @@ export default util.createRule<Options, MessageIds>({
                 type: 'string',
               },
               caughtErrors: {
+                type: 'string',
                 enum: ['all', 'none'],
               },
               caughtErrorsIgnorePattern: {

diff --git a/packages/eslint-plugin/src/rules/no-use-before-define.ts b/packages/eslint-plugin/src/rules/no-use-before-define.ts
@@ -251,6 +251,7 @@ export default util.createRule<Options, MessageIds>({
       {
         oneOf: [
           {
+            type: 'string',
             enum: ['nofunc'],
           },
           {

diff --git a/packages/eslint-plugin/src/rules/padding-line-between-statements.ts b/packages/eslint-plugin/src/rules/padding-line-between-statements.ts
@@ -598,14 +598,21 @@ export default util.createRule<Options, MessageIds>({
     schema: {
       $defs: {
         paddingType: {
+          type: 'string',
           enum: Object.keys(PaddingTypes),
         },
         statementType: {
           anyOf: [
-            { enum: Object.keys(StatementTypes) },
+            {
+              type: 'string',
+              enum: Object.keys(StatementTypes),
+            },
             {
               type: 'array',
-              items: { enum: Object.keys(StatementTypes) },
+              items: {
+                type: 'string',
+                enum: Object.keys(StatementTypes),
+              },
               minItems: 1,
               uniqueItems: true,
               additionalItems: false,