Skip to content
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

JoshuaKGoldberg
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg commented Mar 9, 2022

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.

@nx-cloud
Copy link

nx-cloud bot commented Mar 9, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit d235d55. 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 43 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

typescript-eslint bot commented Mar 9, 2022

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.

@netlify
Copy link

netlify bot commented Mar 9, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit d235d55
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/62506ebdd12f1f000a767479
😎 Deploy Preview https://deploy-preview-4659--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@JoshuaKGoldberg JoshuaKGoldberg force-pushed the unified-signatures-different-name-option branch from 04afb6a to f2781df Compare Mar 9, 2022
@codecov
Copy link

codecov bot commented Mar 9, 2022

Codecov Report

Merging #4659 (d235d55) into main (c59d9d7) will decrease coverage by 0.02%.
The diff coverage is 88.23%.

@@            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     
Flag Coverage Δ
unittest 94.26% <88.23%> (-0.03%) ⬇️

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

Impacted Files Coverage Δ
...-plugin/src/rules/no-unnecessary-type-assertion.ts 94.66% <ø> (ø)
...ages/eslint-plugin/src/rules/unified-signatures.ts 92.10% <86.66%> (-1.14%) ⬇️
.../eslint-plugin/src/rules/method-signature-style.ts 89.15% <100.00%> (+0.26%) ⬆️

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review Mar 9, 2022
@bradzacher bradzacher added the enhancement: plugin rule option New rule option for an existing eslint-plugin rule label Mar 10, 2022
Copy link
Member

@bradzacher bradzacher left a comment

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?

packages/eslint-plugin/src/rules/unified-signatures.ts Outdated Show resolved Hide resolved
@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Mar 18, 2022
@JoshuaKGoldberg
Copy link
Contributor Author

JoshuaKGoldberg commented Apr 8, 2022

Heh, turns out the rule already wasn't testing one of the positive test cases. Classic.

@JoshuaKGoldberg JoshuaKGoldberg requested a review from bradzacher Apr 8, 2022
@JoshuaKGoldberg JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Apr 8, 2022
@bradzacher bradzacher changed the title feat(eslint-plugin): added ignoreDifferentlyNamedParameters option to unified-signatures feat(eslint-plugin): [unified-signatures] add ignoreDifferentlyNamedParameters option Apr 8, 2022
Copy link
Member

@bradzacher bradzacher left a comment

LGTM! Thanks for adding this!

return param.name;
case AST_NODE_TYPES.RestElement:
return getStaticParameterName(param.argument);
default:
Copy link
Member

@bradzacher bradzacher Apr 8, 2022

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.

@bradzacher bradzacher merged commit fdf95e0 into typescript-eslint:main Apr 8, 2022
17 of 18 checks passed
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Apr 13, 2022
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 (@&#8203;typescript-eslint/eslint-plugin)</summary>

### [`v5.19.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;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 [#&#8203;4723](typescript-eslint/typescript-eslint#4723) ([#&#8203;4790](typescript-eslint/typescript-eslint#4790)) ([a1e9fc4](typescript-eslint/typescript-eslint@a1e9fc4))

##### Features

-   **eslint-plugin:** \[unified-signatures] add `ignoreDifferentlyNamedParameters` option ([#&#8203;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 ([#&#8203;4795](typescript-eslint/typescript-eslint#4795)) ([19c600a](typescript-eslint/typescript-eslint@19c600a))

</details>

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>

### [`v5.19.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;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 [@&#8203;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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement: plugin rule option New rule option for an existing eslint-plugin rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[unified-signatures] Don't trigger on mergeable declaration with different parameter name
2 participants