Skip to content

fix(eslint-plugin): [consistent-indexed-object-style] use a suggestion over an auto-fix if can't reliably determine that produced index signature is valid #10490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 21, 2024
Merged

fix(eslint-plugin): [consistent-indexed-object-style] use a suggestion over an auto-fix if can't reliably determine that produced index signature is valid #10490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c95044f
initial implementation
ronami Dec 11, 2024
2a046b6
add tests
ronami Dec 11, 2024
635da35
Merge branch 'main' into consistent-indexed-object-style-change-auto-fix
ronami Dec 13, 2024
023265d
use getFixOrSuggest
ronami Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 32 additions & 7 deletions packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,17 @@ import type { ReportFixFunction } from '@typescript-eslint/utils/ts-eslint';

import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';

import { createRule, isParenthesized, nullThrows } from '../util';
import {
createRule,
getFixOrSuggest,
isParenthesized,
nullThrows,
} from '../util';

type MessageIds = 'preferIndexSignature' | 'preferRecord';
type MessageIds =
| 'preferIndexSignature'
| 'preferIndexSignatureSuggestion'
| 'preferRecord';
type Options = ['index-signature' | 'record'];

export default createRule<Options, MessageIds>({
Expand All @@ -17,8 +25,12 @@ export default createRule<Options, MessageIds>({
recommended: 'stylistic',
},
fixable: 'code',
// eslint-disable-next-line eslint-plugin/require-meta-has-suggestions -- suggestions are exposed through a helper.
hasSuggestions: true,
messages: {
preferIndexSignature: 'An index signature is preferred over a record.',
preferIndexSignatureSuggestion:
'Change into an index signature instead of a record.',
preferRecord: 'A record is preferred over an index signature.',
},
schema: [
Expand Down Expand Up @@ -113,14 +125,27 @@ export default createRule<Options, MessageIds>({
return;
}

const indexParam = params[0];

const shouldFix =
indexParam.type === AST_NODE_TYPES.TSStringKeyword ||
indexParam.type === AST_NODE_TYPES.TSNumberKeyword ||
indexParam.type === AST_NODE_TYPES.TSSymbolKeyword;

context.report({
node,
messageId: 'preferIndexSignature',
fix(fixer) {
const key = context.sourceCode.getText(params[0]);
const type = context.sourceCode.getText(params[1]);
return fixer.replaceText(node, `{ [key: ${key}]: ${type} }`);
},
...getFixOrSuggest({
fixOrSuggest: shouldFix ? 'fix' : 'suggest',
suggestion: {
messageId: 'preferIndexSignatureSuggestion',
fix: fixer => {
const key = context.sourceCode.getText(params[0]);
const type = context.sourceCode.getText(params[1]);
return fixer.replaceText(node, `{ [key: ${key}]: ${type} }`);
},
},
}),
});
},
}),
Expand Down
51 changes: 51 additions & 0 deletions packages/eslint-plugin/tests/rules/consistent-indexed-object-style.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,57 @@ interface Foo {
output: 'type Foo = Generic<{ [key: string]: any }>;',
},

// Record with an index node that may potentially break index-signature style
{
code: 'type Foo = Record<string | number, any>;',
errors: [
{
column: 12,
line: 1,
messageId: 'preferIndexSignature',
suggestions: [
{
messageId: 'preferIndexSignatureSuggestion',
output: 'type Foo = { [key: string | number]: any };',
},
],
},
],
options: ['index-signature'],
},
{
code: "type Foo = Record<Exclude<'a' | 'b' | 'c', 'a'>, any>;",
errors: [
{
column: 12,
line: 1,
messageId: 'preferIndexSignature',
suggestions: [
{
messageId: 'preferIndexSignatureSuggestion',
output:
"type Foo = { [key: Exclude<'a' | 'b' | 'c', 'a'>]: any };",
},
],
},
],
options: ['index-signature'],
},

// Record with valid index node should use an auto-fix
{
code: 'type Foo = Record<number, any>;',
errors: [{ column: 12, line: 1, messageId: 'preferIndexSignature' }],
options: ['index-signature'],
output: 'type Foo = { [key: number]: any };',
},
{
code: 'type Foo = Record<symbol, any>;',
errors: [{ column: 12, line: 1, messageId: 'preferIndexSignature' }],
options: ['index-signature'],
output: 'type Foo = { [key: symbol]: any };',
},

// Function types
{
code: 'function foo(arg: Record<string, any>) {}',
Expand Down
Loading