Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(eslint-plugin): [consistent-generic-ctors] check class field declaration #5288

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 3 commits into from
Jul 22, 2022
Merged

feat(eslint-plugin): [consistent-generic-ctors] check class field declaration #5288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9538b0d
feat(eslint-plugin): [consistent-generic-ctors] report class field de…
Josh-Cena Jul 3, 2022
fbd5b7e
add a test
Josh-Cena Jul 3, 2022
8c7900b
Merge branch 'main' into cgc-class-field
JoshuaKGoldberg Jul 22, 2022
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
33 changes: 28 additions & 5 deletions packages/eslint-plugin/src/rules/consistent-generic-constructors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
import { createRule } from '../util';

type MessageIds = 'preferTypeAnnotation' | 'preferConstructor';
Expand Down Expand Up @@ -30,9 +30,16 @@ export default createRule<Options, MessageIds>({
create(context, [mode]) {
const sourceCode = context.getSourceCode();
return {
VariableDeclarator(node): void {
const lhs = node.id.typeAnnotation?.typeAnnotation;
const rhs = node.init;
'VariableDeclarator,PropertyDefinition'(
node: TSESTree.VariableDeclarator | TSESTree.PropertyDefinition,
): void {
const lhs = (
node.type === AST_NODE_TYPES.VariableDeclarator ? node.id : node
).typeAnnotation?.typeAnnotation;
const rhs =
node.type === AST_NODE_TYPES.VariableDeclarator
? node.init
: node.value;
if (
!rhs ||
rhs.type !== AST_NODE_TYPES.NewExpression ||
Expand All @@ -57,9 +64,25 @@ export default createRule<Options, MessageIds>({
node,
messageId: 'preferTypeAnnotation',
fix(fixer) {
function getIDToAttachAnnotation():
| TSESTree.Token
| TSESTree.Node {
if (node.type === AST_NODE_TYPES.VariableDeclarator) {
return node.id;
}
if (!node.computed) {
return node.key;
}
// If the property's computed, we have to attach the
// annotation after the square bracket, not the enclosed expression
return sourceCode.getTokenAfter(node.key)!;
}
return [
fixer.remove(typeParameters),
fixer.insertTextAfter(node.id, ': ' + typeAnnotation),
fixer.insertTextAfter(
getIDToAttachAnnotation(),
': ' + typeAnnotation,
),
];
},
});
Expand Down
101 changes: 101 additions & 0 deletions packages/eslint-plugin/tests/rules/consistent-generic-constructors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ ruleTester.run('consistent-generic-constructors', rule, {
'const a: Foo<string> = Foo<string>();',
'const a: Foo<string> = Foo();',
'const a: Foo = Foo<string>();',
`
class Foo {
a = new Foo<string>();
}
`,
// type-annotation
{
code: 'const a = new Foo();',
Expand Down Expand Up @@ -60,6 +65,14 @@ ruleTester.run('consistent-generic-constructors', rule, {
code: 'const a = new (class C<T> {})<string>();',
options: ['type-annotation'],
},
{
code: `
class Foo {
a: Foo<string> = new Foo();
}
`,
options: ['type-annotation'],
},
],
invalid: [
{
Expand Down Expand Up @@ -143,6 +156,40 @@ ruleTester.run('consistent-generic-constructors', rule, {
],
output: noFormat`const a = new \n Foo<string> \n ();`,
},
{
code: `
class Foo {
a: Foo<string> = new Foo();
}
`,
errors: [
{
messageId: 'preferConstructor',
},
],
output: `
class Foo {
a = new Foo<string>();
}
`,
},
{
code: `
class Foo {
[a]: Foo<string> = new Foo();
}
`,
errors: [
{
messageId: 'preferConstructor',
},
],
output: `
class Foo {
[a] = new Foo<string>();
}
`,
},
{
code: 'const a = new Foo<string>();',
options: ['type-annotation'],
Expand Down Expand Up @@ -213,5 +260,59 @@ ruleTester.run('consistent-generic-constructors', rule, {
],
output: noFormat`const a: Foo</* comment */ string, /* another */ number> = new Foo();`,
},
{
code: `
class Foo {
a = new Foo<string>();
}
`,
options: ['type-annotation'],
errors: [
{
messageId: 'preferTypeAnnotation',
},
],
output: `
class Foo {
a: Foo<string> = new Foo();
}
`,
},
{
code: `
class Foo {
[a] = new Foo<string>();
}
`,
options: ['type-annotation'],
errors: [
{
messageId: 'preferTypeAnnotation',
},
],
output: `
class Foo {
[a]: Foo<string> = new Foo();
}
`,
},
{
code: `
class Foo {
[a + b] = new Foo<string>();
}
`,
options: ['type-annotation'],
errors: [
{
messageId: 'preferTypeAnnotation',
},
],
output: `
class Foo {
[a + b]: Foo<string> = new Foo();
}
`,
},
],
});