Skip to content
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

Jump to bottom

fix(eslint-plugin): [no-unnecessary-type-constraint] change to suggestion fix, fix multiple trailing comma failures #4901

Merged
merged 4 commits into from May 6, 2022
Merged

fix(eslint-plugin): [no-unnecessary-type-constraint] change to suggestion fix, fix multiple trailing comma failures #4901

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ccb0d01
fix(eslint-plugin): [no-unnecessary-type-contraint] change to suggest…
Josh-Cena May 4, 2022
35f3d1e
test: fix
Josh-Cena May 5, 2022
aa34afa
docs: update
Josh-Cena May 5, 2022
0b69748
docs: fix
Josh-Cena May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 28 additions & 8 deletions packages/eslint-plugin/src/rules/no-unnecessary-type-constraint.ts
View file
Open in desktop
@@ -1,4 +1,4 @@
import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
import { AST_NODE_TYPES, TSESTree, TSESLint } from '@typescript-eslint/utils';
import * as semver from 'semver';
import * as ts from 'typescript';
import * as util from '../util';
Expand Down Expand Up @@ -33,10 +33,12 @@ export default util.createRule({
recommended: 'error',
suggestion: true,
},
fixable: 'code',
hasSuggestions: true,
messages: {
unnecessaryConstraint:
'Constraining the generic type `{{name}}` to `{{constraint}}` does nothing and is unnecessary.',
removeUnnecessaryConstraint:
'Remove the unnecessary `{{constraint}}` constraint.',
},
schema: [],
type: 'suggestion',
Expand All @@ -58,25 +60,43 @@ export default util.createRule({
: new Map([[AST_NODE_TYPES.TSUnknownKeyword, 'unknown']]);

const inJsx = context.getFilename().toLowerCase().endsWith('tsx');
const source = context.getSourceCode();

const checkNode = (
node: TypeParameterWithConstraint,
inArrowFunction: boolean,
): void => {
const constraint = unnecessaryConstraints.get(node.constraint.type);
function shouldAddTrailingComma(): boolean {
if (!inArrowFunction || !inJsx) {
return false;
}
// Only <T>() => {} would need trailing comma
return (
(node.parent as TSESTree.TSTypeParameterDeclaration).params.length ===
1 &&
source.getTokensAfter(node)[0].value !== ',' &&
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know a better way to get the presence of trailing comma...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(me neither!)

!node.default
);
}

if (constraint) {
context.report({
data: {
constraint,
name: node.name.name,
},
fix(fixer) {
return fixer.replaceTextRange(
[node.name.range[1], node.constraint.range[1]],
inArrowFunction && inJsx ? ',' : '',
);
},
suggest: [
{
messageId: 'removeUnnecessaryConstraint',
fix(fixer): TSESLint.RuleFix | null {
return fixer.replaceTextRange(
[node.name.range[1], node.constraint.range[1]],
shouldAddTrailingComma() ? ',' : '',
);
},
},
],
messageId: 'unnecessaryConstraint',
node,
});
Expand Down
180 changes: 160 additions & 20 deletions packages/eslint-plugin/tests/rules/no-unnecessary-type-constraint.test.ts
View file
Open in desktop
Expand Up @@ -36,9 +36,14 @@ function data<T extends TODO>() {}
endColumn: 28,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'function data<T>() {}',
},
],
},
],
output: 'function data<T>() {}',
},
{
code: 'function data<T extends any, U>() {}',
Expand All @@ -49,9 +54,14 @@ function data<T extends TODO>() {}
endColumn: 28,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'function data<T, U>() {}',
},
],
},
],
output: 'function data<T, U>() {}',
},
{
code: 'function data<T, U extends any>() {}',
Expand All @@ -62,9 +72,14 @@ function data<T extends TODO>() {}
endColumn: 31,
column: 18,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'function data<T, U>() {}',
},
],
},
],
output: 'function data<T, U>() {}',
},
{
code: 'function data<T extends any, U extends T>() {}',
Expand All @@ -75,9 +90,14 @@ function data<T extends TODO>() {}
endColumn: 28,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'function data<T, U extends T>() {}',
},
],
},
],
output: 'function data<T, U extends T>() {}',
},
{
code: 'const data = <T extends any>() => {};',
Expand All @@ -88,10 +108,85 @@ function data<T extends TODO>() {}
endColumn: 28,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: noFormat`const data = <T,>() => {};`,
},
],
},
],
filename: 'react.tsx',
},
{
code: noFormat`const data = <T extends any,>() => {};`,
Josh-Cena marked this conversation as resolved.
Show resolved Hide resolved
errors: [
{
data: { constraint: 'any', name: 'T' },
messageId: 'unnecessaryConstraint',
endColumn: 28,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: noFormat`const data = <T,>() => {};`,
},
],
},
],
filename: 'react.tsx',
},
{
code: 'const data = <T extends any = unknown>() => {};',
errors: [
{
data: { constraint: 'any', name: 'T' },
messageId: 'unnecessaryConstraint',
endColumn: 38,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'const data = <T = unknown>() => {};',
},
],
},
],
filename: 'react.tsx',
},
{
code: 'const data = <T extends any, U extends any>() => {};',
errors: [
{
data: { constraint: 'any', name: 'T' },
messageId: 'unnecessaryConstraint',
endColumn: 28,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: noFormat`const data = <T, U extends any>() => {};`,
},
],
},
{
data: { constraint: 'any', name: 'U' },
messageId: 'unnecessaryConstraint',
endColumn: 43,
column: 30,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: noFormat`const data = <T extends any, U>() => {};`,
},
],
},
],
filename: 'react.tsx',
output: noFormat`const data = <T,>() => {};`,
},
{
code: 'function data<T extends unknown>() {}',
Expand All @@ -102,9 +197,14 @@ function data<T extends TODO>() {}
endColumn: 32,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'function data<T>() {}',
},
],
},
],
output: 'function data<T>() {}',
},
{
code: 'const data = <T extends any>() => {};',
Expand All @@ -115,9 +215,14 @@ function data<T extends TODO>() {}
endColumn: 28,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'const data = <T>() => {};',
},
],
},
],
output: 'const data = <T>() => {};',
},
{
code: 'const data = <T extends unknown>() => {};',
Expand All @@ -128,9 +233,14 @@ function data<T extends TODO>() {}
endColumn: 32,
column: 15,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'const data = <T>() => {};',
},
],
},
],
output: 'const data = <T>() => {};',
},
{
code: 'class Data<T extends unknown> {}',
Expand All @@ -141,9 +251,14 @@ function data<T extends TODO>() {}
endColumn: 29,
column: 12,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'class Data<T> {}',
},
],
},
],
output: 'class Data<T> {}',
},
{
code: 'const Data = class<T extends unknown> {};',
Expand All @@ -154,9 +269,14 @@ function data<T extends TODO>() {}
endColumn: 37,
column: 20,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'const Data = class<T> {};',
},
],
},
],
output: 'const Data = class<T> {};',
},
{
code: `
Expand All @@ -171,13 +291,18 @@ class Data {
endColumn: 27,
column: 10,
line: 3,
},
],
output: `
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: `
class Data {
member<T>() {}
}
`,
`,
Josh-Cena marked this conversation as resolved.
Show resolved Hide resolved
},
],
},
],
},
{
code: `
Expand All @@ -192,13 +317,18 @@ const Data = class {
endColumn: 27,
column: 10,
line: 3,
},
],
output: `
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: `
const Data = class {
member<T>() {}
};
`,
`,
},
],
},
],
},
{
code: 'interface Data<T extends unknown> {}',
Expand All @@ -209,9 +339,14 @@ const Data = class {
endColumn: 33,
column: 16,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'interface Data<T> {}',
},
],
},
],
output: 'interface Data<T> {}',
},
{
code: 'type Data<T extends unknown> = {};',
Expand All @@ -222,9 +357,14 @@ const Data = class {
endColumn: 28,
column: 11,
line: 1,
suggestions: [
{
messageId: 'removeUnnecessaryConstraint',
output: 'type Data<T> = {};',
},
],
},
],
output: 'type Data<T> = {};',
},
],
});