Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 45 commits into
base: main
Choose a base branch
from

Conversation

phaux
Copy link
Contributor

@phaux phaux commented Aug 2, 2024

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 option considerBaseClass and considerImplementedInterfaces, enabled by default.

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

At this point this rule already did everything no-misused-promises's checkVoidReturn did, but better. It doesn't have problems like #8054 or #8739. Maybe it's worth splitting no-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 in no-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-promises
takesCallback(async () => {
  try {
    block;
  } catch {}
});

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

@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 on https://opencollective.com/typescript-eslint.

Copy link

netlify bot commented Aug 2, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 74dfcba
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/680b91b9fcc5cf0008b253d9
😎 Deploy Preview https://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: 93 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 98 (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 your Netlify site configuration.

Copy link

nx-cloud bot commented Aug 2, 2024

View your CI Pipeline Execution ↗ for commit 74dfcba.

Command Status Duration Result
nx test eslint-plugin ✅ Succeeded 6m 11s View ↗
nx run eslint-plugin:test -- --coverage ✅ Succeeded 6m 34s View ↗
nx test eslint-plugin --coverage=false ✅ Succeeded 5m 12s View ↗
nx test rule-tester ✅ Succeeded 1s View ↗
nx test scope-manager ✅ Succeeded 1s View ↗
nx run types:build ✅ Succeeded 1s View ↗
nx test ast-spec ✅ Succeeded 2s View ↗
nx typecheck ast-spec ✅ Succeeded 2s View ↗
Additional runs (26) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-04-25 13:59:04 UTC

@kirkwaiblinger kirkwaiblinger added the enhancement: new plugin rule New rule request for eslint-plugin label Aug 5, 2024
Copy link

codecov bot commented Aug 5, 2024

Codecov Report

Attention: Patch coverage is 98.31325% with 7 lines in your changes missing coverage. Please review.

Project coverage is 90.89%. Comparing base (5c2f474) to head (74dfcba).

Files with missing lines Patch % Lines
...slint-plugin/src/util/getBaseTypesOfClassMember.ts 78.78% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9707      +/-   ##
==========================================
+ Coverage   90.83%   90.89%   +0.06%     
==========================================
  Files         497      500       +3     
  Lines       50259    50674     +415     
  Branches     8291     8394     +103     
==========================================
+ Hits        45652    46060     +408     
- Misses       4592     4599       +7     
  Partials       15       15              
Flag Coverage Δ
unittest 90.89% <98.31%> (+0.06%) ⬆️

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

Files with missing lines Coverage Δ
packages/eslint-plugin/src/configs/eslintrc/all.ts 100.00% <100.00%> (ø)
...lugin/src/configs/eslintrc/disable-type-checked.ts 100.00% <100.00%> (ø)
packages/eslint-plugin/src/configs/flat/all.ts 100.00% <100.00%> (ø)
...nt-plugin/src/configs/flat/disable-type-checked.ts 100.00% <100.00%> (ø)
...ages/eslint-plugin/src/rules/strict-void-return.ts 100.00% <100.00%> (ø)
packages/eslint-plugin/src/util/walkStatements.ts 100.00% <100.00%> (ø)
...slint-plugin/src/util/getBaseTypesOfClassMember.ts 78.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 commented Aug 10, 2024

👋 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!

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as draft August 10, 2024 02:49
@phaux
Copy link
Contributor Author

phaux commented Aug 10, 2024

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

@phaux phaux marked this pull request as ready for review August 10, 2024 15:48
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

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 a lot 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 in https://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)) {
Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member

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
Contributor Author

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:

declare let foo: () => void;
foo += () => 1;

still doesn't fail with condition removed.

Copy link
Member

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 everything no-misused-promises's checkVoidReturn did, but better. It doesn't have problems #8054 or #8739. Maybe it's worth splitting no-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 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...

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

Also of note is that no-misused-promises's checkVoidReturns is pretty configurable. 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? 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.

Copy link
Contributor

@alythobani alythobani Sep 6, 2024

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 the checksSpreads option:

