feat(eslint-plugin): [explicit-function-return-type] add allowIIFEs option #6237

yeonjuan · 2022-12-17T16:51:21Z

PR Checklist

Addresses an existing open issue: fixes Enhancement: [explicit-function-return-type] add option to ignore IIFEs #6115
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

…ption

typescript-eslint · 2022-12-17T16:51:23Z

Thanks for the PR, @yeonjuan!

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.

nx-cloud · 2022-12-17T16:51:23Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f18a367. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

netlify · 2022-12-17T16:51:25Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f18a367`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63e924cb75acbc000848b2bb
😎 Deploy Preview	https://deploy-preview-6237--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

codecov · 2022-12-17T17:04:47Z

Codecov Report

Merging #6237 (1c702dc) into main (766ab1d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 1c702dc differs from pull request most recent head f18a367. Consider uploading reports for the commit f18a367 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6237   +/-   ##
=======================================
  Coverage   90.61%   90.61%           
=======================================
  Files         372      372           
  Lines       12709    12712    +3     
  Branches     3739     3740    +1     
=======================================
+ Hits        11516    11519    +3     
  Misses        853      853           
  Partials      340      340

Flag	Coverage Δ
unittest	`90.61% <100.00%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
...-plugin/src/rules/explicit-function-return-type.ts	`97.95% <100.00%> (+0.13%)`	⬆️

JoshuaKGoldberg

Looks lovely to start! Just requesting a bit more test coverage please. 🙌

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

JoshuaKGoldberg · 2022-12-17T19:31:56Z

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts

+          endColumn: 22,
+        },
+      ],
+    },


Let's add a bit more test coverage:

IIFEs with return types

Multiple levels of IIFEs (e.g. (() => () => {})()())

Arguments & parameters

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

…lint#6115

yeonjuan · 2022-12-26T17:37:10Z

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts

