Generate config from side schema

Author: Shinigami92

scripts/generate-files.ts

@@ -137,6 +137,15 @@ for (const pluginName in generationMap) {
     }
     // TODO: vue/max-len has also a third schema
     if (mainSchema) {
+      if (sideSchema) {
+        ruleContent += `
+
+/**
+ * Config.
+ */
+export type ${ruleNamePascalCase}Config = ${generateOptionType(sideSchema)}`;
+      }
+
       ruleContent += `
 
 /**
@@ -147,7 +156,9 @@ export type ${ruleNamePascalCase}Option = ${generateOptionType(mainSchema)}
 /**
  * Options.
  */
-export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?];`;
+export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?${
+        sideSchema ? `, ${ruleNamePascalCase}Config?` : ''
+      }];`;
     }
 
     // TODO: Add side and third option

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

@@ -1,5 +1,14 @@
 import type { RuleConfig } from '../rule-config';
 
+/**
+ * Config.
+ */
+export type CheckLineAlignmentConfig = {
+  customSpacings?: any;
+  preserveMainDescriptionPostDelimiter?: boolean;
+  tags?: any[];
+};
+
 /**
  * Option.
  */
@@ -8,7 +17,7 @@ export type CheckLineAlignmentOption = 'always' | 'never';
 /**
  * Options.
  */
-export type CheckLineAlignmentOptions = [CheckLineAlignmentOption?];
+export type CheckLineAlignmentOptions = [CheckLineAlignmentOption?, CheckLineAlignmentConfig?];
 
 /**
  * Reports invalid alignment of JSDoc block lines.

src/rules/jsdoc/match-description.d.ts

@@ -4,6 +4,14 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type MatchDescriptionOption = {
+  /**
+   * Set this to an array of strings representing the AST context where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
+   *
+   * Set to `"any"` if you want the rule to apply to any jsdoc block throughout your files.
+   *
+   * @see [contexts](https://github.com/gajus/eslint-plugin-jsdoc#contexts-1)
+   */
+  contexts?: string[];
   /**
    * If you wish to override the main function description without changing the default `match-description`, you may use `mainDescription`.
    *
@@ -16,14 +24,7 @@ export type MatchDescriptionOption = {
    * @see [matchDescription](https://github.com/gajus/eslint-plugin-jsdoc#matchdescription)
    */
   matchDescription?: string;
-  /**
-   * Set this to an array of strings representing the AST context where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
-   *
-   * Set to `"any"` if you want the rule to apply to any jsdoc block throughout your files.
-   *
-   * @see [contexts](https://github.com/gajus/eslint-plugin-jsdoc#contexts-1)
-   */
-  contexts?: string[];
+  message?: string;
   /**
    * If you want different regular expressions to apply to tags, you may use the `tags` option object.
    *
@@ -40,20 +41,20 @@ export type MatchDescriptionOptions = [MatchDescriptionOption?];
 /**
  * Enforces a regular expression pattern on descriptions.
  *
- * @see [match-description](https://github.com/gajus/eslint-plugin-jsdoc#match-description)
+ * @see [match-description](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-description)
  */
 export type MatchDescriptionRuleConfig = RuleConfig<MatchDescriptionOptions>;
 
 /**
  * Enforces a regular expression pattern on descriptions.
  *
- * @see [match-description](https://github.com/gajus/eslint-plugin-jsdoc#match-description)
+ * @see [match-description](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-description)
  */
 export interface MatchDescriptionRule {
   /**
    * Enforces a regular expression pattern on descriptions.
    *
-   * @see [match-description](https://github.com/gajus/eslint-plugin-jsdoc#match-description)
+   * @see [match-description](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-description)
    */
   'jsdoc/match-description': MatchDescriptionRuleConfig;
 }

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

@@ -20,7 +20,7 @@ export type NoTypesOptions = [NoTypesOption?];
  *
  * The rule is intended to prevent the indication of types on tags where the type information would be redundant with TypeScript.
  *
- * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#no-types)
+ * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-types)
  */
 export type NoTypesRuleConfig = RuleConfig<NoTypesOptions>;
 
@@ -29,15 +29,15 @@ export type NoTypesRuleConfig = RuleConfig<NoTypesOptions>;
  *
  * The rule is intended to prevent the indication of types on tags where the type information would be redundant with TypeScript.
  *
- * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#no-types)
+ * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-types)
  */
 export interface NoTypesRule {
   /**
    * This rule reports types being used on `@param` or `@returns`.
    *
    * The rule is intended to prevent the indication of types on tags where the type information would be redundant with TypeScript.
    *
-   * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#no-types)
+   * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-types)
    */
   'jsdoc/no-types': NoTypesRuleConfig;
 }

src/rules/jsdoc/require-asterisk-prefix.d.ts

@@ -1,5 +1,12 @@
 import type { RuleConfig } from '../rule-config';
 
+/**
+ * Config.
+ */
+export type RequireAsteriskPrefixConfig = {
+  tags?: Record<string, any>;
+};
+
 /**
  * Option.
  */
@@ -8,7 +15,7 @@ export type RequireAsteriskPrefixOption = 'always' | 'never' | 'any';
 /**
  * Options.
  */
-export type RequireAsteriskPrefixOptions = [RequireAsteriskPrefixOption?];
+export type RequireAsteriskPrefixOptions = [RequireAsteriskPrefixOption?, RequireAsteriskPrefixConfig?];
 
 /**
  *

src/rules/jsdoc/require-hyphen-before-param-description.d.ts

@@ -1,5 +1,12 @@
 import type { RuleConfig } from '../rule-config';
 
+/**
+ * Config.
+ */
+export type RequireHyphenBeforeParamDescriptionConfig = {
+  tags?: any;
+};
+
 /**
  * Option.
  */
@@ -8,7 +15,10 @@ export type RequireHyphenBeforeParamDescriptionOption = 'always' | 'never';
 /**
  * Options.
  */
-export type RequireHyphenBeforeParamDescriptionOptions = [RequireHyphenBeforeParamDescriptionOption?];
+export type RequireHyphenBeforeParamDescriptionOptions = [
+  RequireHyphenBeforeParamDescriptionOption?,
+  RequireHyphenBeforeParamDescriptionConfig?
+];
 
 /**
  * Requires a hyphen before the `@param` description.

src/rules/jsdoc/require-jsdoc.d.ts

@@ -4,6 +4,36 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 export type RequireJsdocOption = {
+  /**
+   * A value indicating whether `constructors` should be checked.
+   *
+   * When `true`, `exemptEmptyConstructors` may still avoid reporting when no parameters or return values are found.
+   *
+   * @default true
+   *
+   * @see [checkConstructors](https://github.com/gajus/eslint-plugin-jsdoc#checkconstructors)
+   */
+  checkConstructors?: boolean;
+  /**
+   * A value indicating whether getters should be checked.
+   *
+   * Besides setting as a boolean, this option can be set to the string `"no-setter"` to indicate that getters should be checked but only when there is no setter. This may be useful if one only wishes documentation on one of the two accessors.
+   *
+   * @default false
+   *
+   * @see [checkGetters](https://github.com/gajus/eslint-plugin-jsdoc#checkgetters)
+   */
+  checkGetters?: boolean;
+  /**
+   * A value indicating whether setters should be checked.
+   *
+   * Besides setting as a boolean, this option can be set to the string `"no-getter"` to indicate that setters should be checked but only when there is no getter. This may be useful if one only wishes documentation on one of the two accessors.
+   *
+   * @default false
+   *
+   * @see [checkSetters](https://github.com/gajus/eslint-plugin-jsdoc#checksetters)
+   */
+  checkSetters?: boolean;
   /**
    * Set this to an array of strings or objects representing the additional AST contexts where you wish the rule to be applied (e.g., `Property` for properties).
    *
@@ -24,6 +54,31 @@ export type RequireJsdocOption = {
         inlineCommentBlock?: boolean;
       }
   >;
+  /**
+   * A boolean on whether to enable the fixer (which adds an empty jsdoc block).
+   *
+   * @default true
+   *
+   * @see [enableFixer](https://github.com/gajus/eslint-plugin-jsdoc#enablefixer)
+   */
+  enableFixer?: boolean;
+  /**
+   * When `true`, the rule will not report missing jsdoc blocks above constructors with no parameters or return values (this is enabled by default as the class name or description should be seen as sufficient to convey intent).
+   *
+   * @default true
+   *
+   * @see [exemptEmptyConstructors](https://github.com/gajus/eslint-plugin-jsdoc#exemptemptyconstructors)
+   */
+  exemptEmptyConstructors?: boolean;
+  /**
+   * When `true`, the rule will not report missing jsdoc blocks above functions/methods with no parameters or return values (intended where function/method names are sufficient for themselves as documentation).
+   *
+   * @default false
+   *
+   * @see [exemptEmptyFunctions](https://github.com/gajus/eslint-plugin-jsdoc#exemptemptyfunctions)
+   */
+  exemptEmptyFunctions?: boolean;
+  fixerMessage?: string;
   /**
    * @see [publicOnly](https://github.com/gajus/eslint-plugin-jsdoc#publiconly)
    */
@@ -84,60 +139,6 @@ export type RequireJsdocOption = {
      */
     MethodDefinition?: boolean;
   };
-  /**
-   * When `true`, the rule will not report missing jsdoc blocks above constructors with no parameters or return values (this is enabled by default as the class name or description should be seen as sufficient to convey intent).
-   *
-   * @default true
-   *
-   * @see [exemptEmptyConstructors](https://github.com/gajus/eslint-plugin-jsdoc#exemptemptyconstructors)
-   */
-  exemptEmptyConstructors?: boolean;
-  /**
-   * When `true`, the rule will not report missing jsdoc blocks above functions/methods with no parameters or return values (intended where function/method names are sufficient for themselves as documentation).
-   *
-   * @default false
-   *
-   * @see [exemptEmptyFunctions](https://github.com/gajus/eslint-plugin-jsdoc#exemptemptyfunctions)
-   */
-  exemptEmptyFunctions?: boolean;
-  /**
-   * A value indicating whether `constructors` should be checked.
-   *
-   * When `true`, `exemptEmptyConstructors` may still avoid reporting when no parameters or return values are found.
-   *
-   * @default true
-   *
-   * @see [checkConstructors](https://github.com/gajus/eslint-plugin-jsdoc#checkconstructors)
-   */
-  checkConstructors?: boolean;
-  /**
-   * A value indicating whether getters should be checked.
-   *
-   * Besides setting as a boolean, this option can be set to the string `"no-setter"` to indicate that getters should be checked but only when there is no setter. This may be useful if one only wishes documentation on one of the two accessors.
-   *
-   * @default false
-   *
-   * @see [checkGetters](https://github.com/gajus/eslint-plugin-jsdoc#checkgetters)
-   */
-  checkGetters?: boolean;
-  /**
-   * A value indicating whether setters should be checked.
-   *
-   * Besides setting as a boolean, this option can be set to the string `"no-getter"` to indicate that setters should be checked but only when there is no getter. This may be useful if one only wishes documentation on one of the two accessors.
-   *
-   * @default false
-   *
-   * @see [checkSetters](https://github.com/gajus/eslint-plugin-jsdoc#checksetters)
-   */
-  checkSetters?: boolean;
-  /**
-   * A boolean on whether to enable the fixer (which adds an empty jsdoc block).
-   *
-   * @default true
-   *
-   * @see [enableFixer](https://github.com/gajus/eslint-plugin-jsdoc#enablefixer)
-   */
-  enableFixer?: boolean;
 };
 
 /**
@@ -148,20 +149,20 @@ export type RequireJsdocOptions = [RequireJsdocOption?];
 /**
  * Checks for presence of jsdoc comments, on class declarations as well as functions.
  *
- * @see [require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc#require-jsdoc)
+ * @see [require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc)
  */
 export type RequireJsdocRuleConfig = RuleConfig<RequireJsdocOptions>;
 
 /**
  * Checks for presence of jsdoc comments, on class declarations as well as functions.
  *
- * @see [require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc#require-jsdoc)
+ * @see [require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc)
  */
 export interface RequireJsdocRule {
   /**
    * Checks for presence of jsdoc comments, on class declarations as well as functions.
    *
-   * @see [require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc#require-jsdoc)
+   * @see [require-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc)
    */
   'jsdoc/require-jsdoc': RequireJsdocRuleConfig;
 }

src/rules/jsdoc/require-param-type.d.ts

@@ -24,20 +24,20 @@ export type RequireParamTypeOptions = [RequireParamTypeOption?];
 /**
  * Requires that each `@param` tag has a `type` value.
  *
- * @see [require-param-type](https://github.com/gajus/eslint-plugin-jsdoc#require-param-type)
+ * @see [require-param-type](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type)
  */
 export type RequireParamTypeRuleConfig = RuleConfig<RequireParamTypeOptions>;
 
 /**
  * Requires that each `@param` tag has a `type` value.
  *
- * @see [require-param-type](https://github.com/gajus/eslint-plugin-jsdoc#require-param-type)
+ * @see [require-param-type](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type)
  */
 export interface RequireParamTypeRule {
   /**
    * Requires that each `@param` tag has a `type` value.
    *
-   * @see [require-param-type](https://github.com/gajus/eslint-plugin-jsdoc#require-param-type)
+   * @see [require-param-type](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type)
    */
   'jsdoc/require-param-type': RequireParamTypeRuleConfig;
 }

src/rules/jsdoc/require-returns-type.d.ts

@@ -24,20 +24,20 @@ export type RequireReturnsTypeOptions = [RequireReturnsTypeOption?];
 /**
  * Requires that `@returns` tag has `type` value.
  *
- * @see [require-returns-type](https://github.com/gajus/eslint-plugin-jsdoc#require-returns-type)
+ * @see [require-returns-type](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type)
  */
 export type RequireReturnsTypeRuleConfig = RuleConfig<RequireReturnsTypeOptions>;
 
 /**
  * Requires that `@returns` tag has `type` value.
  *
- * @see [require-returns-type](https://github.com/gajus/eslint-plugin-jsdoc#require-returns-type)
+ * @see [require-returns-type](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type)
  */
 export interface RequireReturnsTypeRule {
   /**
    * Requires that `@returns` tag has `type` value.
    *
-   * @see [require-returns-type](https://github.com/gajus/eslint-plugin-jsdoc#require-returns-type)
+   * @see [require-returns-type](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type)
    */
   'jsdoc/require-returns-type': RequireReturnsTypeRuleConfig;
 }