Improve jsdoc generation

Author: Shinigami92

package.json

@@ -54,6 +54,7 @@
     "np": "~7.5.0",
     "prettier": "2.4.1",
     "prettier-plugin-organize-imports": "~2.3.4",
-    "typescript": "~4.4.3"
+    "typescript": "~4.4.3",
+    "upper-case-first": "~2.0.2"
   }
 }

scripts/generate-files.ts

@@ -3,12 +3,15 @@ import type { Rule } from 'eslint';
 // @ts-expect-error
 import eslintPluginJSDoc from 'eslint-plugin-jsdoc';
 // @ts-expect-error
+import eslintPluginSpellcheck from 'eslint-plugin-spellcheck';
+// @ts-expect-error
 import eslintPluginVue from 'eslint-plugin-vue';
 import * as fs from 'fs';
 import type { JSONSchema4 } from 'json-schema';
 import * as path from 'path';
 import type { Options } from 'prettier';
 import { format } from 'prettier';
+import { upperCaseFirst } from 'upper-case-first';
 
 interface Plugin {
   name: string;
@@ -32,6 +35,10 @@ const generationMap: Record<string, Plugin> = {
     name: 'JSDoc',
     rules: (eslintPluginJSDoc as Plugin).rules
   },
+  spellcheck: {
+    name: 'Spellcheck',
+    rules: (eslintPluginSpellcheck as Plugin).rules
+  },
   vue: {
     name: 'Vue',
     rules: (eslintPluginVue as Plugin).rules
@@ -52,6 +59,11 @@ for (const pluginName in generationMap) {
     const rulePath: string = path.resolve(ruleProviderDir, `${ruleName}.d.ts`);
     let ruleContent: string = "import type { RuleConfig } from '../rule-config';";
 
+    const ruleNamePascalCase: string = pascalCase(ruleName);
+
+    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 hasOptionProperties: boolean = !!mainSchema?.properties;
@@ -61,12 +73,12 @@ for (const pluginName in generationMap) {
 /**
  * Option.
  */
-export type ${pascalCase(ruleName)}Option = {`;
+export type ${ruleNamePascalCase}Option = {`;
 
       Object.entries(mainSchema.properties).forEach(([propertyName, propertyDefinition]) => {
         ruleContent += `
   /**
-   * @see [${ruleName}](${meta?.docs?.url})
+   * ${seeDocLink}
    */
   '${propertyName}'?: any;\n`;
       });
@@ -76,32 +88,32 @@ export type ${pascalCase(ruleName)}Option = {`;
 /**
  * Options.
  */
-export type ${pascalCase(ruleName)}Options = [${pascalCase(ruleName)}Option?];`;
+export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?];`;
     }
 
     ruleContent += `
 
   /**
-   * ${meta?.docs?.description}
+   * ${description}
    *
-   * @see [${ruleName}](${meta?.docs?.url})
+   * ${seeDocLink}
    */
-  export type ${pascalCase(ruleName)}RuleConfig = RuleConfig<${
-      hasOptionProperties ? `${pascalCase(ruleName)}Options` : '[]'
+  export type ${ruleNamePascalCase}RuleConfig = RuleConfig<${
+      hasOptionProperties ? `${ruleNamePascalCase}Options` : '[]'
     }>;
 
   /**
-   * ${meta?.docs?.description}
+   * ${description}
    *
-   * @see [${ruleName}](${meta?.docs?.url})
+   * ${seeDocLink}
    */
-  export interface ${pascalCase(ruleName)}Rule {
+  export interface ${ruleNamePascalCase}Rule {
     /**
-     * ${meta?.docs?.description}
+     * ${description}
      *
-     * @see [${ruleName}](${meta?.docs?.url})
+     * ${seeDocLink}
      */
-    '${camelCase(pluginName)}/${ruleName}': ${pascalCase(ruleName)}RuleConfig;
+    '${camelCase(pluginName)}/${ruleName}': ${ruleNamePascalCase}RuleConfig;
   }
   `;
     ruleContent = format(ruleContent, PRETTIER_OPTIONS);

src/rules/spellcheck/index.d.ts

@@ -1,6 +1,6 @@
 import type { SpellCheckerRule } from './spell-checker';
 
 /**
- * All spellcheck rules.
+ * All Spellcheck rules.
  */
 export type SpellcheckRules = SpellCheckerRule;

src/rules/vue/array-bracket-newline.d.ts

@@ -1,20 +1,20 @@
 import type { RuleConfig } from '../rule-config';
 
 /**
- * enforce linebreaks after opening and before closing array brackets
+ * Enforce linebreaks after opening and before closing array brackets
  *
  * @see [array-bracket-newline](https://eslint.vuejs.org/rules/array-bracket-newline.html)
  */
 export type ArrayBracketNewlineRuleConfig = RuleConfig<[]>;
 
 /**
- * enforce linebreaks after opening and before closing array brackets
+ * Enforce linebreaks after opening and before closing array brackets
  *
  * @see [array-bracket-newline](https://eslint.vuejs.org/rules/array-bracket-newline.html)
  */
 export interface ArrayBracketNewlineRule {
   /**
-   * enforce linebreaks after opening and before closing array brackets
+   * Enforce linebreaks after opening and before closing array brackets
    *
    * @see [array-bracket-newline](https://eslint.vuejs.org/rules/array-bracket-newline.html)
    */

src/rules/vue/array-bracket-spacing.d.ts

@@ -1,20 +1,20 @@
 import type { RuleConfig } from '../rule-config';
 
 /**
- * enforce consistent spacing inside array brackets
+ * Enforce consistent spacing inside array brackets
  *
  * @see [array-bracket-spacing](https://eslint.vuejs.org/rules/array-bracket-spacing.html)
  */
 export type ArrayBracketSpacingRuleConfig = RuleConfig<[]>;
 
 /**
- * enforce consistent spacing inside array brackets
+ * Enforce consistent spacing inside array brackets
  *
  * @see [array-bracket-spacing](https://eslint.vuejs.org/rules/array-bracket-spacing.html)
  */
 export interface ArrayBracketSpacingRule {
   /**
-   * enforce consistent spacing inside array brackets
+   * Enforce consistent spacing inside array brackets
    *
    * @see [array-bracket-spacing](https://eslint.vuejs.org/rules/array-bracket-spacing.html)
    */

src/rules/vue/arrow-spacing.d.ts

@@ -21,20 +21,20 @@ export type ArrowSpacingOption = {
 export type ArrowSpacingOptions = [ArrowSpacingOption?];
 
 /**
- * enforce consistent spacing before and after the arrow in arrow functions
+ * Enforce consistent spacing before and after the arrow in arrow functions
  *
  * @see [arrow-spacing](https://eslint.vuejs.org/rules/arrow-spacing.html)
  */
 export type ArrowSpacingRuleConfig = RuleConfig<ArrowSpacingOptions>;
 
 /**
- * enforce consistent spacing before and after the arrow in arrow functions
+ * Enforce consistent spacing before and after the arrow in arrow functions
  *
  * @see [arrow-spacing](https://eslint.vuejs.org/rules/arrow-spacing.html)
  */
 export interface ArrowSpacingRule {
   /**
-   * enforce consistent spacing before and after the arrow in arrow functions
+   * Enforce consistent spacing before and after the arrow in arrow functions
    *
    * @see [arrow-spacing](https://eslint.vuejs.org/rules/arrow-spacing.html)
    */

src/rules/vue/attribute-hyphenation.d.ts

@@ -1,20 +1,20 @@
 import type { RuleConfig } from '../rule-config';
 
 /**
- * enforce attribute naming style on custom components in template
+ * Enforce attribute naming style on custom components in template
  *
  * @see [attribute-hyphenation](https://eslint.vuejs.org/rules/attribute-hyphenation.html)
  */
 export type AttributeHyphenationRuleConfig = RuleConfig<[]>;
 
 /**
- * enforce attribute naming style on custom components in template
+ * Enforce attribute naming style on custom components in template
  *
  * @see [attribute-hyphenation](https://eslint.vuejs.org/rules/attribute-hyphenation.html)
  */
 export interface AttributeHyphenationRule {
   /**
-   * enforce attribute naming style on custom components in template
+   * Enforce attribute naming style on custom components in template
    *
    * @see [attribute-hyphenation](https://eslint.vuejs.org/rules/attribute-hyphenation.html)
    */

src/rules/vue/attributes-order.d.ts

@@ -21,20 +21,20 @@ export type AttributesOrderOption = {
 export type AttributesOrderOptions = [AttributesOrderOption?];
 
 /**
- * enforce order of attributes
+ * Enforce order of attributes
  *
  * @see [attributes-order](https://eslint.vuejs.org/rules/attributes-order.html)
  */
 export type AttributesOrderRuleConfig = RuleConfig<AttributesOrderOptions>;
 
 /**
- * enforce order of attributes
+ * Enforce order of attributes
  *
  * @see [attributes-order](https://eslint.vuejs.org/rules/attributes-order.html)
  */
 export interface AttributesOrderRule {
   /**
-   * enforce order of attributes
+   * Enforce order of attributes
    *
    * @see [attributes-order](https://eslint.vuejs.org/rules/attributes-order.html)
    */

src/rules/vue/block-lang.d.ts

@@ -1,20 +1,20 @@
 import type { RuleConfig } from '../rule-config';
 
 /**
- * disallow use other than available `lang`
+ * Disallow use other than available `lang`
  *
  * @see [block-lang](https://eslint.vuejs.org/rules/block-lang.html)
  */
 export type BlockLangRuleConfig = RuleConfig<[]>;
 
 /**
- * disallow use other than available `lang`
+ * Disallow use other than available `lang`
  *
  * @see [block-lang](https://eslint.vuejs.org/rules/block-lang.html)
  */
 export interface BlockLangRule {
   /**
-   * disallow use other than available `lang`
+   * Disallow use other than available `lang`
    *
    * @see [block-lang](https://eslint.vuejs.org/rules/block-lang.html)
    */

src/rules/vue/block-spacing.d.ts

@@ -1,20 +1,20 @@
 import type { RuleConfig } from '../rule-config';
 
 /**
- * disallow or enforce spaces inside of blocks after opening block and before closing block
+ * Disallow or enforce spaces inside of blocks after opening block and before closing block
  *
  * @see [block-spacing](https://eslint.vuejs.org/rules/block-spacing.html)
  */
 export type BlockSpacingRuleConfig = RuleConfig<[]>;
 
 /**
- * disallow or enforce spaces inside of blocks after opening block and before closing block
+ * Disallow or enforce spaces inside of blocks after opening block and before closing block
  *
  * @see [block-spacing](https://eslint.vuejs.org/rules/block-spacing.html)
  */
 export interface BlockSpacingRule {
   /**
-   * disallow or enforce spaces inside of blocks after opening block and before closing block
+   * Disallow or enforce spaces inside of blocks after opening block and before closing block
    *
    * @see [block-spacing](https://eslint.vuejs.org/rules/block-spacing.html)
    */