+    {
+      filename: 'test.ts',
+      code: `
+let foo = (() => () => {})()();


@JoshuaKGoldberg
How should we handle multiple levels of IIFEs? For now, it allows only if the function is called directly.

const foo = (() => () => "foo")()(); // error const bar = (() => (() => "foo")())(); // pass

Should both cases be passed when the allowIIFEs option is true?

@yeonjuan The first one IMO is not an "IIFE" by definition—(() => () => "foo")() is an expression that happens to evaluate to a function, not a function expression itself. It's fine if we don't handle it.

I would agree with that assessment.
The inner function is not an IIFE, just the outer function.

JoshuaKGoldberg · 2023-02-05T01:57:28Z

👋 ping @yeonjuan, is this still something you have time for? And if so, do you have all the answers you need?

yeonjuan · 2023-02-05T17:03:17Z

@JoshuaKGoldberg Sorry for the late, I missed some comment notifications. I'll work on this in this week!

# Conflicts: # packages/eslint-plugin/src/rules/explicit-function-return-type.ts

JoshuaKGoldberg

Super thanks @yeonjuan! 🚀

This is looking great - I'll do the one probably-doesn't-matter touchup and merge.

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts

…pe.test.ts

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.51.0/5.52.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.51.0/5.52.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13) [Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0) ##### Bug Fixes - **eslint-plugin:** \[no-import-type-side-effects] correctly ignore zero-specifier imports ([#6444](typescript-eslint/typescript-eslint#6444)) ([d5a6688](typescript-eslint/typescript-eslint@d5a6688)) - **eslint-plugin:** \[no-unnecessary-condition] account for optional chaining on potentially void values ([#6432](typescript-eslint/typescript-eslint#6432)) ([e1d9c67](typescript-eslint/typescript-eslint@e1d9c67)), closes [#5255](typescript-eslint/typescript-eslint#5255) - **eslint-plugin:** \[no-unnecessary-condition] fix false positive when checking indexed access types ([#6452](typescript-eslint/typescript-eslint#6452)) ([d569924](typescript-eslint/typescript-eslint@d569924)) - **eslint-plugin:** fix key-spacing when type starts on next line ([#6412](typescript-eslint/typescript-eslint#6412)) ([3eb2eed](typescript-eslint/typescript-eslint@3eb2eed)) ##### Features - **eslint-plugin:** \[block-spacing] extending base rule for TS related blocks ([#6195](typescript-eslint/typescript-eslint#6195)) ([b2db3f5](typescript-eslint/typescript-eslint@b2db3f5)) - **eslint-plugin:** \[explicit-function-return-type] add allowFunctionsWithoutTypeParameters option ([#6105](typescript-eslint/typescript-eslint#6105)) ([113640e](typescript-eslint/typescript-eslint@113640e)) - **eslint-plugin:** \[explicit-function-return-type] add allowIIFEs option ([#6237](typescript-eslint/typescript-eslint#6237)) ([a1b3f7b](typescript-eslint/typescript-eslint@a1b3f7b)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13) [Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1784 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

feat(eslint-plugin): [explicit-function-return-type] add allowIIFEs o…

dd7e799

…ption

yeonjuan added 2 commits December 18, 2022 02:53

remove useless code

3f8a981

fix tests

a242fb7

yeonjuan force-pushed the fix/#6115 branch from c83894e to a242fb7 Compare December 17, 2022 18:28

JoshuaKGoldberg requested changes Dec 17, 2022

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Dec 17, 2022

apply reviews

75a520d

yeonjuan commented Dec 18, 2022

View reviewed changes

packages/eslint-plugin/src/rules/explicit-function-return-type.ts Outdated Show resolved Hide resolved

yeonjuan added 6 commits December 18, 2022 23:47

remove useless lint

28f2a6a

add tc

0739ae5

fix

d3e168c

Merge branch 'main' into fix/typescript-eslint#6115

47cf0c5

add test cases

a6fba09

Merge branch 'fix/typescript-eslint#6115-temp' into fix/typescript-es…

9c7da1b

…lint#6115

yeonjuan commented Dec 26, 2022

View reviewed changes

bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 19, 2023

bradzacher added the enhancement: plugin rule option New rule option for an existing eslint-plugin rule label Jan 30, 2023

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Feb 5, 2023

yeonjuan added 5 commits February 12, 2023 22:56

Merge branch 'main' into fix/typescript-eslint#6115

10f64e0

# Conflicts: # packages/eslint-plugin/src/rules/explicit-function-return-type.ts

fix

7affa5b

fix

2657eb6

add test cases

0af3c21

add test case

1c702dc

yeonjuan requested a review from JoshuaKGoldberg February 12, 2023 15:27

JoshuaKGoldberg previously approved these changes Feb 12, 2023

View reviewed changes

packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts Outdated Show resolved Hide resolved

Update packages/eslint-plugin/tests/rules/explicit-function-return-ty…

f18a367

…pe.test.ts

JoshuaKGoldberg dismissed their stale review via f18a367 February 12, 2023 17:41

JoshuaKGoldberg approved these changes Feb 12, 2023

View reviewed changes

JoshuaKGoldberg merged commit a1b3f7b into typescript-eslint:main Feb 12, 2023

github-actions bot locked as resolved and limited conversation to collaborators Feb 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [explicit-function-return-type] add allowIIFEs option #6237

feat(eslint-plugin): [explicit-function-return-type] add allowIIFEs option #6237

yeonjuan commented Dec 17, 2022

typescript-eslint bot commented Dec 17, 2022

nx-cloud bot commented Dec 17, 2022 •

edited

netlify bot commented Dec 17, 2022 •

edited

codecov bot commented Dec 17, 2022 •

edited

JoshuaKGoldberg left a comment

JoshuaKGoldberg Dec 17, 2022

yeonjuan Dec 26, 2022

Josh-Cena Dec 26, 2022

bradzacher Jan 19, 2023

JoshuaKGoldberg commented Feb 5, 2023

yeonjuan commented Feb 5, 2023 •

edited

JoshuaKGoldberg left a comment

feat(eslint-plugin): [explicit-function-return-type] add allowIIFEs option #6237

feat(eslint-plugin): [explicit-function-return-type] add allowIIFEs option #6237

Conversation

yeonjuan commented Dec 17, 2022

PR Checklist

Overview

typescript-eslint bot commented Dec 17, 2022

nx-cloud bot commented Dec 17, 2022 • edited

☁️ Nx Cloud Report

netlify bot commented Dec 17, 2022 • edited

✅ Deploy Preview for typescript-eslint ready!

codecov bot commented Dec 17, 2022 • edited

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg Dec 17, 2022

Choose a reason for hiding this comment

yeonjuan Dec 26, 2022

Choose a reason for hiding this comment

Josh-Cena Dec 26, 2022

Choose a reason for hiding this comment

bradzacher Jan 19, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg commented Feb 5, 2023

yeonjuan commented Feb 5, 2023 • edited

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

nx-cloud bot commented Dec 17, 2022 •

edited

netlify bot commented Dec 17, 2022 •

edited

codecov bot commented Dec 17, 2022 •

edited

yeonjuan commented Feb 5, 2023 •

edited