Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feat(eslint-plugin): add rule [strict-void-return]#9707

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
phaux wants to merge46 commits intotypescript-eslint:main
base:main
Choose a base branch
Loading
fromphaux:strict-void-return

Conversation

phaux
Copy link
Contributor

@phauxphaux commentedAug 2, 2024
edited
Loading

PR Checklist

Overview

So basically I implemented the void checking as requested by#2988. For every checked node (arguments, assignments, returns, etc) I take the actual function type and the contextual function type and compare return types. Only object method shorthand required slightly different logic.

That already worked pretty well, but I also found#1744 and decided to include it in this rule as well, since I already had a similar thing implemented for object shorthand methods.I added this as an optionconsiderBaseClass andconsiderImplementedInterfaces, enabled by default.

Then I noticed that callback foraddEventListener is not detected as void context. That's because it has another signature where the callback can returnany. I was stuck on this for a long time. Ultimately I looked at howno-misused-promises does this and implemented something similarasconsiderOtherSignatures option, enabled by default.

At this point this rule already did everythingno-misused-promises'scheckVoidReturn did, but better. It doesn't have problems like#8054 or#8739. Maybe it's worth splittingno-misused-promises into 3 separate rules in the future? (this one being one of them)

EDIT: autofixes removed for now

I also added many autofixes and suggestions. They are possible when the provided function is a function literal and we can inspect its body. Some of them are the same as inno-confusing-void-expression so I moved them into utils. It might make sense to change some autofixes into suggestions instead so they don't accidentally remove a big chunk of code. Let me know if that's a good idea.

The biggest feature is automatic suggestions which I and probably others had to type manually a thousand of times:

takesCallback(async()=>{block;});

into

takesCallback(()=>{(async()=>{block;})().catch(err=>{});});

or

// eslint-disable-next-line @typescript-eslint/no-misused-promisestakesCallback(async()=>{try{block;}catch{}});

To allow the second suggestion without the need of ignoring the line I added the optionallowReturnPromiseIfTryCatch. It's just a simple extraif near the end of the long routine that checks everything that could be wrong in the function body. I hope it can stay.

kirkwaiblinger, JoshuaKGoldberg, and alythobani reacted with heart emoji
@typescript-eslint
Copy link
Contributor

Thanks for the PR,@phaux!

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 onhttps://opencollective.com/typescript-eslint.

@netlifyNetlify
Copy link

netlifybot commentedAug 2, 2024
edited
Loading

Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commitede0145
🔍 Latest deploy loghttps://app.netlify.com/projects/typescript-eslint/deploys/6862ee99c4ec1b0009ab51f4
😎 Deploy Previewhttps://deploy-preview-9707--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (🟢 up 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify project configuration.

@nx-cloudNx Cloud
Copy link

nx-cloudbot commentedAug 2, 2024
edited
Loading

View yourCI Pipeline Execution ↗ for commitede0145.

CommandStatusDurationResult
nx run integration-tests:test❌ Failed45sView ↗
nx test eslint-plugin --coverage=false✅ Succeeded5m 6sView ↗
nx run-many -t typecheck✅ Succeeded2m 18sView ↗
nx run-many -t lint✅ Succeeded11sView ↗
nx test typescript-estree --coverage=false✅ Succeeded<1sView ↗
nx run types:build✅ Succeeded1sView ↗
nx test eslint-plugin-internal --coverage=false✅ Succeeded<1sView ↗
nx run generate-configs✅ Succeeded6sView ↗
Additional runs (27)✅ Succeeded...View ↗

☁️Nx Cloud last updated this comment at2025-06-30 20:19:20 UTC

@kirkwaiblingerkirkwaiblinger added the enhancement: new plugin ruleNew rule request for eslint-plugin labelAug 5, 2024
@codecovCodecov
Copy link

codecovbot commentedAug 5, 2024
edited
Loading

Codecov Report

Attention: Patch coverage is98.31325% with7 lines in your changes missing coverage. Please review.

Project coverage is 90.90%. Comparing base(f9bd7d8) to head(ede0145).

Files with missing linesPatch %Lines
...slint-plugin/src/util/getBaseTypesOfClassMember.ts78.78%7 Missing⚠️
Additional details and impacted files
@@            Coverage Diff             @@##             main    #9707      +/-   ##==========================================+ Coverage   90.84%   90.90%   +0.06%==========================================  Files         501      504       +3       Lines       50919    51334     +415       Branches     8387     8490     +103     ==========================================+ Hits        46256    46664     +408- Misses       4648     4655       +7  Partials       15       15
FlagCoverage Δ
unittest90.90% <98.31%> (+0.06%)⬆️

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

