Skip to content

feat(eslint-plugin): [no-unnecessary-type-parameters] special case tuples and parameter location arrays as single-use #9536

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

Merged
merged 54 commits into from
Mar 2, 2025

Conversation

jfet97
Copy link
Contributor

@jfet97 jfet97 commented Jul 10, 2024

PR Checklist

Overview

Based on initial work from @danvk, this PR special cases readonly T[], T[], ReadonlyArray<T>, Array<T> and tuples as single use generic types.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @jfet97!

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.

Copy link

netlify bot commented Jul 10, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 8a24eca
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/67c3eed657a4aa0008c1d6f1
😎 Deploy Preview https://deploy-preview-9536--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (🟢 up 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (🟢 up 8 from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

Copy link

nx-cloud bot commented Jul 10, 2024

View your CI Pipeline Execution ↗ for commit 8a24eca.

Command Status Duration Result
nx run-many --target=clean ✅ Succeeded 12s View ↗

☁️ Nx Cloud last updated this comment at 2025-03-02 05:49:01 UTC

Copy link

codecov bot commented Jul 10, 2024

Codecov Report

Attention: Patch coverage is 84.61538% with 2 lines in your changes missing coverage. Please review.

Project coverage is 87.27%. Comparing base (4a58e98) to head (fc006d3).
Report is 223 commits behind head on main.

Current head fc006d3 differs from pull request most recent head 8a24eca

Please upload reports for the commit 8a24eca to get more accurate results.

Files with missing lines Patch % Lines
...plugin/src/rules/no-unnecessary-type-parameters.ts 84.61% 0 Missing and 2 partials ⚠️

