Use json-schema-to-typescript for main schema

Author: Shinigami92

.eslintrc.js

@@ -29,9 +29,10 @@ module.exports = defineConfig({
     '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
     '@typescript-eslint/interface-name-prefix': 'off',
-    '@typescript-eslint/member-ordering': 'warn',
+    '@typescript-eslint/member-ordering': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-parameter-properties': 'off',
     '@typescript-eslint/no-unsafe-assignment': 'off',
     '@typescript-eslint/no-unused-vars': 'off',

package.json

@@ -51,6 +51,7 @@
     "eslint-plugin-prettier": "~4.0.0",
     "eslint-plugin-spellcheck": "~0.0.19",
     "eslint-plugin-vue": "~7.18.0",
+    "json-schema-to-typescript": "~10.1.5",
     "np": "~7.5.0",
     "prettier": "2.4.1",
     "prettier-plugin-organize-imports": "~2.3.4",

scripts/generate-files.ts

@@ -8,6 +8,7 @@ import eslintPluginSpellcheck from 'eslint-plugin-spellcheck';
 import eslintPluginVue from 'eslint-plugin-vue';
 import * as fs from 'fs';
 import type { JSONSchema4 } from 'json-schema';
+import { compile } from 'json-schema-to-typescript';
 import * as path from 'path';
 import type { Options } from 'prettier';
 import { format } from 'prettier';
@@ -120,55 +121,70 @@ function generateOptionType(schema: JSONSchema4): string {
   return result;
 }
 
-for (const pluginName in generationMap) {
-  const { rules, name } = generationMap[pluginName]!;
+async function main(): Promise<void> {
+  for (const pluginName in generationMap) {
+    const { rules, name } = generationMap[pluginName]!;
 
-  const ruleProviderDir: string = path.resolve(rulesDir, pluginName);
+    const ruleProviderDir: string = path.resolve(rulesDir, pluginName);
 
-  fs.mkdirSync(ruleProviderDir, { mode: 0o755, recursive: true });
+    fs.mkdirSync(ruleProviderDir, { mode: 0o755, recursive: true });
 
-  Object.entries(rules).forEach(([ruleName, { meta }]) => {
-    const rulePath: string = path.resolve(ruleProviderDir, `${ruleName}.d.ts`);
-    let ruleContent: string = "import type { RuleConfig } from '../rule-config';";
+    for (const [ruleName, { meta }] of Object.entries(rules)) {
+      const rulePath: string = path.resolve(ruleProviderDir, `${ruleName}.d.ts`);
+      let ruleContent: string = "import type { RuleConfig } from '../rule-config';";
 
-    const ruleNamePascalCase: string = pascalCase(ruleName);
+      const ruleNamePascalCase: string = pascalCase(ruleName);
 
-    const description: string = upperCaseFirst(meta?.docs?.description ?? '');
-    const seeDocLink: string = meta?.docs?.url ? `@see [${ruleName}](${meta.docs.url})` : '';
+      const description: string = upperCaseFirst(meta?.docs?.description ?? '');
+      const seeDocLink: string = meta?.docs?.url ? `@see [${ruleName}](${meta.docs.url})` : '';
 
-    const schema: JSONSchema4 | JSONSchema4[] | undefined = meta?.schema;
-    const mainSchema: JSONSchema4 | undefined = Array.isArray(schema) ? schema[0] : schema;
-    const sideSchema: JSONSchema4 | undefined =
-      schema && Array.isArray(schema) && schema.length > 1 ? schema[1] : undefined;
-    // TODO: vue/max-len has also a third schema
-    if (mainSchema) {
-      if (sideSchema) {
-        ruleContent += `
+      const schema: JSONSchema4 | JSONSchema4[] | undefined = meta?.schema;
+      const mainSchema: JSONSchema4 | undefined = Array.isArray(schema) ? schema[0] : schema;
+      const sideSchema: JSONSchema4 | undefined =
+        schema && Array.isArray(schema) && schema.length > 1 ? schema[1] : undefined;
+      // TODO: vue/max-len has also a third schema
+      if (mainSchema) {
+        if (sideSchema) {
+          ruleContent += `
 
 /**
  * Config.
  */
 export type ${ruleNamePascalCase}Config = ${generateOptionType(sideSchema)}`;
-      }
+        }
 
-      ruleContent += `
+        const ruleOption: string = await compile(mainSchema, `${ruleNamePascalCase}Option`, {
+          bannerComment: '',
+          style: {
+            bracketSpacing: true,
+            printWidth: 120,
+            semi: true,
+            singleQuote: true,
+            tabWidth: 2,
+            trailingComma: 'none',
+            useTabs: false
+          },
+          unknownAny: false
+        });
+
+        ruleContent += `
 
 /**
  * Option.
  */
-export type ${ruleNamePascalCase}Option = ${generateOptionType(mainSchema)}
+${ruleOption}
 
 /**
  * Options.
  */
 export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?${
-        sideSchema ? `, ${ruleNamePascalCase}Config?` : ''
-      }];`;
-    }
+          sideSchema ? `, ${ruleNamePascalCase}Config?` : ''
+        }];`;
+      }
 
-    // TODO: Add third option
+      // TODO: Add third option
 
-    ruleContent += `
+      ruleContent += `
 
   /**
    * ${description}
@@ -191,27 +207,36 @@ export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?${
     '${camelCase(pluginName)}/${ruleName}': ${ruleNamePascalCase}RuleConfig;
   }
   `;
-    ruleContent = format(ruleContent, PRETTIER_OPTIONS);
-    fs.writeFileSync(rulePath, ruleContent);
-  });
+      ruleContent = format(ruleContent, PRETTIER_OPTIONS);
+      fs.writeFileSync(rulePath, ruleContent);
+    }
 
-  // Generating index.d.ts for rules
-  const indexPath: string = path.resolve(ruleProviderDir, 'index.d.ts');
-  let indexContent: string = Object.keys(rules)
-    .map((name) => `import type { ${pascalCase(name)}Rule } from './${name}';`)
-    .join('\n');
+    // Generating index.d.ts for rules
+    const indexPath: string = path.resolve(ruleProviderDir, 'index.d.ts');
+    let indexContent: string = Object.keys(rules)
+      .map((name) => `import type { ${pascalCase(name)}Rule } from './${name}';`)
+      .join('\n');
 
-  indexContent += `
+    indexContent += `
 
 /**
  * All ${name} rules.
  */
 export type ${name}Rules = ${Object.keys(rules)
-    .map((name) => `${pascalCase(name)}Rule`)
-    .join(' & ')}
+      .map((name) => `${pascalCase(name)}Rule`)
+      .join(' & ')}
 `;
 
-  indexContent = format(indexContent, PRETTIER_OPTIONS);
+    indexContent = format(indexContent, PRETTIER_OPTIONS);
 
-  fs.writeFileSync(indexPath, indexContent);
+    fs.writeFileSync(indexPath, indexContent);
+  }
 }
+
+main()
+  .then(() => {
+    //
+  })
+  .catch(() => {
+    //
+  });

src/rules/jsdoc/check-examples.d.ts

@@ -3,9 +3,11 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type CheckExamplesOption = {
+export interface CheckExamplesOption {
   allowInlineConfig?: boolean;
-  baseConfig?: Record<string, any>;
+  baseConfig?: {
+    [k: string]: any;
+  };
   captionRequired?: boolean;
   checkDefaults?: boolean;
   checkEslintrc?: boolean;
@@ -21,7 +23,7 @@ export type CheckExamplesOption = {
   paddedIndent?: number;
   rejectExampleCodeRegex?: string;
   reportUnusedDisableDirectives?: boolean;
-};
+}
 
 /**
  * Options.

src/rules/jsdoc/check-indentation.d.ts

@@ -3,9 +3,9 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type CheckIndentationOption = {
+export interface CheckIndentationOption {
   excludeTags?: string[];
-};
+}
 
 /**
  * Options.

src/rules/jsdoc/check-param-names.d.ts

@@ -3,15 +3,15 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type CheckParamNamesOption = {
+export interface CheckParamNamesOption {
   allowExtraTrailingParamDocs?: boolean;
   checkDestructured?: boolean;
   checkRestProperty?: boolean;
   checkTypesPattern?: string;
   disableExtraPropertyReporting?: boolean;
   enableFixer?: boolean;
   useDefaultObjectProperties?: boolean;
-};
+}
 
 /**
  * Options.

src/rules/jsdoc/check-property-names.d.ts

@@ -3,9 +3,9 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type CheckPropertyNamesOption = {
+export interface CheckPropertyNamesOption {
   enableFixer?: boolean;
-};
+}
 
 /**
  * Options.

src/rules/jsdoc/check-tag-names.d.ts

@@ -3,10 +3,10 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type CheckTagNamesOption = {
+export interface CheckTagNamesOption {
   definedTags?: string[];
   jsxTags?: boolean;
-};
+}
 
 /**
  * Options.

src/rules/jsdoc/check-types.d.ts

@@ -3,11 +3,14 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type CheckTypesOption = {
-  exemptTagContexts?: any[];
+export interface CheckTypesOption {
+  exemptTagContexts?: {
+    tag?: string;
+    types?: boolean | string[];
+  }[];
   noDefaults?: boolean;
   unifyParentAndChildTypeChecks?: boolean;
-};
+}
 
 /**
  * Options.

src/rules/jsdoc/check-values.d.ts

@@ -3,12 +3,12 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type CheckValuesOption = {
+export interface CheckValuesOption {
   allowedAuthors?: string[];
-  allowedLicenses?: any;
+  allowedLicenses?: string[] | boolean;
   licensePattern?: string;
   numericOnlyVariation?: boolean;
-};
+}
 
 /**
  * Options.