feat(eslint-plugin): [explicit-function-return-type] add allowedNames #4440

islandryu · 2022-01-14T13:47:45Z

Add option allowedNames to explicit-function-return-type

PR Checklist

Addresses an existing issue: fixes [explicit-function-return-type] add an exclude list option #4402
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

You may pass function/method names you would like this rule to ignore, like so:

{
  "@typescript-eslint/explicit-function-return-type": [
    "error",
    {
      "allowedNames": ["ignoredFunctionName", "ignoredMethodName"]
    }
  ]
}

… option

nx-cloud · 2022-01-14T13:47:46Z

☁️ Nx Cloud Report

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

📂 See all runs for this branch

✅ Successfully ran 48 targets

Sent with 💌 from NxCloud.

typescript-eslint · 2022-01-14T13:47:49Z

Thanks for the PR, @islandryu!

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.

netlify · 2022-01-14T13:47:53Z

❌ Deploy Preview for typescript-eslint failed.

🔨 Explore the source changes: 65103ff

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/61f8ee03e1dd9e00086c7f6a

codecov · 2022-01-14T14:21:00Z

Codecov Report

Merging #4440 (65103ff) into main (04baac8) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #4440      +/-   ##
==========================================
+ Coverage   94.54%   94.56%   +0.01%     
==========================================
  Files         147      147              
  Lines        7851     7877      +26     
  Branches     2516     2530      +14     
==========================================
+ Hits         7423     7449      +26     
  Misses        234      234              
  Partials      194      194

