Skip to content

fix(eslint-plugin): [prefer-return-this-type] check accessor properties with a function initializer #10794

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 2 commits into from
Feb 17, 2025
+102 −15
Merged

fix(eslint-plugin): [prefer-return-this-type] check accessor properties with a function initializer #10794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b71a9fe
handle accessor property with prefer-return-this-type
ronami Feb 4, 2025
b463fe5
refactor and add missing tests
ronami Feb 6, 2025
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: 18 additions & 15 deletions packages/eslint-plugin/src/rules/prefer-return-this-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,24 +148,27 @@ export default createRule({
}
}

function checkProperty(
node: TSESTree.AccessorProperty | TSESTree.PropertyDefinition,
): void {
if (
!(
node.value?.type === AST_NODE_TYPES.FunctionExpression ||
node.value?.type === AST_NODE_TYPES.ArrowFunctionExpression
)
) {
return;
}

checkFunction(node.value, node.parent.parent);
}

return {
'ClassBody > AccessorProperty': checkProperty,
'ClassBody > MethodDefinition'(node: TSESTree.MethodDefinition): void {
checkFunction(node.value, node.parent.parent as ClassLikeDeclaration);
},
'ClassBody > PropertyDefinition'(
node: TSESTree.PropertyDefinition,
): void {
if (
!(
node.value?.type === AST_NODE_TYPES.FunctionExpression ||
node.value?.type === AST_NODE_TYPES.ArrowFunctionExpression
)
) {
return;
}

checkFunction(node.value, node.parent.parent as ClassLikeDeclaration);
checkFunction(node.value, node.parent.parent);
Comment on lines -167 to +169
Copy link
Member Author

@ronami ronami Feb 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The type assertion seems unnecessary since #9560.

This is an unrelated change, but I decided to include it as it's a tiny change and on the same part of the code that the PR changes anyway.

Copy link
Member Author

@ronami ronami Feb 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I wonder if this can be caught by no-unnecessary-type-assertion 🤔

Since ClassLikeDeclaration is a different type alias (and thus a different type), the comparison seems to fail (even though ClassLikeDeclaration is assigned the same type as the un-asserted type). Inlining the value of the type alias seem to cause no-unnecessary-type-assertion to report this.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah that would be nice. My hunch is it's some nuance about generic functions having type parameters inferred from types of arguments.

},
'ClassBody > PropertyDefinition': checkProperty,
};
},
});
84 changes: 84 additions & 0 deletions packages/eslint-plugin/tests/rules/prefer-return-this-type.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,25 @@ class Derived extends Base {
f(): Base {
return this;
}
}
`,
`
class Foo {
accessor f = () => {
return this;
};
}
`,
`
class Foo {
accessor f = (): this => {
return this;
};
}
`,
`
class Foo {
f?: string;
}
`,
Comment on lines +98 to 102
Copy link
Member Author

@ronami ronami Feb 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This is a test addition that isn't related to the accessor changes, but was previously uncovered. This fails codecov (as the uncovered code has been moved to a function), and because it's such a tiny addition, I decided to include it in this PR.

],
Expand Down Expand Up @@ -108,6 +127,29 @@ class Foo {
},
{
code: `
class Foo {
f = function (): Foo {
return this;
};
}
`,
errors: [
{
column: 20,
line: 3,
messageId: 'useThisType',
},
],
output: `
class Foo {
f = function (): this {
return this;
};
}
`,
},
{
code: `
class Foo {
f(): Foo {
const self = this;
Expand Down Expand Up @@ -200,6 +242,48 @@ class Foo {
},
{
code: `
class Foo {
accessor f = (): Foo => {
return this;
};
}
`,
errors: [
{
column: 20,
line: 3,
messageId: 'useThisType',
},
],
output: `
class Foo {
accessor f = (): this => {
return this;
};
}
`,
},
{
code: `
class Foo {
accessor f = (): Foo => this;
}
`,
errors: [
{
column: 20,
line: 3,
messageId: 'useThisType',
},
],
output: `
class Foo {
accessor f = (): this => this;
}
`,
},
{
code: `
class Foo {
f1(): Foo | undefined {
return this;
Expand Down
Loading