Files with missing linesCoverage Δ
packages/eslint-plugin/src/configs/eslintrc/all.ts100.00% <100.00%> (ø)
...lugin/src/configs/eslintrc/disable-type-checked.ts100.00% <100.00%> (ø)
packages/eslint-plugin/src/configs/flat/all.ts100.00% <100.00%> (ø)
...nt-plugin/src/configs/flat/disable-type-checked.ts100.00% <100.00%> (ø)
...ages/eslint-plugin/src/rules/strict-void-return.ts100.00% <100.00%> (ø)
packages/eslint-plugin/src/util/walkStatements.ts100.00% <100.00%> (ø)
...slint-plugin/src/util/getBaseTypesOfClassMember.ts78.78% <78.78%> (ø)
🚀 New features to boost your workflow:
  • ❄️Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commentedAug 10, 2024
edited
Loading

👋 Exciting PR, really looking forward to the rule! Just marking as a draft because there are unit test failures. This keeps getting me excited when it pops up in my notifications 😄. Let us know if you want to talk or ask questions about any of them.

Edit: ACK on the questions in the OP, I don't have the bandwidth to answer just now, but hopefully someone else does. Please ping us if those are blocking progress!

@JoshuaKGoldbergJoshuaKGoldberg marked this pull request as draftAugust 10, 2024 02:49
@phaux
Copy link
ContributorAuthor

Fixed and I'm not planning any more changes so I'm undrafting it I guess.

JoshuaKGoldberg reacted with thumbs up emojiJoshuaKGoldberg reacted with rocket emoji

@phauxphaux marked this pull request as ready for reviewAugust 10, 2024 15:48
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment
edited
Loading

Choose a reason for hiding this comment

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

OK! Very happy to have finally made it to this PR: it's a great piece of work. As you said, it covers a heck of a lot of functionality, and does so in ways that are really solid compared to previous approaches. Fantastic! 👏

It's also alot of code that was hard to read through. For an initial version of the rule, I think nuance around suggestions aren't necessary. And the fixers would need to be suggestions given they change code behavior.

I left requests for simplification through the code: for messages, options, and the suggestions.

But, my advice would be to hold off applying that large set of removals until the conversation inhttps://github.com/typescript-eslint/typescript-eslint/pull/9707/files#r1741336663 is resolved. The consensus might end up being that the options are good and useful after all.

