From 4fd9e991d2d94252210890c8f6af06902099cac4 Mon Sep 17 00:00:00 2001 From: Jason Addleman Date: Mon, 4 Dec 2023 14:22:18 -0500 Subject: [PATCH] Use Record instead of index signatures Fix failures --- .changeset/kind-monkeys-refuse.md | 5 +++++ packages/eslint-plugin/lib/config/typescript.js | 5 +---- packages/images/optimize.d.ts | 2 +- packages/typescript-configs/definitions/styles.d.ts | 4 ++-- 4 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 .changeset/kind-monkeys-refuse.md diff --git a/.changeset/kind-monkeys-refuse.md b/.changeset/kind-monkeys-refuse.md new file mode 100644 index 00000000..a0b4026c --- /dev/null +++ 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 index 69caf947..b08e42dc 100644 --- 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 index 086d9086..1a9887ac 100644 --- a/packages/images/optimize.d.ts +++ b/packages/images/optimize.d.ts @@ -1 +1 @@ -export function svgOptions(): {[key: string]: unknown}; +export function svgOptions(): Record; diff --git a/packages/typescript-configs/definitions/styles.d.ts b/packages/typescript-configs/definitions/styles.d.ts index fc5529bc..c4c31863 100755 --- 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; export default classNames; } declare module '*.css' { - const classNames: {[key: string]: string}; + const classNames: Record; export default classNames; }