const myPromise = Promise.resolve({num: 2, str: "2"});
const myObject = {...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 replace checksVoidReturn with strict-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 an onlyChecksPromises option.

As for checksConditionals, I actually just found microsoft/TypeScript#34717 and microsoft/TypeScript#39175—looks like checkConditionals 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), is using push with forEach:

declare function forEach<T>(arr: T[], callback: (el: T) => void): void;
let target: 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 to await Promises), in which case an onlyChecksPromises option would be useful if we did replace checksVoidReturn with strict-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!

Copy link
Member

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 JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Sep 3, 2024
Copy link
Contributor

@alythobani alythobani left a comment

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

@alythobani alythobani Sep 6, 2024

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 the checksSpreads option:

const myPromise = Promise.resolve({num: 2, str: "2"});
const myObject = {...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 replace checksVoidReturn with strict-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 an onlyChecksPromises option.

As for checksConditionals, I actually just found microsoft/TypeScript#34717 and microsoft/TypeScript#39175—looks like checkConditionals 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), is using push with forEach:

declare function forEach<T>(arr: T[], callback: (el: T) => void): void;
let target: 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 to await Promises), in which case an onlyChecksPromises option would be useful if we did replace checksVoidReturn with strict-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!

Copy link
Member

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
Copy link
Member

JoshuaKGoldberg commented Dec 31, 2024

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

@phaux
Copy link
Contributor Author

phaux commented Jan 7, 2025

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.

@phaux phaux marked this pull request as ready for review January 7, 2025 18:43
@phaux phaux requested a review from JoshuaKGoldberg January 7, 2025 18:43
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 7, 2025
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg 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})`;
Copy link
Member

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.

Copy link
Member

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:

  • If ts.MethodDeclaration | ts.PropertyDeclaration's .parent is always a ts.ClassLikeDeclaration, the AST's types should reflect that
  • If ts.MethodDeclaration | ts.PropertyDeclaration's .parent isn't always a ts.ClassLikeDeclaration, then memberTsNode'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 on getBaseTypesOfClassMember itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

replaced with as

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

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 the services: ParserServicesWithTypeInformation to use APIs like services.getSymbolAtLocation.

Copy link
Contributor Author

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.',
Copy link
Member

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}}` declares it as a void method.',
'Async function provided as `{{memberName}}` method of `{{className}}`, whose base class `{{baseName}}` declares as a void method.',

Copy link
Member

Choose a reason for hiding this comment

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

[Testing] A few more edge cases to test

  • extends Bar implements Foo, Baz
  • extends class { ... } and extends class WithName { ... }
  • implements class { ... } and implements class WithName { ... }

Copy link
Contributor Author

Choose a reason for hiding this comment

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

class implements class {} {} is already invalid TS

defaultOptions: [
{
allowReturnNull: false,
allowReturnPromiseIfTryCatch: true,
Copy link
Member

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
Contributor Author

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)) {
Copy link
Member

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.

},
ObjectExpression: (node): void => {
for (const propNode of node.properties) {
if (propNode.type !== AST_NODE_TYPES.SpreadElement) {
Copy link
Member

Choose a reason for hiding this comment

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

Oop, sorry I missed this question. Looking at the non-spread test case that hits this line:

declare function cb(): void;
const foo: Record<string, () => void> = {
  cb1: cb,
  cb2: cb,
};

We'd be able to trigger it by switching one of those properties to a spread:

declare function cb(): void;
const foo: Record<string, () => void> = {
  cb1: cb,
  ...{},
};

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

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
Contributor Author

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,
Copy link
Member

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 remaining allowReturn* 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
Contributor Author

Choose a reason for hiding this comment

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

removed

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Feb 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.

@JoshuaKGoldberg JoshuaKGoldberg added the stale PRs or Issues that are at risk of being or have been closed due to inactivity for a prolonged period label Apr 7, 2025
@phaux
Copy link
Contributor Author

phaux commented Apr 7, 2025

@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.

@phaux phaux force-pushed the strict-void-return branch from eeb8ae4 to 55b6378 Compare April 24, 2025 13:29
@phaux phaux requested a review from JoshuaKGoldberg April 25, 2025 14:11
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Apr 25, 2025
@phaux
Copy link
Contributor Author

phaux commented Apr 25, 2025

Ready

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement: new plugin rule New rule request for eslint-plugin stale PRs or Issues that are at risk of being or have been closed due to inactivity for a prolonged period
Projects
None yet
4 participants