Keanu Reaves as Neo in The Matrix saying 'whoa'

}
},
AssignmentExpression: (node): void => {
if (['=', '||=', '&&=', '??='].includes(node.operator)) {

Choose a reason for hiding this comment

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

[Testing] If I remove thisif and just leave its body, all unit tests still pass. That means there's at least a missing test case.

Choose a reason for hiding this comment

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

This is still the case.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Added a test but it doesn't matter:

declareletfoo:()=>void;foo+=()=>1;

still doesn't fail with condition removed.

Choose a reason for hiding this comment

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

Sounds to me like theif can be removed, then! 🔪

Change request: remove theif?

Just noting for posterity,node.operator in anAssignmentExpression can be any of:

"="|"+="|"-="|"*="|"**="|"/="|"%="|"<<="|">>="|">>>="|"&="|"|="|"||="|"&&="|"??="|"^="

The operators not mentioned in theif all produce TypeScript errors when given functions. So I agree with adding thevalid test case containingfoo += () => 1. That makes sure the removal of theif doesn't break those cases.

Choose a reason for hiding this comment

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

At this point this rule already did everythingno-misused-promises'scheckVoidReturn did, but better. It doesn't have problems#8054 or#8739. Maybe it's worth splittingno-misused-promises into 3 separate rules in the future? (this one being one of them)

This is a great question.no-misused-promises was already largely overlapped byno-unnecessary-condition. This newstrict-void-return pretty much takes on the rest ofno-misused-promises, makingno-misused-promises redundant if you have bothno-unnecessary-condition andstrict-void-return...

I'd be in favor of deprecatedno-misused-promises in favor of usingno-unnecessary-condition +strict-void-return. The only benefit I can think of forno-misused-promises would be projects that want toonly apply the checks for Promises... Maybe these two rules could each be given some kind of"only check Promises" option?

Also of note is thatno-misused-promises'scheckVoidReturns is pretty configurable. Maybe, if this rule is to replaceno-misused-promises, it'd be useful to have each of those configurable options? Or, on the other hand, maybe those options are holdovers that real-world don't generally use? Investigation needed. I think those options can be a followup & shouldn't block this PR.

What do you think?

Also cc: @typescript-eslint/triage-team in general, and@kirkwaiblinger +@alythobani from#8765.

alythobani reacted with thumbs up emoji
Copy link
Contributor

@alythobanialythobaniSep 6, 2024
edited
Loading

Choose a reason for hiding this comment

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

no-misused-promises was already largely overlapped by no-unnecessary-condition. This new strict-void-return pretty much takes on the rest of no-misused-promises, making no-misused-promises redundant if you have both no-unnecessary-condition and strict-void-return...

Yeah the only thing left I think would be thechecksSpreads option:

constmyPromise=Promise.resolve({num:2,str:"2"});constmyObject={...myPromise};// Expected a non-Promise value to be spreaded in an object. eslint(@typescript-eslint/no-misused-promises)

I do agree it could make sense to replacechecksVoidReturn withstrict-void-return. Although there may be tradeoffs in terms of eng effort and/or UX complexity if we wanted to retain all the configurability on top of having anonlyChecksPromises option.

As forchecksConditionals, I actually just foundmicrosoft/TypeScript#34717 andmicrosoft/TypeScript#39175—looks likecheckConditionals has been covered by TypeScript for a couple years now :)

The only benefit I can think of for no-misused-promises would be projects that want to only apply the checks for Promises

Yeah e.g. one example I've seen when looking into this topic (void function assignability), isusingpush withforEach:

declarefunctionforEach<T>(arr:T[],callback:(el:T)=>void):void;lettarget:number[]=[];forEach([1,2,3],el=>target.push(el));// OK

It's possible some users would prefer to only check Promises so they can still use shorthands like the above without linter errors (and/or just mainly care about forgetting toawait Promises), in which case anonlyChecksPromises option would be useful if we did replacechecksVoidReturn withstrict-void-return.

Maybe, if this rule is to replace no-misused-promises, it'd be useful to have each of those configurable options? Or, on the other hand, maybe those options are holdovers that real-world don't generally use?

It looks like#4619 was originally the impetus for adding the options (#4623); and based on the thread it looks like there are at least a few people who find the configurability you added very helpful!

Choose a reason for hiding this comment

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

Maybe a lame response, but is there a compelling reason not to land this first, then consider the no-misused-promises deprecation, and which options we might need to port or create in order to do so, afterwards?

Just thinking, deprecating no-misused-promises might have some strings attached, such as some nontrivial updating of the docs in no-floating-promises that explain how to lint against promise antipatterns outside of ExpressionStatements.

JoshuaKGoldberg and alythobani reacted with thumbs up emoji

Choose a reason for hiding this comment

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

Agreed with landing this first, then considering a deprecation as a followup.

In fact, this rule is pretty big and scary. We don't really have a process for declaring rules as "canary" or "experimental".#8676 is the closest we have to a feature request. Maybe we should set a precedent?

(I don't think this PR should be blocked on that)

@JoshuaKGoldbergJoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party labelSep 3, 2024
Copy link
Contributor

@alythobanialythobani left a comment
edited
Loading

Choose a reason for hiding this comment

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

Very cool PR, great job sticking it out and a lot of thought put into things!

Left some thoughts/questions, hope they're helpful 🌅

Copy link
Contributor

@alythobanialythobaniSep 6, 2024
edited
Loading

Choose a reason for hiding this comment

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

no-misused-promises was already largely overlapped by no-unnecessary-condition. This new strict-void-return pretty much takes on the rest of no-misused-promises, making no-misused-promises redundant if you have both no-unnecessary-condition and strict-void-return...

Yeah the only thing left I think would be thechecksSpreads option:

constmyPromise=Promise.resolve({num:2,str:"2"});constmyObject={...myPromise};// Expected a non-Promise value to be spreaded in an object. eslint(@typescript-eslint/no-misused-promises)

I do agree it could make sense to replacechecksVoidReturn withstrict-void-return. Although there may be tradeoffs in terms of eng effort and/or UX complexity if we wanted to retain all the configurability on top of having anonlyChecksPromises option.

As forchecksConditionals, I actually just foundmicrosoft/TypeScript#34717 andmicrosoft/TypeScript#39175—looks likecheckConditionals has been covered by TypeScript for a couple years now :)

The only benefit I can think of for no-misused-promises would be projects that want to only apply the checks for Promises

Yeah e.g. one example I've seen when looking into this topic (void function assignability), isusingpush withforEach:

declarefunctionforEach<T>(arr:T[],callback:(el:T)=>void):void;lettarget:number[]=[];forEach([1,2,3],el=>target.push(el));// OK

It's possible some users would prefer to only check Promises so they can still use shorthands like the above without linter errors (and/or just mainly care about forgetting toawait Promises), in which case anonlyChecksPromises option would be useful if we did replacechecksVoidReturn withstrict-void-return.

Maybe, if this rule is to replace no-misused-promises, it'd be useful to have each of those configurable options? Or, on the other hand, maybe those options are holdovers that real-world don't generally use?

It looks like#4619 was originally the impetus for adding the options (#4623); and based on the thread it looks like there are at least a few people who find the configurability you added very helpful!

Choose a reason for hiding this comment

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

Maybe a lame response, but is there a compelling reason not to land this first, then consider the no-misused-promises deprecation, and which options we might need to port or create in order to do so, afterwards?

Just thinking, deprecating no-misused-promises might have some strings attached, such as some nontrivial updating of the docs in no-floating-promises that explain how to lint against promise antipatterns outside of ExpressionStatements.

JoshuaKGoldberg and alythobani reacted with thumbs up emoji
@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commentedDec 31, 2024
edited
Loading

👋 Just checking in@phaux - is this ready for review? Anything we can help with?

@phaux
Copy link
ContributorAuthor

I addressed most of the issues.

I left some unrelated refactors in another rule because they were needed for this rule's auto fixes, which are now removed and will be sent as separate PR. If that's important I can try to remove the unrelated changes too for now. I have to do it manually because they were part of the big initial commit and I was lazy.

The messages still use dynamic IDs, but I reduced their number by a lot. If that's still too many messages, let me know and I will just replace all of them with a single generic message like "value returned in void context" and move them to a separate PR so it can be discussed later too.

JoshuaKGoldberg reacted with rocket emoji

@phauxphaux marked this pull request as ready for reviewJanuary 7, 2025 18:43
@github-actionsgithub-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party labelJan 7, 2025
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Progress! 🚀

Requesting some more simplification changes that'll help us review please.

if (newReturnText[0] === '{') {
// The value would be interpreted as a block statement,
// so we need to wrap it in parentheses.
newReturnText = `(${newReturnText})`;

Choose a reason for hiding this comment

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

[Testing] This isn't covered by any tests - either it's a valid case that should be tested, or it's not and we can remove it.

Choose a reason for hiding this comment

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

[Refactor] -1 from me in general on this extra set of assertions. There's a reason we haven't leaned into this pattern more: values should be their expected type before being used.

E.g. instead of:

memberTsNode:ts.MethodDeclaration|ts.PropertyDeclaration,// ...ESLintUtils.assert(ts.isClassLike(memberTsNode.parent),'...');

...we'd want either:

  • Ifts.MethodDeclaration | ts.PropertyDeclaration's.parentis always ats.ClassLikeDeclaration, the AST's types should reflect that
  • Ifts.MethodDeclaration | ts.PropertyDeclaration's.parentisn't always ats.ClassLikeDeclaration, thenmemberTsNode's type should have something like{ parent: ts.ClassLikeDeclaration } added

In other words: I think these assertions are surface-level fixes for type issues that should be fixed at a deeper level.


I'll also note that we generally try to work with the TSESTree AST rather than TypeScript's, when possible. Will mention this ongetBaseTypesOfClassMember itself.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

replaced withas

*/
export function* getBaseTypesOfClassMember(
checker: ts.TypeChecker,
memberTsNode: ts.MethodDeclaration | ts.PropertyDeclaration,

Choose a reason for hiding this comment

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

Continuing from the comment on assertions: I'll also note that we generally try to work with the TSESTree AST rather than TypeScript's, when possible. We have more flexibility and power to make the AST more specific because we're the ones who define it (and we define it as a discriminated union).

In this case it'd be more typical for a typed lint rule to take in the TSESTree node. You can also pass in theservices: ParserServicesWithTypeInformation to use APIs likeservices.getSymbolAtLocation.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Done

asyncFuncInAttr:
'Async event handler `{{attrName}}` passed as a prop to `{{elemName}}`, which expects a void event handler.',
asyncFuncInExtMember:
'Async function provided as `{{memberName}}` method of `{{className}}`, whose base class `{{baseName}}` declares it as a void method.',

Choose a reason for hiding this comment

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

[Typo] Grammar fix:

Suggested change
'Async function provided as `{{memberName}}` method of `{{className}}`, whose base class `{{baseName}}` declaresitas a void method.',
'Async function provided as `{{memberName}}` method of `{{className}}`, whose base class `{{baseName}}` declares as a void method.',

defaultOptions: [
{
allowReturnNull: false,
allowReturnPromiseIfTryCatch: true,

Choose a reason for hiding this comment

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

[Feature] In this PR's OP,allowReturnPromiseIfTryCatch is only mentioned in the collapsed note around fixers & suggestions. Seems to me it's no longer necessary, right?

ACK that it's not much added code but I don't think we have consensus that it's a strategy we'd want to add to the rule. Could you please split it out? We can always talk about it more in a followup issue - either its own and/or the one around fixers & suggestions.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Removed

}
},
AssignmentExpression: (node): void => {
if (['=', '||=', '&&=', '??='].includes(node.operator)) {

Choose a reason for hiding this comment

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

This is still the case.

Comment on lines 41 to 42
fixable: 'code',
hasSuggestions: false,

Choose a reason for hiding this comment

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

Suggested change
fixable:'code',
hasSuggestions:false,

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

fixed

{
allowReturnNull: false,
allowReturnPromiseIfTryCatch: true,
allowReturnUndefined: true,

Choose a reason for hiding this comment

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

[Question] Separate from the promise/try-catch options, I don't know that we really need the remainingallowReturn* options. They're added complexity for the first version of a rule we haven't tried out in the real world yet. Do you see a strong need for them? (if not, I'm -1 on including them)

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

removed

@JoshuaKGoldbergJoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party labelFeb 24, 2025
@JoshuaKGoldberg
Copy link
Member

👋 Checking in@phaux, do you think you'll have the time to drive this to completion over the next month or two? I really like the idea of the rule but it's been sitting for a while - it'd be nice to either really push it forward or open it up to get worked on.

@JoshuaKGoldbergJoshuaKGoldberg added the stalePRs or Issues that are at risk of being or have been closed due to inactivity for a prolonged period labelApr 7, 2025
@phaux
Copy link
ContributorAuthor

@JoshuaKGoldberg Sorry for the wait. I recreated this branch from scratch and the next version will be as minimal as possible so hopefully it finally passes review :) I will send it in few days probably.

JoshuaKGoldberg reacted with heart emojiJoshuaKGoldberg reacted with rocket emoji

@github-actionsgithub-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party labelApr 25, 2025
@phaux
Copy link
ContributorAuthor

Ready

skondrashov reacted with eyes emoji

@JoshuaKGoldbergJoshuaKGoldberg removed the stalePRs or Issues that are at risk of being or have been closed due to inactivity for a prolonged period labelJun 18, 2025
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

OK! Sorry this took so long to get a review - it's a really wonderful new rule and has a lot of nuance that I wanted to give the attention it deserves. The functionality generally looks great to me, I think you nailed a lot of the hard-to-get-right cases. Awesome! 👏

I'm mostly requesting changes to address the logical branches that don't seem to impact unit tests when removed. For each, some code change should be done: either adding tests for a necessary runtime check or removing code (possibly also fiddling with types) for an unnecessary-at-runtime check.

I also took a pass at docs. They don't have to be perfect for merge, we can always touch them up as we go.

Thanks for bringing this back into review, it's a really exciting rule!

}
},
AssignmentExpression: (node): void => {
if (['=', '||=', '&&=', '??='].includes(node.operator)) {

Choose a reason for hiding this comment

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

Sounds to me like theif can be removed, then! 🔪

Change request: remove theif?

Just noting for posterity,node.operator in anAssignmentExpression can be any of:

"="|"+="|"-="|"*="|"**="|"/="|"%="|"<<="|">>="|">>>="|"&="|"|="|"||="|"&&="|"??="|"^="

The operators not mentioned in theif all produce TypeScript errors when given functions. So I agree with adding thevalid test case containingfoo += () => 1. That makes sure the removal of theif doesn't break those cases.

},
};

/** Checks whether the type is a void-returning function type. */

Choose a reason for hiding this comment

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

[Docs] Nit: I think the"is void returning function type" title says the same thing as this comment.

Suggested change
/** Checks whether the type is a void-returning function type. */

return (
// At least one return type is void
returnTypes.some(type =>
tsutils.isTypeFlagSet(type, ts.TypeFlags.Void),

Choose a reason for hiding this comment

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

[Question] This usesVoid but the next check usesVoidLike. Swapping to any other combination of the type flags doesn't produce any test failures. Was there a reason to choose one vs. the other?

I'm genuinely asking, I don't know 😄

Comment on lines +76 to +78
If a promise is returned from a callback that should return void,
it probably won't be awaited and its rejection will be silently ignored
or crash the process depending on runtime.

Choose a reason for hiding this comment

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

[Docs] Some users bristle at definitive, declarative statements like"if you do X, then Y will happen" when their design allows X without Y. Even if X and Y are not good.

Suggested change
If apromise isreturned from a callback that should return void,
it probably won't be awaited and its rejection will be silently ignored
or crash the process depending on runtime.
If acallback ismeant to return void, values returned from functions are likely ignored.
Ignoring a returned Promise means any Promise rejection will be silently ignored
or crash the process depending on runtime.

Comment on lines +159 to +160
Returning a value from a void function is likely a mistake on part of the programmer.
This rule will often warn you early when using a function in a wrong way.

Choose a reason for hiding this comment

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

Suggested change
Returning a value from a void function is likely a mistake on part of the programmer.
This rule will often warn you early when using a function in a wrong way.
Returning a value from a void function often is an indication of incorrect assumptions about APIs.
Those incorrect assumptions can often lead to bugs.
The following`forEach` loop is a common mistake: its author likely either meant to add`console.log` or meant to use`.map` instead.

Comment on lines +237 to +242
if (
propNode.value.type === AST_NODE_TYPES.AssignmentPattern ||
propNode.value.type === AST_NODE_TYPES.TSEmptyBodyFunctionExpression
) {
return;
}

Choose a reason for hiding this comment

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

[Testing] Removing thisif check doesn't fail any unit tests. Either this check should exist and tests are missing, or this is dead code that can be removed.

Similar note to earlier on the type narrowing.

Comment on lines +290 to +292
if (propNode.value == null) {
return;
}

Choose a reason for hiding this comment

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

[Testing] Removing thisif check doesn't fail any unit tests. Either this check should exist and tests are missing, or this is dead code that can be removed.

Comment on lines +316 to +323
if (
methodNode.value.type === AST_NODE_TYPES.TSEmptyBodyFunctionExpression
) {
return;
}
if (methodNode.kind !== 'method') {
return;
}

Choose a reason for hiding this comment

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

[Testing] Removing thisif checks doesn't fail any unit tests. Either they should exist and tests are missing, or this is dead code that can be removed.

JSXAttribute: (node): void => {
if (
node.value?.type === AST_NODE_TYPES.JSXExpressionContainer &&
node.value.expression.type !== AST_NODE_TYPES.JSXEmptyExpression

Choose a reason for hiding this comment

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

[Testing] Removing the&& node.value... !== JSXEmptyExpression doesn't fail any unit tests. Either this check should exist and tests are missing, or this is dead code that can be removed.

If the reason it's here is to narrownode.value.expression's type down toTSESTree.Expression then maybe either the types are suggesting a legit case to handle, or are wrong?

Choose a reason for hiding this comment

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

Agreed with landing this first, then considering a deprecation as a followup.

In fact, this rule is pretty big and scary. We don't really have a process for declaring rules as "canary" or "experimental".#8676 is the closest we have to a feature request. Maybe we should set a precedent?

(I don't think this PR should be blocked on that)

@JoshuaKGoldbergJoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party labelJun 30, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@alythobanialythobanialythobani left review comments

@kirkwaiblingerkirkwaiblingerkirkwaiblinger left review comments

@JoshuaKGoldbergJoshuaKGoldbergJoshuaKGoldberg requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
awaiting responseIssues waiting for a reply from the OP or another partyenhancement: new plugin ruleNew rule request for eslint-plugin
Projects
None yet
Milestone
No milestone
4 participants
@phaux@JoshuaKGoldberg@alythobani@kirkwaiblinger

[8]ページ先頭

©2009-2025 Movatter.jp