Flag	Coverage Δ
unittest	`94.56% <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	`100.00% <100.00%> (ø)`

JoshuaKGoldberg

LGTM in general, thanks!

Codecov is right that there's a gap in test coverage; could you please
add a bit more testing and resolve the conflicts from the main branch? Once you do I think we should be good to merge.

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

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

…pescript-eslint into featAddallowedNames

…dNames to work for object properties and class methods

islandryu · 2022-01-29T14:18:09Z

@JoshuaKGoldberg
Thank you for review!
I resolved conflict and improved coverage.

I apologize for the large number of commits.

JoshuaKGoldberg · 2022-01-29T15:19:43Z

Large number of commits is no problem 😄, I do that all the time. We squash PR merges anyway and most PRs -including this one- are a small enough number of changes that we don't particularly need a Git walkthrough. Thanks!

JoshuaKGoldberg

Super, thanks so much @islandryu! 🚀

islandryu · 2022-01-31T11:51:34Z

@JoshuaKGoldberg
Sorry, I updated the PR by mistake.
Is there anything left for me to do regarding this PR?

JoshuaKGoldberg · 2022-01-31T14:16:04Z

Nope, it's ready to merge!

I don't have the ability to merge on a failing build and the Netlify deployment is nondeterministically failing. cc @bradzacher

bradzacher · 2022-01-31T18:33:44Z

@JoshuaKGoldberg - I've removed netlify from the "required" list of checks, so you should be able to merge past that signal from now on!

bradzacher

just one small comment about correctness - otherwise great work!

bradzacher · 2022-01-31T19:14:12Z

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

+            case AST_NODE_TYPES.MethodDefinition:
+            case AST_NODE_TYPES.PropertyDefinition:
+            case AST_NODE_TYPES.Property: {
+              if (parent.key.type === AST_NODE_TYPES.Identifier) {


one minor problem with this code:

const ignoredName = 'notIgnoredName'; class Foo { [ignoredName]() {} }

This is valid code! Which obviously should not be ignored.
Only checking for .key.type === 'Identifier' will match this case.
You should also assert that .computed === false.

cc @JoshuaKGoldberg as an FYI - this is a really common case that everyone (including me!) always forgets for properties of all kinds AND for member expressions as well.
I raised the issue with the estree spec but the outcome there was really "spec can't change".

Ah thanks for the spot!

Thank you!
I didn't know such a pattern existed.
@bradzacher
I changed the computed name so that it is not ignored by the allowedName.

…e to not ignore computed property

…pescript-eslint into featAddallowedNames

bradzacher

nice one! LGTM

…typescript-eslint#4440) * feat(eslint-plugin): [explicit-function-return-type] add allowedNames option * feat(eslint-plugin): [explicit-function-return-type] afix typecheck * Update packages/eslint-plugin/src/rules/explicit-function-return-type.ts Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com> * feat(eslint-plugin): [explicit-function-return-type] Change to allowedNames to work for object properties and class methods * feat(eslint-plugin): [explicit-function-return-type] Change to allowedNames to work for object properties and class methods * fix(eslint-plugin): [explicit-function-return-type] fix for codecov * fix(eslint-plugin): [explicit-function-return-type] add test * fix(eslint-plugin): [explicit-function-return-type] add test * fix(eslint-plugin): [explicit-function-return-type] fix for codecov * fix(eslint-plugin): [explicit-function-return-type] Change allowedName to not ignore computed property Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com> Co-authored-by: Josh Goldberg <joshuakgoldberg@outlook.com>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.10.2` -> `5.12.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.10.2/5.12.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.10.2` -> `5.12.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.10.2/5.12.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.12.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5120-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5110v5120-2022-02-14) [Compare Source](typescript-eslint/typescript-eslint@v5.11.0...v5.12.0) ##### Bug Fixes - **eslint-plugin:** \[init-declarations] fix nested namespace ([#4544](typescript-eslint/typescript-eslint#4544)) ([fe910e6](typescript-eslint/typescript-eslint@fe910e6)) - **eslint-plugin:** \[no-unnecessary-type-arguments] Use Symbol to check if it's the same type ([#4543](typescript-eslint/typescript-eslint#4543)) ([5b7d8df](typescript-eslint/typescript-eslint@5b7d8df)) - support nested object deconstructuring with type annotation ([#4548](typescript-eslint/typescript-eslint#4548)) ([4da9278](typescript-eslint/typescript-eslint@4da9278)) ##### Features - add checking property definition for allowNames option ([#4542](typescript-eslint/typescript-eslint#4542)) ([e32bef6](typescript-eslint/typescript-eslint@e32bef6)) ### [`v5.11.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5110-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5102v5110-2022-02-07) [Compare Source](typescript-eslint/typescript-eslint@v5.10.2...v5.11.0) ##### Bug Fixes - **eslint-plugin:** \[no-magic-numbers] fix invalid schema merging ([#4517](typescript-eslint/typescript-eslint#4517)) ([b95f796](typescript-eslint/typescript-eslint@b95f796)) - **eslint-plugin:** \[non-nullable-type-assertion-style] fix false positive when asserting to a generic type that might be nullish ([#4509](typescript-eslint/typescript-eslint#4509)) ([4209362](typescript-eslint/typescript-eslint@4209362)) ##### Features - **eslint-plugin:** \[explicit-function-return-type] add allowedNames ([#4440](typescript-eslint/typescript-eslint#4440)) ([936e252](typescript-eslint/typescript-eslint@936e252)) #### [5.10.2](typescript-eslint/typescript-eslint@v5.10.1...v5.10.2) (2022-01-31) ##### Bug Fixes - **eslint-plugin:** \[no-restricted-imports] allow relative type imports with patterns configured ([#4494](typescript-eslint/typescript-eslint#4494)) ([4a6d217](typescript-eslint/typescript-eslint@4a6d217)) #### [5.10.1](typescript-eslint/typescript-eslint@v5.10.0...v5.10.1) (2022-01-24) **Note:** Version bump only for package [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.12.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5120-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5110v5120-2022-02-14) [Compare Source](typescript-eslint/typescript-eslint@v5.11.0...v5.12.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) ### [`v5.11.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5110-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5102v5110-2022-02-07) [Compare Source](typescript-eslint/typescript-eslint@v5.10.2...v5.11.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.10.2](typescript-eslint/typescript-eslint@v5.10.1...v5.10.2) (2022-01-31) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.10.1](typescript-eslint/typescript-eslint@v5.10.0...v5.10.1) (2022-01-24) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Renovate will not automatically rebase this PR, because other commits have been found. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Co-authored-by: crapStone <crapstone@noreply.codeberg.org> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1157 Reviewed-by: crapStone <crapstone@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 allowedNames…

5e2c4fd

… option

feat(eslint-plugin): [explicit-function-return-type] afix typecheck

f931a38

islandryu marked this pull request as ready for review January 14, 2022 14:43

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

JoshuaKGoldberg requested changes Jan 23, 2022

View reviewed changes

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

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

islandryu and others added 9 commits January 24, 2022 11:59

Merge branch 'main'

edd64e8

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

b383ff6

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Merge branch 'featAddallowedNames' of https://github.com/islandryu/ty…

f48f8d7

…pescript-eslint into featAddallowedNames

feat(eslint-plugin): [explicit-function-return-type] Change to allowe…

