Skip to content

fix(eslint-plugin): [consistent-type-definitions] correct fix for export default #3899

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
Merged
merged 1 commit into from
Sep 20, 2021
Merged

fix(eslint-plugin): [consistent-type-definitions] correct fix for export default #3899

merged 1 commit into from
Sep 20, 2021

Conversation

rafaelss95
Copy link
Contributor

Fixes #3894.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @rafaelss95!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@codecov
Copy link

codecov bot commented Sep 17, 2021 •
edited
Loading

Codecov Report

Merging #3899 (1e7e6d8) into master (b1df817) will increase coverage by 0.81%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master    #3899      +/-   ##
==========================================
+ Coverage   92.70%   93.52%   +0.81%     
==========================================
  Files         329      149     -180     
  Lines       11534     8046    -3488     
  Branches     3257     2552     -705     
==========================================
- Hits        10693     7525    -3168     
+ Misses        368      164     -204     
+ Partials      473      357     -116
Flag Coverage Δ
unittest 93.52% <66.66%> (+0.81%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...nt-plugin/src/rules/consistent-type-definitions.ts 89.18% <66.66%> (-1.99%) ⬇️
...perimental-utils/src/ts-eslint-scope/Referencer.ts
packages/eslint-plugin-tslint/src/rules/config.ts
packages/scope-manager/src/referencer/Visitor.ts
packages/eslint-plugin-tslint/src/custom-linter.ts
packages/typescript-estree/src/version-check.ts
packages/scope-manager/src/lib/es2019.object.ts
...ages/scope-manager/src/lib/es2016.array.include.ts
packages/scope-manager/src/scope/TSModuleScope.ts
...xperimental-utils/src/ts-eslint-scope/Reference.ts
... and 171 more

@nx-cloud
Copy link

nx-cloud bot commented Sep 17, 2021 •
edited
Loading

Nx Cloud Report

CI ran the following commands for commit 1e7e6d8. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Status Command
#000000 nx test @typescript-eslint/eslint-plugin-tslint
#000000 nx test @typescript-eslint/eslint-plugin
#000000 nx test @typescript-eslint/eslint-plugin-tslint
#000000 nx test @typescript-eslint/eslint-plugin
#000000 nx test @typescript-eslint/eslint-plugin-internal
#000000 nx test @typescript-eslint/eslint-plugin-tslint
#000000 nx test @typescript-eslint/eslint-plugin
#000000 nx run-many --target=typecheck --all --parallel
#000000 nx test @typescript-eslint/parser
#000000 nx test @typescript-eslint/experimental-utils
#000000 nx test @typescript-eslint/parser
#000000 nx test @typescript-eslint/scope-manager
#000000 nx test @typescript-eslint/experimental-utils
#000000 nx test @typescript-eslint/visitor-keys
#000000 nx test @typescript-eslint/scope-manager
#000000 nx test @typescript-eslint/typescript-estree
#000000 nx test @typescript-eslint/visitor-keys
#000000 nx run-many --target=build --all --parallel
#000000 nx test @typescript-eslint/typescript-estree
#000000 nx run-many --target=build --all --parallel

Sent with 💌 from NxCloud.

rafaelss95
rafaelss95 commented Sep 17, 2021
View reviewed changes
packages/eslint-plugin/src/rules/consistent-type-definitions.ts
@@ -122,6 +122,19 @@ export default util.createRule({
});
}

if (
Copy link
Contributor Author

@rafaelss95 rafaelss95 Sep 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

While working on this fix, I noticed that the option is checked after having already found a certain node (and in some other files as well), for example:

typescript-eslint/packages/eslint-plugin/src/rules/consistent-type-definitions.ts

Lines 50 to 54 in 1e7e6d8

return {
"TSTypeAliasDeclaration[typeAnnotation.type='TSTypeLiteral']"(
node: TSESTree.TSTypeAliasDeclaration,
): void {
if (option === 'interface') {

Other cases I found (click to expand)

typescript-eslint/packages/eslint-plugin/src/rules/method-signature-style.ts

Lines 120 to 123 in b1d4449

TSMethodSignature(methodNode): void {
if (mode === 'method') {
return;
}

typescript-eslint/packages/eslint-plugin/src/rules/restrict-plus-operands.ts

Lines 136 to 137 in 1c1b572

"AssignmentExpression[operator='+=']"(node): void {
if (checkCompoundAssignments) {

typescript-eslint/packages/eslint-plugin/src/rules/sort-type-union-intersection-members.ts

Lines 242 to 244 in 25ea953

return {
TSIntersectionType(node): void {
if (checkIntersections === true) {

typescript-eslint/packages/eslint-plugin/src/rules/typedef.ts

Lines 180 to 183 in 1c1b572

'FunctionDeclaration, FunctionExpression'(
node: TSESTree.FunctionDeclaration | TSESTree.FunctionExpression,
): void {
if (options[OptionKeys.Parameter]) {

typescript-eslint/packages/eslint-plugin/src/rules/explicit-function-return-type.ts

Lines 71 to 76 in 1c1b572

return {
'ArrowFunctionExpression, FunctionExpression'(
node: TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression,
): void {
if (
options.allowConciseArrowFunctionExpressionsStartingWithVoid &&

But, IMHO this could be improved by either moving the conditional up then wrapping the return { or, in some cases do ...(optionX && { node ... }), and so avoiding looking for nodes which doesn't corresponds unnecessarily. Does it makes sense for you? If so, I can send a PR refactor for that.

Copy link
Member

Choose a reason for hiding this comment

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

happy to accept a PR if you want!

@bradzacher bradzacher added the bug Something isn't working label Sep 20, 2021
bradzacher
bradzacher approved these changes Sep 20, 2021
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

thanks for fixing this!

@bradzacher bradzacher merged commit ebb33ed into typescript-eslint:master Sep 20, 2021
@rafaelss95 rafaelss95 deleted the fix/3894 branch September 20, 2021 23:33
@rafaelss95 rafaelss95 mentioned this pull request Sep 23, 2021
Merged
This was referenced Oct 1, 2021
Closed
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[consistent-type-definitions] Add option to use interface with methods
2 participants
@rafaelss95 @bradzacher