-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
feat(eslint-plugin): [unified-signatures] add ignoreDifferentlyNamedParameters
option
#4659
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
feat(eslint-plugin): [unified-signatures] add ignoreDifferentlyNamedParameters
option
#4659
Conversation
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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
… unified-signatures
04afb6a
to
f2781df
Compare
Codecov Report
@@ Coverage Diff @@
## main #4659 +/- ##
==========================================
- Coverage 94.28% 94.26% -0.03%
==========================================
Files 151 151
Lines 8208 8214 +6
Branches 2670 2672 +2
==========================================
+ Hits 7739 7743 +4
- Misses 261 262 +1
- Partials 208 209 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is looking good to me so far!
I didn't see any test cases for it - could you please add a negative test with the option false
?
Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
Heh, turns out the rule already wasn't testing one of the positive test cases. Classic. |
ignoreDifferentlyNamedParameters
option
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for adding this!
return param.name; | ||
case AST_NODE_TYPES.RestElement: | ||
return getStaticParameterName(param.argument); | ||
default: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
quick note that these is valid:
function foo({a}: {a: string}): void;
function foo([a]: [a: string]): void;
I think it's fine for us to ignore these cases as they're rare and pretty dumb.
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.18.0` -> `5.19.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.18.0/5.19.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.18.0` -> `5.19.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.18.0/5.19.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@​typescript-eslint/eslint-plugin)</summary> ### [`v5.19.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5190-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5180v5190-2022-04-11) [Compare Source](typescript-eslint/typescript-eslint@v5.18.0...v5.19.0) ##### Bug Fixes - **eslint-plugin:** update code to use estree range instead of ts pos/end [#​4723](typescript-eslint/typescript-eslint#4723) ([#​4790](typescript-eslint/typescript-eslint#4790)) ([a1e9fc4](typescript-eslint/typescript-eslint@a1e9fc4)) ##### Features - **eslint-plugin:** \[unified-signatures] add `ignoreDifferentlyNamedParameters` option ([#​4659](typescript-eslint/typescript-eslint#4659)) ([fdf95e0](typescript-eslint/typescript-eslint@fdf95e0)) - **eslint-plugin:** add support for valid number and bigint intersections in restrict-plus-operands rule ([#​4795](typescript-eslint/typescript-eslint#4795)) ([19c600a](typescript-eslint/typescript-eslint@19c600a)) </details> <details> <summary>typescript-eslint/typescript-eslint (@​typescript-eslint/parser)</summary> ### [`v5.19.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5190-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5180v5190-2022-04-11) [Compare Source](typescript-eslint/typescript-eslint@v5.18.0...v5.19.0) **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**: 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, 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> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1299 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>
PR Checklist
Overview
When two signatures have the same number of parameters, then two parameters having a different name means they won't be considered unifiable.
Also deduplicates a bit of code in
checkOverloads
.