Improve option type generation

Author: Shinigami92

scripts/generate-files.ts

@@ -73,6 +73,45 @@ function generateType(propertyDefinition: JSONSchema4): string {
   return 'any';
 }
 
+function generateOptionType(schema: JSONSchema4): string {
+  let result: string = 'any';
+
+  switch (schema.type) {
+    case 'object':
+      if (schema.properties) {
+        result = '{\n';
+        result += Object.entries(schema.properties)
+          .map(([propertyName, propertyDefinition]) => `'${propertyName}'?: ${generateType(propertyDefinition)};`)
+          .join('\n');
+        result += '}';
+      } else {
+        // TODO: Identify further
+        result = 'Record<string, any>;';
+      }
+      break;
+    case 'string':
+      result = 'string;';
+      if (schema.enum) {
+        result = `'${schema.enum.join("' | '")}';`;
+      }
+      break;
+    case 'array':
+      result = 'any[];';
+      break;
+    case undefined:
+      if (schema.enum) {
+        result = `'${schema.enum.join("' | '")}';`;
+      }
+      // TODO: Identify further
+      break;
+    default:
+      // TODO: Something else?
+      break;
+  }
+
+  return result;
+}
+
 for (const pluginName in generationMap) {
   const { rules, name } = generationMap[pluginName]!;
 
@@ -91,41 +130,36 @@ for (const pluginName in generationMap) {
 
     const schema: JSONSchema4 | JSONSchema4[] | undefined = meta?.schema;
     const mainSchema: JSONSchema4 | undefined = Array.isArray(schema) ? schema[0] : schema;
-    const hasOptionProperties: boolean = !!mainSchema?.properties;
-    if (mainSchema?.properties) {
+    const sideSchema: JSONSchema4 | undefined =
+      schema && Array.isArray(schema) && schema.length > 1 ? schema[1] : undefined;
+    if (sideSchema) {
+      // console.log(pluginName, ruleName, mainSchema, sideSchema);
+    }
+    // TODO: vue/max-len has also a third schema
+    if (mainSchema) {
       ruleContent += `
 
 /**
  * Option.
  */
-export type ${ruleNamePascalCase}Option = {`;
-
-      Object.entries(mainSchema.properties).forEach(([propertyName, propertyDefinition]) => {
-        ruleContent += `
-  /**
-   * ${seeDocLink}
-   */
-  '${propertyName}'?: ${generateType(propertyDefinition)};\n`;
-      });
-
-      ruleContent += `}
+export type ${ruleNamePascalCase}Option = ${generateOptionType(mainSchema)}
 
 /**
  * Options.
  */
 export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?];`;
     }
 
+    // TODO: Add side and third option
+
     ruleContent += `
 
   /**
    * ${description}
    *
    * ${seeDocLink}
    */
-  export type ${ruleNamePascalCase}RuleConfig = RuleConfig<${
-      hasOptionProperties ? `${ruleNamePascalCase}Options` : '[]'
-    }>;
+  export type ${ruleNamePascalCase}RuleConfig = RuleConfig<${mainSchema ? `${ruleNamePascalCase}Options` : '[]'}>;
 
   /**
    * ${description}

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

@@ -4,89 +4,22 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type CheckExamplesOption = {
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   allowInlineConfig?: boolean;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   baseConfig?: Record<string, any>;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   captionRequired?: boolean;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   checkDefaults?: boolean;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   checkEslintrc?: boolean;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   checkParams?: boolean;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   checkProperties?: boolean;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   configFile?: string;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   exampleCodeRegex?: string;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   matchingFileName?: string;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   matchingFileNameDefaults?: string;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   matchingFileNameParams?: string;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   matchingFileNameProperties?: string;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   noDefaultExampleRules?: boolean;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   paddedIndent?: number;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   rejectExampleCodeRegex?: string;
-
-  /**
-   * @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
-   */
   reportUnusedDisableDirectives?: boolean;
 };
 

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

@@ -4,9 +4,6 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type CheckIndentationOption = {
-  /**
-   * @see [check-indentation](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation)
-   */
   excludeTags?: any[];
 };
 

src/rules/jsdoc/check-line-alignment.d.ts

@@ -1,11 +1,21 @@
 import type { RuleConfig } from '../rule-config';
 
+/**
+ * Option.
+ */
+export type CheckLineAlignmentOption = 'always' | 'never';
+
+/**
+ * Options.
+ */
+export type CheckLineAlignmentOptions = [CheckLineAlignmentOption?];
+
 /**
  * Reports invalid alignment of JSDoc block lines.
  *
  * @see [check-line-alignment](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment)
  */
-export type CheckLineAlignmentRuleConfig = RuleConfig<[]>;
+export type CheckLineAlignmentRuleConfig = RuleConfig<CheckLineAlignmentOptions>;
 
 /**
  * Reports invalid alignment of JSDoc block lines.

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

@@ -4,39 +4,12 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type CheckParamNamesOption = {
-  /**
-   * @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
-   */
   allowExtraTrailingParamDocs?: boolean;
-
-  /**
-   * @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
-   */
   checkDestructured?: boolean;
-
-  /**
-   * @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
-   */
   checkRestProperty?: boolean;
-
-  /**
-   * @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
-   */
   checkTypesPattern?: string;
-
-  /**
-   * @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
-   */
   disableExtraPropertyReporting?: boolean;
-
-  /**
-   * @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
-   */
   enableFixer?: boolean;
-
-  /**
-   * @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
-   */
   useDefaultObjectProperties?: boolean;
 };
 

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

@@ -4,9 +4,6 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type CheckPropertyNamesOption = {
-  /**
-   * @see [check-property-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names)
-   */
   enableFixer?: boolean;
 };
 

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

@@ -4,14 +4,7 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type CheckTagNamesOption = {
-  /**
-   * @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names)
-   */
   definedTags?: any[];
-
-  /**
-   * @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names)
-   */
   jsxTags?: boolean;
 };
 

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

@@ -4,19 +4,8 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type CheckTypesOption = {
-  /**
-   * @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types)
-   */
   exemptTagContexts?: any[];
-
-  /**
-   * @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types)
-   */
   noDefaults?: boolean;
-
-  /**
-   * @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types)
-   */
   unifyParentAndChildTypeChecks?: boolean;
 };
 

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

@@ -4,24 +4,9 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type CheckValuesOption = {
-  /**
-   * @see [check-values](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values)
-   */
   allowedAuthors?: any[];
-
-  /**
-   * @see [check-values](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values)
-   */
   allowedLicenses?: any;
-
-  /**
-   * @see [check-values](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values)
-   */
   licensePattern?: string;
-
-  /**
-   * @see [check-values](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values)
-   */
   numericOnlyVariation?: boolean;
 };
 

src/rules/jsdoc/empty-tags.d.ts

@@ -4,9 +4,6 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type EmptyTagsOption = {
-  /**
-   * @see [empty-tags](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-empty-tags)
-   */
   tags?: any[];
 };