chore: enable consistent-indexed-object-style and lint (#7353)

* chore: enable consistent-indexed-object-style and lint * chore: convert multiline Record to single line * chore: remove no longer needed type cast * Update .eslintrc.js --------- Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
typescript-eslint · Aug 5, 2023 · 4087f48 · 4087f48
1 parent 8b17a25
commit 4087f48
Show file tree

Hide file tree

Showing 15 changed files with 31 additions and 75 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -54,7 +54,6 @@ module.exports = {
     'deprecation/deprecation': 'error',
 
     // TODO(#7138): Investigate enabling these soon ✨
-    '@typescript-eslint/consistent-indexed-object-style': 'off',
     '@typescript-eslint/prefer-nullish-coalescing': 'off',
 
     // TODO(#7130): Investigate changing these in or removing these from presets

diff --git a/packages/eslint-plugin/rules.d.ts b/packages/eslint-plugin/rules.d.ts
@@ -37,8 +37,9 @@ This is likely not portable. A type annotation is necessary. ts(2742)
 
 import type { RuleModule } from '@typescript-eslint/utils/ts-eslint';
 
-export interface TypeScriptESLintRules {
-  [ruleName: string]: RuleModule<string, unknown[]>;
-}
+export type TypeScriptESLintRules = Record<
+  string,
+  RuleModule<string, unknown[]>
+>;
 declare const rules: TypeScriptESLintRules;
 export default rules;
diff --git a/packages/eslint-plugin/src/rules/consistent-type-exports.ts b/packages/eslint-plugin/src/rules/consistent-type-exports.ts
@@ -67,7 +67,7 @@ export default util.createRule<Options, MessageIds>({
 
   create(context, [{ fixMixedExportsWithInlineTypeSpecifier }]) {
     const sourceCode = context.getSourceCode();
-    const sourceExportsMap: { [key: string]: SourceExports } = {};
+    const sourceExportsMap: Record<string, SourceExports> = {};
     const services = util.getParserServices(context);
 
     /**

diff --git a/packages/eslint-plugin/src/rules/consistent-type-imports.ts b/packages/eslint-plugin/src/rules/consistent-type-imports.ts
@@ -96,7 +96,7 @@ export default util.createRule<Options, MessageIds>({
     const fixStyle = option.fixStyle ?? 'separate-type-imports';
     const sourceCode = context.getSourceCode();
 
-    const sourceImportsMap: { [key: string]: SourceImports } = {};
+    const sourceImportsMap: Record<string, SourceImports> = {};
 
     return {
       ...(prefer === 'type-imports'

diff --git a/packages/eslint-plugin/tools/generate-configs.ts b/packages/eslint-plugin/tools/generate-configs.ts
@@ -47,9 +47,7 @@ async function main(): Promise<void> {
 
   const prettierConfig = prettier.resolveConfig.sync(__dirname);
 
-  interface LinterConfigRules {
-    [name: string]: TSESLint.Linter.RuleLevel;
-  }
+  type LinterConfigRules = Record<string, TSESLint.Linter.RuleLevel>;
 
   interface LinterConfig extends TSESLint.Linter.Config {
     extends?: string[] | string;

diff --git a/packages/rule-schema-to-typescript-types/src/index.ts b/packages/rule-schema-to-typescript-types/src/index.ts
@@ -69,9 +69,7 @@ function compileSchema(
 
   const refMap = new Map<string, string>();
   // we only support defs at the top level for simplicity
-  const defs = (schema.$defs ?? schema.definitions) as
-    | Record<string, JSONSchema4>
-    | undefined;
+  const defs = schema.$defs ?? schema.definitions;
   if (defs) {
     for (const [defKey, defSchema] of Object.entries(defs)) {
       const typeName = toPascalCase(defKey);

diff --git a/packages/rule-tester/src/types/DependencyConstraint.ts b/packages/rule-tester/src/types/DependencyConstraint.ts
@@ -12,9 +12,7 @@ export type AtLeastVersionConstraint =
 export type VersionConstraint =
   | AtLeastVersionConstraint
   | SemverVersionConstraint;
-export interface DependencyConstraint {
-  /**
-   * Passing a string for the value is shorthand for a '>=' constraint
-   */
-  readonly [packageName: string]: VersionConstraint;
-}
+/**
+ * Passing a string for the value is shorthand for a '>=' constraint
+ */
+export type DependencyConstraint = Readonly<Record<string, VersionConstraint>>;
diff --git a/packages/typescript-estree/src/parser.ts b/packages/typescript-estree/src/parser.ts
@@ -158,7 +158,7 @@ function parseWithNodeMapsInternal<T extends TSESTreeOptions = TSESTreeOptions>(
   };
 }
 
-let parseAndGenerateServicesCalls: { [fileName: string]: number } = {};
+let parseAndGenerateServicesCalls: Record<string, number> = {};
 // Privately exported utility intended for use in typescript-eslint unit tests only
 function clearParseAndGenerateServicesCalls(): void {
   parseAndGenerateServicesCalls = {};

diff --git a/packages/typescript-estree/src/simple-traverse.ts b/packages/typescript-estree/src/simple-traverse.ts
@@ -27,12 +27,10 @@ type SimpleTraverseOptions = Readonly<
     }
   | {
       visitorKeys?: Readonly<VisitorKeys>;
-      visitors: {
-        [key: string]: (
-          node: TSESTree.Node,
-          parent: TSESTree.Node | undefined,
-        ) => void;
-      };
+      visitors: Record<
+        string,
+        (node: TSESTree.Node, parent: TSESTree.Node | undefined) => void
+      >;
     }
 >;
 

diff --git a/packages/utils/src/json-schema.ts b/packages/utils/src/json-schema.ts
@@ -106,19 +106,11 @@ interface JSONSchema4Base {
   /**
    * Reusable definitions that can be referenced via `$ref`
    */
-  definitions?:
-    | {
-        [k: string]: JSONSchema4;
-      }
-    | undefined;
+  definitions?: Record<string, JSONSchema4> | undefined;
   /**
    * Reusable definitions that can be referenced via `$ref`
    */
-  $defs?:
-    | {
-        [k: string]: JSONSchema4;
-      }
-    | undefined;
+  $defs?: Record<string, JSONSchema4> | undefined;
 
   /**
    * The value of this property MUST be another schema which will provide
@@ -242,11 +234,7 @@ export interface JSONSchema4ObjectSchema extends JSONSchema4Base {
    *
    * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2
    */
-  properties?:
-    | {
-        [k: string]: JSONSchema4;
-      }
-    | undefined;
+  properties?: Record<string, JSONSchema4> | undefined;
 
   /**
    * This attribute is an object that defines the schema for a set of
@@ -259,22 +247,14 @@ export interface JSONSchema4ObjectSchema extends JSONSchema4Base {
    *
    * @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3
    */
-  patternProperties?:
-    | {
-        [k: string]: JSONSchema4;
-      }
-    | undefined;
+  patternProperties?: Record<string, JSONSchema4> | undefined;
 
   /**
    * The `dependencies` keyword conditionally applies a sub-schema when a given
    * property is present. This schema is applied in the same way `allOf` applies
    * schemas. Nothing is merged or extended. Both schemas apply independently.
    */
-  dependencies?:
-    | {
-        [k: string]: JSONSchema4 | string[];
-      }
-    | undefined;
+  dependencies?: Record<string, JSONSchema4 | string[]> | undefined;
 
   /**
    * The maximum number of properties allowed for record-style schemas

diff --git a/packages/utils/src/ts-eslint/CLIEngine.ts b/packages/utils/src/ts-eslint/CLIEngine.ts
@@ -106,7 +106,7 @@ declare class CLIEngineBase {
 namespace CLIEngine {
   export interface Options {
     allowInlineConfig?: boolean;
-    baseConfig?: false | { [name: string]: unknown };
+    baseConfig?: false | Record<string, unknown>;
     cache?: boolean;
     cacheFile?: string;
     cacheLocation?: string;
@@ -125,9 +125,7 @@ namespace CLIEngine {
     parserOptions?: Linter.ParserOptions;
     plugins?: string[];
     resolvePluginsRelativeTo?: string;
-    rules?: {
-      [name: string]: Linter.RuleLevel | Linter.RuleLevelAndOptions;
-    };
+    rules?: Record<string, Linter.RuleLevel | Linter.RuleLevelAndOptions>;
     rulePaths?: string[];
     reportUnusedDisableDirectives?: boolean;
   }
@@ -158,9 +156,7 @@ namespace CLIEngine {
   }
 
   export interface LintResultData<TMessageIds extends string> {
-    rulesMeta: {
-      [ruleId: string]: RuleMetaData<TMessageIds>;
-    };
+    rulesMeta: Record<string, RuleMetaData<TMessageIds>>;
   }
 
   export type Formatter = <TMessageIds extends string>(

diff --git a/packages/utils/src/ts-eslint/Linter.ts b/packages/utils/src/ts-eslint/Linter.ts
@@ -130,12 +130,8 @@ namespace Linter {
   export type GlobalVariableOptionBase = 'off' | 'readonly' | 'writable';
   export type GlobalVariableOption = GlobalVariableOptionBase | boolean;
 
-  export interface GlobalsConfig {
-    [name: string]: GlobalVariableOption;
-  }
-  export interface EnvironmentConfig {
-    [name: string]: boolean;
-  }
+  export type GlobalsConfig = Record<string, GlobalVariableOption>;
+  export type EnvironmentConfig = Record<string, boolean>;
 
   // https://github.com/eslint/eslint/blob/v6.8.0/conf/config-schema.js
   interface BaseConfig {

diff --git a/packages/utils/src/ts-eslint/Rule.ts b/packages/utils/src/ts-eslint/Rule.ts
@@ -170,9 +170,7 @@ type ReportDescriptor<TMessageIds extends string> =
  * Plugins can add their settings using declaration
  * merging against this interface.
  */
-interface SharedConfigurationSettings {
-  [name: string]: unknown;
-}
+type SharedConfigurationSettings = Record<string, unknown>;
 
 interface RuleContext<
   TMessageIds extends string,
@@ -428,9 +426,7 @@ interface RuleListenerBaseSelectors {
 type RuleListenerExitSelectors = {
   [K in keyof RuleListenerBaseSelectors as `${K}:exit`]: RuleListenerBaseSelectors[K];
 };
-interface RuleListenerCatchAllBaseCase {
-  [nodeSelector: string]: RuleFunction | undefined;
-}
+type RuleListenerCatchAllBaseCase = Record<string, RuleFunction | undefined>;
 // Interface to merge into for anyone that wants to add more selectors
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 interface RuleListenerExtension {}

diff --git a/packages/utils/src/ts-eslint/SourceCode.ts b/packages/utils/src/ts-eslint/SourceCode.ts
@@ -384,9 +384,7 @@ namespace SourceCode {
     visitorKeys: VisitorKeys | null;
   }
 
-  export interface VisitorKeys {
-    [nodeType: string]: string[];
-  }
+  export type VisitorKeys = Record<string, string[]>;
 
   export type FilterPredicate = (token: TSESTree.Token) => boolean;
   export type GetFilterPredicate<TFilter, TDefault> =

diff --git a/packages/visitor-keys/src/visitor-keys.ts b/packages/visitor-keys/src/visitor-keys.ts
@@ -1,9 +1,7 @@
 import type { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/types';
 import * as eslintVisitorKeys from 'eslint-visitor-keys';
 
-interface VisitorKeys {
-  readonly [type: string]: readonly string[] | undefined;
-}
+type VisitorKeys = Record<string, readonly string[] | undefined>;
 
 type GetNodeTypeKeys<T extends AST_NODE_TYPES> = Exclude<
   keyof Extract<TSESTree.Node, { type: T }>,