Update typescript-eslint rules

Author: Shinigami92

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

@@ -15,20 +15,20 @@ export interface ArrayTypeOption {
 export type ArrayTypeOptions = [ArrayTypeOption?];
 
 /**
- * Requires using either `T[]` or `Array<T>` for arrays.
+ * Require using either `T[]` or `Array<T>` for arrays.
  *
  * @see [array-type](https://typescript-eslint.io/rules/array-type)
  */
 export type ArrayTypeRuleConfig = RuleConfig<ArrayTypeOptions>;
 
 /**
- * Requires using either `T[]` or `Array<T>` for arrays.
+ * Require using either `T[]` or `Array<T>` for arrays.
  *
  * @see [array-type](https://typescript-eslint.io/rules/array-type)
  */
 export interface ArrayTypeRule {
   /**
-   * Requires using either `T[]` or `Array<T>` for arrays.
+   * Require using either `T[]` or `Array<T>` for arrays.
    *
    * @see [array-type](https://typescript-eslint.io/rules/array-type)
    */

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

@@ -1,20 +1,20 @@
 import type { RuleConfig } from '../rule-config';
 
 /**
- * Disallows awaiting a value that is not a Thenable.
+ * Disallow awaiting a value that is not a Thenable.
  *
  * @see [await-thenable](https://typescript-eslint.io/rules/await-thenable)
  */
 export type AwaitThenableRuleConfig = RuleConfig<[]>;
 
 /**
- * Disallows awaiting a value that is not a Thenable.
+ * Disallow awaiting a value that is not a Thenable.
  *
  * @see [await-thenable](https://typescript-eslint.io/rules/await-thenable)
  */
 export interface AwaitThenableRule {
   /**
-   * Disallows awaiting a value that is not a Thenable.
+   * Disallow awaiting a value that is not a Thenable.
    *
    * @see [await-thenable](https://typescript-eslint.io/rules/await-thenable)
    */

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

@@ -4,10 +4,34 @@ import type { RuleConfig } from '../rule-config';
  * Option.
  */
 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';
+  'ts-expect-error'?:
+    | boolean
+    | 'allow-with-description'
+    | {
+        descriptionFormat?: string;
+        [k: string]: any;
+      };
+  'ts-ignore'?:
+    | boolean
+    | 'allow-with-description'
+    | {
+        descriptionFormat?: string;
+        [k: string]: any;
+      };
+  'ts-nocheck'?:
+    | boolean
+    | 'allow-with-description'
+    | {
+        descriptionFormat?: string;
+        [k: string]: any;
+      };
+  'ts-check'?:
+    | boolean
+    | 'allow-with-description'
+    | {
+        descriptionFormat?: string;
+        [k: string]: any;
+      };
   minimumDescriptionLength?: number;
 }
 
@@ -17,20 +41,20 @@ export interface BanTsCommentOption {
 export type BanTsCommentOptions = [BanTsCommentOption?];
 
 /**
- * Bans `@ts-<directive>` comments from being used or requires descriptions after directive.
+ * Disallow `@ts-<directive>` comments or require descriptions after directive.
  *
  * @see [ban-ts-comment](https://typescript-eslint.io/rules/ban-ts-comment)
  */
 export type BanTsCommentRuleConfig = RuleConfig<BanTsCommentOptions>;
 
 /**
- * Bans `@ts-<directive>` comments from being used or requires descriptions after directive.
+ * Disallow `@ts-<directive>` comments or require descriptions after directive.
  *
  * @see [ban-ts-comment](https://typescript-eslint.io/rules/ban-ts-comment)
  */
 export interface BanTsCommentRule {
   /**
-   * Bans `@ts-<directive>` comments from being used or requires descriptions after directive.
+   * Disallow `@ts-<directive>` comments or require descriptions after directive.
    *
    * @see [ban-ts-comment](https://typescript-eslint.io/rules/ban-ts-comment)
    */

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

@@ -1,20 +1,20 @@
 import type { RuleConfig } from '../rule-config';
 
 /**
- * Bans `// tslint:<rule-flag>` comments from being used.
+ * Disallow `// tslint:<rule-flag>` comments.
  *
  * @see [ban-tslint-comment](https://typescript-eslint.io/rules/ban-tslint-comment)
  */
 export type BanTslintCommentRuleConfig = RuleConfig<[]>;
 
 /**
- * Bans `// tslint:<rule-flag>` comments from being used.
+ * Disallow `// tslint:<rule-flag>` comments.
  *
  * @see [ban-tslint-comment](https://typescript-eslint.io/rules/ban-tslint-comment)
  */
 export interface BanTslintCommentRule {
   /**
-   * Bans `// tslint:<rule-flag>` comments from being used.
+   * Disallow `// tslint:<rule-flag>` comments.
    *
    * @see [ban-tslint-comment](https://typescript-eslint.io/rules/ban-tslint-comment)
    */

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

@@ -23,20 +23,20 @@ export interface BanTypesOption {
 export type BanTypesOptions = [BanTypesOption?];
 
 /**
- * Bans specific types from being used.
+ * Disallow certain types.
  *
  * @see [ban-types](https://typescript-eslint.io/rules/ban-types)
  */
 export type BanTypesRuleConfig = RuleConfig<BanTypesOptions>;
 
 /**
- * Bans specific types from being used.
+ * Disallow certain types.
  *
  * @see [ban-types](https://typescript-eslint.io/rules/ban-types)
  */
 export interface BanTypesRule {
   /**
-   * Bans specific types from being used.
+   * Disallow certain types.
    *
    * @see [ban-types](https://typescript-eslint.io/rules/ban-types)
    */

src/rules/typescript-eslint/class-literal-property-style.d.ts

@@ -13,21 +13,21 @@ export type ClassLiteralPropertyStyleOptions = [
 ];
 
 /**
- * Ensures that literals on classes are exposed in a consistent style.
+ * Enforce that literals on classes are exposed in a consistent style.
  *
  * @see [class-literal-property-style](https://typescript-eslint.io/rules/class-literal-property-style)
  */
 export type ClassLiteralPropertyStyleRuleConfig =
   RuleConfig<ClassLiteralPropertyStyleOptions>;
 
 /**
- * Ensures that literals on classes are exposed in a consistent style.
+ * Enforce that literals on classes are exposed in a consistent style.
  *
  * @see [class-literal-property-style](https://typescript-eslint.io/rules/class-literal-property-style)
  */
 export interface ClassLiteralPropertyStyleRule {
   /**
-   * Ensures that literals on classes are exposed in a consistent style.
+   * Enforce that literals on classes are exposed in a consistent style.
    *
    * @see [class-literal-property-style](https://typescript-eslint.io/rules/class-literal-property-style)
    */

src/rules/typescript-eslint/comma-dangle.d.ts

@@ -32,20 +32,20 @@ export type ValueWithIgnore =
 export type CommaDangleOptions = CommaDangleOption;
 
 /**
- * Require or disallow trailing comma.
+ * Require or disallow trailing commas.
  *
  * @see [comma-dangle](https://typescript-eslint.io/rules/comma-dangle)
  */
 export type CommaDangleRuleConfig = RuleConfig<CommaDangleOptions>;
 
 /**
- * Require or disallow trailing comma.
+ * Require or disallow trailing commas.
  *
  * @see [comma-dangle](https://typescript-eslint.io/rules/comma-dangle)
  */
 export interface CommaDangleRule {
   /**
-   * Require or disallow trailing comma.
+   * Require or disallow trailing commas.
    *
    * @see [comma-dangle](https://typescript-eslint.io/rules/comma-dangle)
    */

src/rules/typescript-eslint/comma-spacing.d.ts

@@ -14,20 +14,20 @@ export interface CommaSpacingOption {
 export type CommaSpacingOptions = [CommaSpacingOption?];
 
 /**
- * Enforces consistent spacing before and after commas.
+ * Enforce consistent spacing before and after commas.
  *
  * @see [comma-spacing](https://typescript-eslint.io/rules/comma-spacing)
  */
 export type CommaSpacingRuleConfig = RuleConfig<CommaSpacingOptions>;
 
 /**
- * Enforces consistent spacing before and after commas.
+ * Enforce consistent spacing before and after commas.
  *
  * @see [comma-spacing](https://typescript-eslint.io/rules/comma-spacing)
  */
 export interface CommaSpacingRule {
   /**
-   * Enforces consistent spacing before and after commas.
+   * Enforce consistent spacing before and after commas.
    *
    * @see [comma-spacing](https://typescript-eslint.io/rules/comma-spacing)
    */

src/rules/typescript-eslint/consistent-indexed-object-style.d.ts

@@ -13,21 +13,21 @@ export type ConsistentIndexedObjectStyleOptions = [
 ];
 
 /**
- * Enforce or disallow the use of the record type.
+ * Require or disallow the `Record` type.
  *
  * @see [consistent-indexed-object-style](https://typescript-eslint.io/rules/consistent-indexed-object-style)
  */
 export type ConsistentIndexedObjectStyleRuleConfig =
   RuleConfig<ConsistentIndexedObjectStyleOptions>;
 
 /**
- * Enforce or disallow the use of the record type.
+ * Require or disallow the `Record` type.
  *
  * @see [consistent-indexed-object-style](https://typescript-eslint.io/rules/consistent-indexed-object-style)
  */
 export interface ConsistentIndexedObjectStyleRule {
   /**
-   * Enforce or disallow the use of the record type.
+   * Require or disallow the `Record` type.
    *
    * @see [consistent-indexed-object-style](https://typescript-eslint.io/rules/consistent-indexed-object-style)
    */

src/rules/typescript-eslint/consistent-type-assertions.d.ts

@@ -18,21 +18,21 @@ export type ConsistentTypeAssertionsOption =
 export type ConsistentTypeAssertionsOptions = [ConsistentTypeAssertionsOption?];
 
 /**
- * Enforces consistent usage of type assertions.
+ * Enforce consistent usage of type assertions.
  *
  * @see [consistent-type-assertions](https://typescript-eslint.io/rules/consistent-type-assertions)
  */
 export type ConsistentTypeAssertionsRuleConfig =
   RuleConfig<ConsistentTypeAssertionsOptions>;
 
 /**
- * Enforces consistent usage of type assertions.
+ * Enforce consistent usage of type assertions.
  *
  * @see [consistent-type-assertions](https://typescript-eslint.io/rules/consistent-type-assertions)
  */
 export interface ConsistentTypeAssertionsRule {
   /**
-   * Enforces consistent usage of type assertions.
+   * Enforce consistent usage of type assertions.
    *
    * @see [consistent-type-assertions](https://typescript-eslint.io/rules/consistent-type-assertions)
    */