f03d6e2

…dNames to work for object properties and class methods

feat(eslint-plugin): [explicit-function-return-type] Change to allowe…

2728975

…dNames to work for object properties and class methods

fix(eslint-plugin): [explicit-function-return-type] fix for codecov

690986d

fix(eslint-plugin): [explicit-function-return-type] add test

1e38d1d

fix(eslint-plugin): [explicit-function-return-type] add test

d8d39e6

fix(eslint-plugin): [explicit-function-return-type] fix for codecov

39d6715

islandryu requested a review from JoshuaKGoldberg January 29, 2022 14:14

JoshuaKGoldberg previously approved these changes Jan 29, 2022

View reviewed changes

Merge branch 'main' into featAddallowedNames

a79ac5f

JoshuaKGoldberg enabled auto-merge (squash) January 29, 2022 15:28

Merge branch 'main' into featAddallowedNames

8d66aa2

islandryu requested a review from JoshuaKGoldberg January 31, 2022 11:51

bradzacher disabled auto-merge January 31, 2022 18:33

bradzacher requested changes Jan 31, 2022

View reviewed changes

islandryu added 2 commits February 1, 2022 17:20

fix(eslint-plugin): [explicit-function-return-type] Change allowedNam…

545b2ab

…e to not ignore computed property

Merge branch 'featAddallowedNames' of https://github.com/islandryu/ty…

65103ff

…pescript-eslint into featAddallowedNames

islandryu dismissed JoshuaKGoldberg’s stale review via 65103ff February 1, 2022 08:23

islandryu requested a review from bradzacher February 1, 2022 08:34

bradzacher approved these changes Feb 2, 2022

View reviewed changes

bradzacher merged commit 936e252 into typescript-eslint:main Feb 2, 2022

islandryu deleted the featAddallowedNames branch February 9, 2022 13:25

github-actions bot locked as resolved and limited conversation to collaborators May 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [explicit-function-return-type] add allowedNames #4440

feat(eslint-plugin): [explicit-function-return-type] add allowedNames #4440

islandryu commented Jan 14, 2022 •

edited by bradzacher

Loading

nx-cloud bot commented Jan 14, 2022 •

edited

Loading

typescript-eslint bot commented Jan 14, 2022

netlify bot commented Jan 14, 2022 •

edited

Loading

codecov bot commented Jan 14, 2022 •

edited

Loading

JoshuaKGoldberg left a comment

islandryu commented Jan 29, 2022

JoshuaKGoldberg commented Jan 29, 2022 •

edited

Loading

JoshuaKGoldberg left a comment

islandryu commented Jan 31, 2022

JoshuaKGoldberg commented Jan 31, 2022

bradzacher commented Jan 31, 2022

bradzacher left a comment

bradzacher Jan 31, 2022

JoshuaKGoldberg Jan 31, 2022

islandryu Feb 1, 2022

bradzacher left a comment

feat(eslint-plugin): [explicit-function-return-type] add allowedNames #4440

feat(eslint-plugin): [explicit-function-return-type] add allowedNames #4440

Conversation

islandryu commented Jan 14, 2022 • edited by bradzacher Loading

PR Checklist

Overview

nx-cloud bot commented Jan 14, 2022 • edited Loading

☁️ Nx Cloud Report

typescript-eslint bot commented Jan 14, 2022

netlify bot commented Jan 14, 2022 • edited Loading

codecov bot commented Jan 14, 2022 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

islandryu commented Jan 29, 2022

JoshuaKGoldberg commented Jan 29, 2022 • edited Loading

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

islandryu commented Jan 31, 2022

JoshuaKGoldberg commented Jan 31, 2022

bradzacher commented Jan 31, 2022

bradzacher left a comment

Choose a reason for hiding this comment

bradzacher Jan 31, 2022

Choose a reason for hiding this comment

JoshuaKGoldberg Jan 31, 2022

Choose a reason for hiding this comment

islandryu Feb 1, 2022

Choose a reason for hiding this comment

bradzacher left a comment

Choose a reason for hiding this comment

islandryu commented Jan 14, 2022 •

edited by bradzacher

Loading

nx-cloud bot commented Jan 14, 2022 •

edited

Loading

netlify bot commented Jan 14, 2022 •

edited

Loading

codecov bot commented Jan 14, 2022 •

edited

Loading

JoshuaKGoldberg commented Jan 29, 2022 •

edited

Loading