Skip to content

fix(eslint-plugin): crash fixing readonly arrays to generic #1172

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 1 commit into from
Nov 5, 2019
Merged

fix(eslint-plugin): crash fixing readonly arrays to generic #1172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 32 additions & 13 deletions packages/eslint-plugin/src/rules/array-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,8 @@ export default util.createRule<Options, MessageIds>({
return false;
}

if (node.range[0] - prevToken.range[1] > 0) {
const nextToken = sourceCode.getTokenAfter(prevToken);
if (nextToken && sourceCode.isSpaceBetweenTokens(prevToken, nextToken)) {
return false;
}

Expand All @@ -168,6 +169,21 @@ export default util.createRule<Options, MessageIds>({
return 'T';
}

/**
* @param node the node to be evaluated
*/
function getTypeOpNodeRange(
node: TSESTree.Node | null,
): [number, number] | undefined {
if (!node) {
return undefined;
}

const firstToken = sourceCode.getFirstToken(node)!;
const nextToken = sourceCode.getTokenAfter(firstToken)!;
return [firstToken.range[0], nextToken.range[0]];
}

return {
TSArrayType(node): void {
if (
Expand Down Expand Up @@ -208,24 +224,27 @@ export default util.createRule<Options, MessageIds>({
type: getMessageType(node.elementType),
},
fix(fixer) {
const startText = requireWhitespaceBefore(node);
const toFix = [
fixer.replaceTextRange([node.range[1] - 2, node.range[1]], '>'),
fixer.insertTextBefore(
node,
`${startText ? ' ' : ''}${isReadonly ? 'Readonly' : ''}Array<`,
),
];
if (typeOpNode) {
// remove the readonly operator if it exists
toFix.unshift(
fixer.removeRange([
typeOpNode.range[0],
typeOpNode.range[0] + 'readonly '.length,
]),
const startText = requireWhitespaceBefore(node);
const typeOpNodeRange = getTypeOpNodeRange(typeOpNode);

if (typeOpNodeRange) {
toFix.unshift(fixer.removeRange(typeOpNodeRange));
} else {
toFix.push(
fixer.insertTextBefore(node, `${startText ? ' ' : ''}`),
);
}

toFix.push(
fixer.insertTextBefore(
node,
`${isReadonly ? 'Readonly' : ''}Array<`,
),
);

if (node.elementType.type === AST_NODE_TYPES.TSParenthesizedType) {
const first = sourceCode.getFirstToken(node.elementType);
const last = sourceCode.getLastToken(node.elementType);
Expand Down
30 changes: 30 additions & 0 deletions packages/eslint-plugin/tests/rules/array-type.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1071,5 +1071,35 @@ class Foo<T = Bar[][]> extends Bar<T, T[]> implements Baz<T[]> {
`let a: readonly Array<number>[] = []`,
'array',
);
testOutput(
'generic',
`type T = readonly(string)[]`,
`type T = ReadonlyArray<string>`,
'generic',
);
testOutput(
'generic',
`let a: readonly(readonly string[])[] = []`,
`let a: ReadonlyArray<ReadonlyArray<string>> = []`,
'generic',
);
testOutput(
'generic',
`type T = readonly(readonly string[])[]`,
`type T = ReadonlyArray<ReadonlyArray<string>>`,
'generic',
);
testOutput(
'generic',
`type T = readonly (readonly string[])[]`,
`type T = ReadonlyArray<ReadonlyArray<string>>`,
'generic',
);
testOutput(
'generic',
`type T = readonly (readonly string[])[]`,
`type T = ReadonlyArray<ReadonlyArray<string>>`,
'generic',
);
});
});