feat(eslint-plugin): [explicit-function-return-type] add allowFunctionsWithoutTypeParameters option #6105
Conversation
…nsWithoutTypeParameters option
|
Thanks for the PR, @JoshuaKGoldberg! 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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #6105 +/- ##
=======================================
Coverage 91.28% 91.28%
=======================================
Files 366 366
Lines 12363 12365 +2
Branches 3617 3618 +1
=======================================
+ Hits 11285 11287 +2
Misses 768 768
Partials 310 310
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
As an avid typescript eslint fan, and someone who reads the release notes for each version, then read the linked PRs for each change, i'm missing documentation for the new flag, and it's implicit default value (i'm guessing false by reading the code). These sort of things save time when considering changing my lint config based on an update... (also, I like |
|
A lot of our docs have auto-generated bits n bobs now! So the rule page has the type and default value generated on the website, which also includes a comment with the description of the option https://typescript-eslint.io/rules/explicit-function-return-type/#examples But I agree - we forgot about properly documenting this - an example would be good to illustrate this what it does! |
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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzNi4wIn0=--> 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>
|
I can't see the default value in this page, nor the option show up in the sidebar of available options. The only place the new option shows up when I search for it (via the browser's search) on that page is the options documentation itself (e.g. 1 search result on the page) |
|
@eranhirsch you're right, sorry about that. Filed #6465. I look forward to seeing your pull request adding in the docs. 😄 |
PR Checklist
Overview
Adds a
allowFunctionsWithoutTypeParametersoption to ignore non-generic functions.The issue is quite old but I think it makes a lot of sense to add this in. I don't often use this rule, but when I do think about it, I often mostly only want it for complex, performance-degrading types.