❌ Your patch status has failed because the patch coverage (84.61%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9536      +/-   ##
==========================================
+ Coverage   86.76%   87.27%   +0.51%     
==========================================
  Files         444      453       +9     
  Lines       15311    15841     +530     
  Branches     4457     4647     +190     
==========================================
+ Hits        13285    13826     +541     
+ Misses       1672     1658      -14     
- Partials      354      357       +3     
Flag Coverage Δ
unittest 87.27% <84.61%> (+0.51%) ⬆️

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

Files with missing lines Coverage Δ
...plugin/src/rules/no-unnecessary-type-parameters.ts 92.16% <84.61%> (-0.24%) ⬇️

... and 159 files with indirect coverage changes

@danvk

This comment was marked as outdated.

@jfet97

This comment was marked as outdated.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey thanks for sending this in & iterating on it! I think the direction here might be a big different from the issue? Did I misread something?

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Aug 6, 2024
@jfet97

This comment was marked as outdated.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, LGTM - thanks for the iteration!

@JoshuaKGoldberg JoshuaKGoldberg changed the title feat(eslint-plugin): [no-unnecessary-type-parameters] special case tuples and arrays as a "single use" generic type in functions feat(eslint-plugin): [no-unnecessary-type-parameters] special case tuples and return location arrays as single-use Jan 7, 2025
@JoshuaKGoldberg JoshuaKGoldberg changed the title feat(eslint-plugin): [no-unnecessary-type-parameters] special case tuples and return location arrays as single-use feat(eslint-plugin): [no-unnecessary-type-parameters] special case readonly tuples and return location arrays as single-use Jan 7, 2025
@JoshuaKGoldberg JoshuaKGoldberg changed the title feat(eslint-plugin): [no-unnecessary-type-parameters] special case readonly tuples and return location arrays as single-use feat(eslint-plugin): [no-unnecessary-type-parameters] special case tuples and return location arrays as single-use Jan 7, 2025
@JoshuaKGoldberg JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 7, 2025
@kirkwaiblinger kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label Jan 24, 2025
@JoshuaKGoldberg JoshuaKGoldberg changed the title feat(eslint-plugin): [no-unnecessary-type-parameters] special case tuples and return location arrays as single-use feat(eslint-plugin): [no-unnecessary-type-parameters] special case tuples and parameter location arrays as single-use Feb 24, 2025
@kirkwaiblinger
Copy link
Member

kirkwaiblinger commented Feb 26, 2025

There's a parenthesization bug around the suggestion fixer - it fixes this:

class Joiner {
  join<T extends string | number>(els: T[]) {
    return els.map(el => '' + el).join(',');
  }
}

to this:

class Joiner {
  join(els: string | number[]) {
    return els.map(el => '' + el).join(',');
  }
}

That might be worsened by this PR due to it now reporting on T[] syntax, but I think it's an existing bug (you could probably come up with a test case with some wonky intersections/unions precedence), so IMO we can handle it in a followup.

kirkwaiblinger
kirkwaiblinger previously approved these changes Feb 26, 2025
Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exciting!

@kirkwaiblinger kirkwaiblinger added 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge and removed awaiting response Issues waiting for a reply from the OP or another party labels Feb 26, 2025
@github-actions github-actions bot removed the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Feb 27, 2025
@kirkwaiblinger
Copy link
Member

Filed #10894 to follow up on #9536 (comment)

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So relieved to have this through 🫠 thanks so much everyone for working on this! 🚀

@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Mar 2, 2025
@JoshuaKGoldberg
Copy link
Member

CI failures are unrelated on main too. 🚢

@JoshuaKGoldberg JoshuaKGoldberg merged commit d8a4fb6 into typescript-eslint:main Mar 2, 2025
79 of 86 checks passed
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Mar 5, 2025
| datasource | package                          | from   | to     |
| ---------- | -------------------------------- | ------ | ------ |
| npm        | @typescript-eslint/eslint-plugin | 8.24.0 | 8.26.0 |
| npm        | @typescript-eslint/parser        | 8.24.0 | 8.26.0 |


## [v8.26.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8260-2025-03-03)

##### 🚀 Features

-   **eslint-plugin:** \[unified-signatures] support ignoring overload signatures with different JSDoc comments ([#10781](typescript-eslint/typescript-eslint#10781))
-   **eslint-plugin:** \[explicit-module-boundary-types] add an option to ignore overload implementations ([#10889](typescript-eslint/typescript-eslint#10889))
-   **eslint-plugin:** \[no-unused-var] handle implicit exports in declaration files ([#10714](typescript-eslint/typescript-eslint#10714))
-   support TypeScript 5.8 ([#10903](typescript-eslint/typescript-eslint#10903))
-   **eslint-plugin:** \[no-unnecessary-type-parameters] special case tuples and parameter location arrays as single-use ([#9536](typescript-eslint/typescript-eslint#9536))

##### 🩹 Fixes

-   **eslint-plugin:** \[no-unnecessary-type-assertion] handle unknown ([#10875](typescript-eslint/typescript-eslint#10875))
-   **eslint-plugin:** \[no-invalid-void-type] report `accessor` properties with an invalid `void` type ([#10864](typescript-eslint/typescript-eslint#10864))
-   **eslint-plugin:** \[unified-signatures] does not differentiate truly private methods ([#10806](typescript-eslint/typescript-eslint#10806))

##### ❤️ Thank You

-   Andrea Simone Costa [@jfet97](https://github.com/jfet97)
-   Dirk Luijk [@dirkluijk](https://github.com/dirkluijk)
-   Ronen Amiel
-   YeonJuan [@yeonjuan](https://github.com/yeonjuan)
-   Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw)

You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.


## [v8.25.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8250-2025-02-24)

##### 🚀 Features

-   **eslint-plugin:** \[no-misused-spread] add suggestions ([#10719](typescript-eslint/typescript-eslint#10719))

##### 🩹 Fixes

-   **eslint-plugin:** \[prefer-nullish-coalescing] report on chain expressions in a ternary ([#10708](typescript-eslint/typescript-eslint#10708))
-   **eslint-plugin:** \[no-deprecated] report usage of deprecated private identifiers ([#10844](typescript-eslint/typescript-eslint#10844))
-   **eslint-plugin:** \[unified-signatures] handle getter-setter ([#10818](typescript-eslint/typescript-eslint#10818))

##### ❤️ Thank You

-   Olivier Zalmanski [@OlivierZal](https://github.com/OlivierZal)
-   Ronen Amiel
-   YeonJuan [@yeonjuan](https://github.com/yeonjuan)

You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.


## [v8.24.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8241-2025-02-17)

##### 🩹 Fixes

-   **eslint-plugin:** \[class-methods-use-this] check `accessor` methods with a function initializer ([#10796](typescript-eslint/typescript-eslint#10796))
-   **eslint-plugin:** \[no-misused-promises] don't report on `static` `accessor` properties ([#10814](typescript-eslint/typescript-eslint#10814))
-   **eslint-plugin:** \[no-deprecated] don't report on deprecated `accessor` property declaration ([#10813](typescript-eslint/typescript-eslint#10813))
-   **eslint-plugin:** \[explicit-member-accessibility] check `accessor` class properties for missing accessibility modifier ([#10805](typescript-eslint/typescript-eslint#10805))
-   **eslint-plugin:** \[explicit-module-boundary-types] check `accessor` class properties with a function initializer ([#10804](typescript-eslint/typescript-eslint#10804))
-   **eslint-plugin:** \[prefer-return-this-type] check `accessor` properties with a function initializer ([#10794](typescript-eslint/typescript-eslint#10794))
-   **eslint-plugin:** \[consistent-generic-constructors] check `accessor` class properties ([#10789](typescript-eslint/typescript-eslint#10789))
-   **eslint-plugin:** \[no-unsafe-assignment] report on an `any` value assigned as an initializer of an `accessor` property ([#10785](typescript-eslint/typescript-eslint#10785))
-   **eslint-plugin:** \[no-unnecessary-template-expression] ignore enum and enum members ([#10782](typescript-eslint/typescript-eslint#10782))
-   **eslint-plugin:** \[no-inferrable-types] handle accessor ([#10780](typescript-eslint/typescript-eslint#10780))

##### ❤️ Thank You

-   Ronen Amiel
-   YeonJuan

You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
4 participants