Merge pull request #409 from Shopify/jaddleman/use-record

Use Record instead of index signatures
Shopify · Dec 4, 2023 · a31814e · a31814e
2 parents 19c8d94 + 4fd9e99
commit a31814e
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/.changeset/kind-monkeys-refuse.md b/.changeset/kind-monkeys-refuse.md
@@ -0,0 +1,5 @@
+---
+'@shopify/eslint-plugin': major
+---
+
+Change the @typescript-eslint/consistent-indexed-object-style rule to use default error settings, aka Record over index signature
diff --git a/packages/eslint-plugin/lib/config/typescript.js b/packages/eslint-plugin/lib/config/typescript.js
@@ -264,10 +264,7 @@ module.exports = {
         // Requires that private members are marked as readonly if they're never modified outside of the constructor
         '@typescript-eslint/prefer-readonly': 'off',
         // This rule enforces a consistent way to define records.
-        '@typescript-eslint/consistent-indexed-object-style': [
-          'error',
-          'index-signature',
-        ],
+        '@typescript-eslint/consistent-indexed-object-style': 'error',
         // Disallows unnecessary constraints on generic types
         '@typescript-eslint/no-unnecessary-type-constraint': 'error',
 

diff --git a/packages/images/optimize.d.ts b/packages/images/optimize.d.ts
@@ -1 +1 @@
-export function svgOptions(): {[key: string]: unknown};
+export function svgOptions(): Record<string, unknown>;
diff --git a/packages/typescript-configs/definitions/styles.d.ts b/packages/typescript-configs/definitions/styles.d.ts
@@ -1,9 +1,9 @@
 declare module '*.scss' {
-  const classNames: {[key: string]: string};
+  const classNames: Record<string, string>;
   export default classNames;
 }
 
 declare module '*.css' {
-  const classNames: {[key: string]: string};
+  const classNames: Record<string, string>;
   export default classNames;
 }