Generate TypeScript rules

Author: Shinigami92

scripts/generate-rule-files.ts

@@ -1,3 +1,5 @@
+// @ts-expect-error
+import eslintPluginTypeScript from '@typescript-eslint/eslint-plugin';
 import { camelCase, pascalCase } from 'change-case';
 import type { Rule } from 'eslint';
 // @ts-expect-error
@@ -16,6 +18,7 @@ import { upperCaseFirst } from 'upper-case-first';
 
 interface Plugin {
   name: string;
+  prefix?: string;
   rules: Record<string, Rule.RuleModule>;
 }
 
@@ -40,6 +43,11 @@ const generationMap: Record<string, Plugin> = {
     name: 'Spellcheck',
     rules: (eslintPluginSpellcheck as Plugin).rules
   },
+  'typescript-eslint': {
+    name: 'TypeScript',
+    prefix: '@typescript-eslint',
+    rules: (eslintPluginTypeScript as Plugin).rules
+  },
   vue: {
     name: 'Vue',
     rules: (eslintPluginVue as Plugin).rules
@@ -51,7 +59,7 @@ const rulesDir: string = path.resolve(__dirname, '../src/rules');
 
 async function main(): Promise<void> {
   for (const pluginName in generationMap) {
-    const { rules, name } = generationMap[pluginName]!;
+    const { rules, name, prefix } = generationMap[pluginName]!;
 
     const ruleProviderDir: string = path.resolve(rulesDir, pluginName);
 
@@ -63,7 +71,10 @@ async function main(): Promise<void> {
 
       const ruleNamePascalCase: string = pascalCase(ruleName);
 
-      const description: string = upperCaseFirst(meta?.docs?.description ?? '');
+      let description: string = upperCaseFirst(meta?.docs?.description ?? '');
+      if (description.length > 0 && !description.endsWith('.')) {
+        description += '.';
+      }
       const seeDocLink: string = meta?.docs?.url ? `@see [${ruleName}](${meta.docs.url})` : '';
 
       const schema: JSONSchema4 | JSONSchema4[] | undefined = meta?.schema;
@@ -167,7 +178,7 @@ export type ${ruleNamePascalCase}Options = [${ruleNamePascalCase}Option?${
      *
      * ${seeDocLink}
      */
-    '${camelCase(pluginName)}/${ruleName}': ${ruleNamePascalCase}RuleConfig;
+    '${prefix ?? camelCase(pluginName)}/${ruleName}': ${ruleNamePascalCase}RuleConfig;
   }
   `;
       ruleContent = format(ruleContent, PRETTIER_OPTIONS);
@@ -200,6 +211,6 @@ main()
   .then(() => {
     //
   })
-  .catch(() => {
-    //
+  .catch((error) => {
+    console.log('Failed to generate rule files.', error);
   });

src/rules/index.d.ts

@@ -4,7 +4,7 @@ import type { JSDocRules } from './jsdoc';
 import type { NodeRules } from './node';
 import type { RuleConfig } from './rule-config';
 import type { SpellcheckRules } from './spellcheck';
-import type { TypeScriptEslintRules } from './typescript-eslint';
+import type { TypeScriptRules } from './typescript-eslint';
 import type { VueRules } from './vue';
 
 /**
@@ -14,7 +14,7 @@ import type { VueRules } from './vue';
  */
 export type Rules = Partial<
   EslintRules &
-    TypeScriptEslintRules &
+    TypeScriptRules &
     NodeRules &
     ImportRules &
     JSDocRules &

src/rules/typescript-eslint/adjacent-overload-signatures.d.ts

@@ -3,20 +3,20 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Require that member overloads be consecutive.
  *
- * @see [adjacent-overload-signatures](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md)
+ * @see [adjacent-overload-signatures](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md)
  */
 export type AdjacentOverloadSignaturesRuleConfig = RuleConfig<[]>;
 
 /**
  * Require that member overloads be consecutive.
  *
- * @see [adjacent-overload-signatures](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md)
+ * @see [adjacent-overload-signatures](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md)
  */
 export interface AdjacentOverloadSignaturesRule {
   /**
    * Require that member overloads be consecutive.
    *
-   * @see [adjacent-overload-signatures](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md)
+   * @see [adjacent-overload-signatures](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md)
    */
   '@typescript-eslint/adjacent-overload-signatures': AdjacentOverloadSignaturesRuleConfig;
 }

src/rules/typescript-eslint/array-type.d.ts

@@ -1,29 +1,25 @@
 import type { RuleConfig } from '../rule-config';
 
-/**
- * Array Option.
- */
-export type ArrayOption = 'array' | 'generic' | 'array-simple';
-
 /**
  * Option.
  */
-export type ArrayTypeOption = {
+export interface ArrayTypeOption {
   /**
    * Sets the array type expected for mutable cases.
    *
    * @default 'array'
    *
    * @see [default](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md#options)
    */
-  default: ArrayOption;
+  default?: 'array' | 'generic' | 'array-simple';
   /**
    * Sets the array type expected for readonly arrays. If this is omitted, then the value for default will be used.
    *
    * @see [readonly](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md#options)
    */
-  readonly?: ArrayOption;
-};
+  readonly?: 'array' | 'generic' | 'array-simple';
+  [k: string]: any;
+}
 
 /**
  * Options.
@@ -33,20 +29,20 @@ export type ArrayTypeOptions = [ArrayTypeOption?];
 /**
  * Requires using either `T[]` or `Array<T>` for arrays.
  *
- * @see [array-type](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md)
+ * @see [array-type](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/array-type.md)
  */
 export type ArrayTypeRuleConfig = RuleConfig<ArrayTypeOptions>;
 
 /**
  * Requires using either `T[]` or `Array<T>` for arrays.
  *
- * @see [array-type](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md)
+ * @see [array-type](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/array-type.md)
  */
 export interface ArrayTypeRule {
   /**
    * Requires using either `T[]` or `Array<T>` for arrays.
    *
-   * @see [array-type](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md)
+   * @see [array-type](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/array-type.md)
    */
   '@typescript-eslint/array-type': ArrayTypeRuleConfig;
 }

src/rules/typescript-eslint/await-thenable.d.ts

@@ -3,20 +3,20 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Disallows awaiting a value that is not a Thenable.
  *
- * @see [await-thenable](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/await-thenable.md)
+ * @see [await-thenable](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/await-thenable.md)
  */
 export type AwaitThenableRuleConfig = RuleConfig<[]>;
 
 /**
  * Disallows awaiting a value that is not a Thenable.
  *
- * @see [await-thenable](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/await-thenable.md)
+ * @see [await-thenable](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/await-thenable.md)
  */
 export interface AwaitThenableRule {
   /**
    * Disallows awaiting a value that is not a Thenable.
    *
-   * @see [await-thenable](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/await-thenable.md)
+   * @see [await-thenable](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/await-thenable.md)
    */
   '@typescript-eslint/await-thenable': AwaitThenableRuleConfig;
 }

src/rules/typescript-eslint/ban-ts-comment.d.ts

@@ -3,13 +3,13 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type BanTsCommentOption = {
+export interface BanTsCommentOption {
   'ts-expect-error'?: boolean | 'allow-with-description';
   'ts-ignore'?: boolean | 'allow-with-description';
   'ts-nocheck'?: boolean | 'allow-with-description';
   'ts-check'?: boolean | 'allow-with-description';
   minimumDescriptionLength?: number;
-};
+}
 
 /**
  * Options.
@@ -19,20 +19,20 @@ export type BanTsCommentOptions = [BanTsCommentOption?];
 /**
  * Bans `@ts-<directive>` comments from being used or requires descriptions after directive.
  *
- * @see [ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-ts-comment.md)
+ * @see [ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-ts-comment.md)
  */
 export type BanTsCommentRuleConfig = RuleConfig<BanTsCommentOptions>;
 
 /**
  * Bans `@ts-<directive>` comments from being used or requires descriptions after directive.
  *
- * @see [ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-ts-comment.md)
+ * @see [ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-ts-comment.md)
  */
 export interface BanTsCommentRule {
   /**
    * Bans `@ts-<directive>` comments from being used or requires descriptions after directive.
    *
-   * @see [ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-ts-comment.md)
+   * @see [ban-ts-comment](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-ts-comment.md)
    */
   '@typescript-eslint/ban-ts-comment': BanTsCommentRuleConfig;
 }

src/rules/typescript-eslint/ban-tslint-comment.d.ts

@@ -0,0 +1,22 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Bans `// tslint:<rule-flag>` comments from being used.
+ *
+ * @see [ban-tslint-comment](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-tslint-comment.md)
+ */
+export type BanTslintCommentRuleConfig = RuleConfig<[]>;
+
+/**
+ * Bans `// tslint:<rule-flag>` comments from being used.
+ *
+ * @see [ban-tslint-comment](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-tslint-comment.md)
+ */
+export interface BanTslintCommentRule {
+  /**
+   * Bans `// tslint:<rule-flag>` comments from being used.
+   *
+   * @see [ban-tslint-comment](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-tslint-comment.md)
+   */
+  '@typescript-eslint/ban-tslint-comment': BanTslintCommentRuleConfig;
+}

src/rules/typescript-eslint/ban-types.d.ts

@@ -3,39 +3,39 @@ import type { RuleConfig } from '../rule-config';
 /**
  * Option.
  */
-export type BanTypesOption = {
+export interface BanTypesOption {
   /**
    * An object whose keys are the types you want to ban, and the values are error messages.
    *
    * @see [types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
    */
-  types?: Record<
-    string,
-    | false
-    | string
-    | {
-        /**
-         * The message to display when the type is matched.
-         *
-         * @see [types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
-         */
-        message: string;
-        /**
-         * A string to replace the banned type with when the fixer is run. If this is omitted, no fix will be done.
-         *
-         * @see [types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
-         */
-        fixWith?: string;
-      }
-  >;
-
+  types?: {
+    [k: string]:
+      | null
+      | boolean
+      | string
+      | {
+          /**
+           * The message to display when the type is matched.
+           *
+           * @see [types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
+           */
+          message?: string;
+          /**
+           * A string to replace the banned type with when the fixer is run. If this is omitted, no fix will be done.
+           *
+           * @see [types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
+           */
+          fixWith?: string;
+        };
+  };
   /**
    * If you're specifying custom `types`, you can set this to `true` to extend the default types configuration.
    *
    * @see [extendDefaults](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
    */
   extendDefaults?: boolean;
-};
+}
 
 /**
  * Options.
@@ -45,20 +45,20 @@ export type BanTypesOptions = [BanTypesOption?];
 /**
  * Bans specific types from being used.
  *
- * @see [ban-types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
+ * @see [ban-types](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-types.md)
  */
 export type BanTypesRuleConfig = RuleConfig<BanTypesOptions>;
 
 /**
  * Bans specific types from being used.
  *
- * @see [ban-types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
+ * @see [ban-types](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-types.md)
  */
 export interface BanTypesRule {
   /**
    * Bans specific types from being used.
    *
-   * @see [ban-types](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/ban-types.md)
+   * @see [ban-types](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/ban-types.md)
    */
   '@typescript-eslint/ban-types': BanTypesRuleConfig;
 }

src/rules/typescript-eslint/brace-style.d.ts

@@ -0,0 +1,39 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Config.
+ */
+export interface BraceStyleConfig {
+  allowSingleLine?: boolean;
+}
+
+/**
+ * Option.
+ */
+export type BraceStyleOption = '1tbs' | 'stroustrup' | 'allman';
+
+/**
+ * Options.
+ */
+export type BraceStyleOptions = [BraceStyleOption?, BraceStyleConfig?];
+
+/**
+ * Enforce consistent brace style for blocks.
+ *
+ * @see [brace-style](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/brace-style.md)
+ */
+export type BraceStyleRuleConfig = RuleConfig<BraceStyleOptions>;
+
+/**
+ * Enforce consistent brace style for blocks.
+ *
+ * @see [brace-style](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/brace-style.md)
+ */
+export interface BraceStyleRule {
+  /**
+   * Enforce consistent brace style for blocks.
+   *
+   * @see [brace-style](https://github.com/typescript-eslint/typescript-eslint/blob/v4.31.2/packages/eslint-plugin/docs/rules/brace-style.md)
+   */
+  '@typescript-eslint/brace-style': BraceStyleRuleConfig;
+}