Since removing or modifyinggetConstrainedTypeAtLocation would be a breaking change (seehttps://typescript-eslint.io/users/versioning#parser-typescript-estree-scope-manager-types-type-utils-utils),~~I've deprecated it and added a new utility in its place~~ I've left it in place for now, and just added a new utility. Since we may change our implementation in the future, I've made the new utility internal, and not deprecated the existinggetConstrainedTypeAtLocation. Deprecating it and replacing internal usages can be handled in followup work. See#10496 (comment)

I've redone the testing so that the tests forgetConstrainedTypeAtLocation actually test something useful, and tested several edge cases for both the old and new APIs.

I've used the new API for a few rules for good measure. We'll want to gradually replace the rest of our usages in followup work.

Retouched the fix in#10314~~and used the new strategy to solve#10443~~ and in#10474

TODO - I'll have to find a way to manage the deprecation linting failures 🙁#9899 would be extremely clutch. Not really sure how to handle this otherwise, other than to alias the function with a non-deprecated version to replace the existing usages, with the intention of cleaning up the alias later. Not deprecating anything yet.

~~UPDATE - I chose to aliasgetConstrainedTypeAtLocation as the ironically not-deprecatedDEPRECATED_getConstrainedTypeAtLocation in order to allow existing usages not to fail CI.~~

typescript-eslintbotand others added3 commits

December 13, 2024 16:31

add getConstraintTypeInfoAtLocation

d7bcdc6

revisittypescript-eslint#10314

cd97692

handletypescript-eslint#10443

3626dcb

Copy link

Contributor

typescript-eslintbot commentedDec 13, 2024

Thanks for the PR,@kirkwaiblinger!

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

netlifybot commentedDec 13, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`4c9da08`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6770924ce4d8050008c05021
😎 Deploy Preview	https://deploy-preview-10496--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 75 (🟢 up 2 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change 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 yourNetlify site configuration.

Copy link

nx-cloudbot commentedDec 13, 2024•
edited
Loading

View yourCI Pipeline Execution ↗ for commit4c9da08.

Command	Status	Duration	Result
`nx run-many --target=build --exclude website --...`	✅ Succeeded	3s	View ↗
`nx run-many --target=clean`	✅ Succeeded	10s	View ↗

☁️Nx Cloud last updated this comment at2024-12-29 08:16:41 UTC

kirkwaiblinger mentioned this pull request

Dec 14, 2024

Enhancement: [no-deprecated] Add 'allow' option for specific types or values#9899

Closed

4 tasks

kirkwaiblinger marked this pull request as ready for review

December 14, 2024 00:26

kirkwaiblinger commented

Dec 14, 2024

View reviewed changes

packages/type-utils/tests/getConstrainedTypeAtLocation.test.ts OutdatedShow resolvedHide resolved

tweak tests

bc12e04

Copy link

codecovbot commentedDec 14, 2024•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.87%. Comparing base(3ae4148) to head(4c9da08).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@##             main   #10496   +/-   ##=======================================  Coverage   86.86%   86.87%           =======================================  Files         445      446    +1       Lines       15455    15465   +10       Branches     4507     4508    +1     =======================================+ Hits        13425    13435   +10  Misses       1675     1675             Partials      355      355

Flag	Coverage Δ
unittest	`86.87% <100.00%> (+<0.01%)`	⬆️

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

Files with missing lines	Coverage Δ
packages/eslint-plugin/src/rules/await-thenable.ts	`100.00% <100.00%> (ø)`
...rc/rules/no-unnecessary-boolean-literal-compare.ts	`97.56% <100.00%> (+0.09%)`	⬆️
...slint-plugin/src/rules/no-unnecessary-condition.ts	`99.25% <100.00%> (-0.01%)`	⬇️
...ckages/eslint-plugin/src/util/getConstraintInfo.ts	`100.00% <100.00%> (ø)`
...ackages/eslint-plugin/src/util/needsToBeAwaited.ts	`100.00% <100.00%> (ø)`
...ges/type-utils/src/getConstrainedTypeAtLocation.ts	`100.00% <ø> (ø)`

JoshuaKGoldberg previously approved these changes

Dec 14, 2024

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

LGTM, nice to see the cleanup & related fixes!

Just requesting a collection of touchups, nothing major.

packages/type-utils/src/getConstrainedTypeAtLocation.ts OutdatedShow resolvedHide resolved

packages/type-utils/package.json OutdatedShow resolvedHide resolved

packages/type-utils/src/getConstrainedTypeAtLocation.ts OutdatedShow resolvedHide resolved

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

Dec 14, 2024

Apply suggestions from code review

f0ebffa

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

kirkwaiblinger dismissedJoshuaKGoldberg’sstale review viaf0ebffa

December 14, 2024 18:00

kirkwaiblinger added3 commits

December 14, 2024 11:04

code review

2fa6426

Merge branch 'main' into get-constraint-type-info-at-location

2e0bd42

deal with deprecated API lint failures

e753c02

kirkwaiblinger requested a review fromJoshuaKGoldberg

December 14, 2024 18:58

space

11d3a0a

github-actionsbot removed the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label

Dec 14, 2024

JoshuaKGoldberg previously approved these changes

Dec 15, 2024

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

I like this strategy 😄

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

Dec 15, 2024

remove vfs, derp

5d7cab6

kirkwaiblinger dismissedJoshuaKGoldberg’sstale review via5d7cab6

December 16, 2024 04:17

kirkwaiblinger requested a review fromJoshuaKGoldberg

December 16, 2024 04:18

github-actionsbot removed the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label

Dec 16, 2024

typo

f383280

kirkwaiblinger commented

Dec 17, 2024

View reviewed changes

packages/type-utils/src/getConstrainedTypeAtLocation.ts Outdated

		*
		* Successor to {@link getConstrainedTypeAtLocation} due to https://github.com/typescript-eslint/typescript-eslint/issues/10438
		*/
		export function getConstraintTypeInfoAtLocation(

Copy link

MemberAuthor

kirkwaiblingerDec 17, 2024

Choose a reason for hiding this comment

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

@JoshuaKGoldberg I've just had the thought - I think this might be the wrong API to write. It might be better to just accept a type as input, like

exportdeclarefunctiongetConstraintInfo(type:ts.Type):{isTypeParameter:boolean,constraint:ts.Type|undefined};

This maintains a separation betweengetting types andanalyzing types.

Copy link

Member

JoshuaKGoldbergDec 26, 2024

Choose a reason for hiding this comment

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

@kirkwaiblinger just confirming, are you planning on making changes? And/or, is this a question?

Copy link

MemberAuthor

kirkwaiblingerDec 26, 2024

Choose a reason for hiding this comment

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

Lol. In my head, I was asking you for your opinion, yeah, but I forgot to write that out 😆

Coming back to this, I currently lean towards: let's go with this PR in its current state, and if there's a need to extract just the constraint info part of this function that's quite easy to do in a followup when the need arises.

Feel free to offer your opinion! 😁

Copy link

MemberAuthor

kirkwaiblingerDec 27, 2024

Choose a reason for hiding this comment

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

If you're on board with this plan, then this PR is up to date and ready to be merged 👍

Copy link

Member

JoshuaKGoldbergDec 27, 2024

Choose a reason for hiding this comment

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

Oh awesome! I don't have a strong preference here.

Proposal: whatever strategy you want to go with, how about marking the final creation as@internal so it's not part of the public API? That way we can play with it as we want.

Copy link

MemberAuthor

kirkwaiblingerDec 29, 2024

Choose a reason for hiding this comment

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

Made lots of changes in this arena. New utility is just internal to eslint-plugin for now, no deprecation yet. Should be much easier to review!

Copy link

Member

JoshuaKGoldbergDec 29, 2024

Choose a reason for hiding this comment

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

I like this strategy. The union of possible constraint info points seems reasonable to me.

JoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party label

Dec 26, 2024

kirkwaiblinger added6 commits

December 26, 2024 18:01

Merge branch 'main' into get-constraint-type-info-at-location

c8c985c

simplify

2aecb98

more simplify

2a5c248

jsdoc

c646ffb

more better

943dc75

better

4c9da08

kirkwaiblinger changed the title~~fix(type-utils): add getConstraintTypeInfoAtLocation and deprecate getConstrainedTypeAtLocation~~fix(eslint-plugin): add getConstraintInfo to handle generic constraints better

Dec 29, 2024

kirkwaiblinger removed the awaiting responseIssues waiting for a reply from the OP or another party label

Dec 29, 2024

JoshuaKGoldberg approved these changes

Dec 29, 2024

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

🎉 This is great!

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

Dec 29, 2024

JoshuaKGoldberg merged commit2e2731d intotypescript-eslint:main

Dec 30, 2024

72 of 75 checks passed

kirkwaiblinger mentioned this pull request

Dec 30, 2024

Repo: AdoptgetConstraintInfo internally#10569

Open

renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull request

Dec 30, 2024

fix(deps): update typescript-eslint monorepo to v8.19.0

04d5198

##### [v8.19.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8190-2024-12-30)##### 🚀 Features-   **eslint-plugin:** \[strict-boolean-expressions] check array predicate functions' return statements ([#10106](typescript-eslint/typescript-eslint#10106))##### 🩹 Fixes-   **eslint-plugin:** \[member-ordering] ignore method overloading ([#10536](typescript-eslint/typescript-eslint#10536))-   **eslint-plugin:** \[consistent-indexed-object-style] don't report on indirect circular references ([#10537](typescript-eslint/typescript-eslint#10537))-   **eslint-plugin:** \[array-type] autofix with conditional types needs parentheses ([#10522](typescript-eslint/typescript-eslint#10522))-   **eslint-plugin:** add getConstraintInfo to handle generic constraints better ([#10496](typescript-eslint/typescript-eslint#10496))##### ❤️ Thank You-   Karl Werner-   Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger)-   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.

OlivierZal pushed a commit to OlivierZal/typescript-eslint that referenced this pull request

Dec 30, 2024

fix(eslint-plugin): add getConstraintInfo to handle generic constrain…

fdfe5ea

…ts better (typescript-eslint#10496)* add getConstraintTypeInfoAtLocation* revisittypescript-eslint#10314* handletypescript-eslint#10443* tweak tests* Apply suggestions from code reviewCo-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>* code review* deal with deprecated API lint failures* space* remove vfs, derp* typo* simplify* more simplify* jsdoc* more better* better---------Co-authored-by: typescript-eslint[bot] <53356952+typescript-eslint[bot]@users.noreply.github.com>Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request

Dec 31, 2024

Update typescript-eslint monorepo to v8.19.0

0c79c1b

| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.18.2 | 8.19.0 || npm        | @typescript-eslint/parser        | 8.18.2 | 8.19.0 |## [v8.19.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8190-2024-12-30)##### 🚀 Features-   **eslint-plugin:** \[strict-boolean-expressions] check array predicate functions' return statements ([#10106](typescript-eslint/typescript-eslint#10106))##### 🩹 Fixes-   **eslint-plugin:** \[member-ordering] ignore method overloading ([#10536](typescript-eslint/typescript-eslint#10536))-   **eslint-plugin:** \[consistent-indexed-object-style] don't report on indirect circular references ([#10537](typescript-eslint/typescript-eslint#10537))-   **eslint-plugin:** \[array-type] autofix with conditional types needs parentheses ([#10522](typescript-eslint/typescript-eslint#10522))-   **eslint-plugin:** add getConstraintInfo to handle generic constraints better ([#10496](typescript-eslint/typescript-eslint#10496))##### ❤️ Thank You-   Karl Werner-   Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger)-   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.

github-actionsbot locked asresolvedand limited conversation to collaborators

Jan 7, 2025

kirkwaiblinger deleted the get-constraint-type-info-at-location branch

March 31, 2025 01:14

Labels

1 approval

>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge

2 participants

Movatterモバイル変換

Uh oh!

fix(eslint-plugin): add getConstraintInfo to handle generic constraints better#10496

fix(eslint-plugin): add getConstraintInfo to handle generic constraints better#10496

Uh oh!

Conversation

kirkwaiblinger commentedDec 13, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslintbot commentedDec 13, 2024

Uh oh!

netlifybot commentedDec 13, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

nx-cloudbot commentedDec 13, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecovbot commentedDec 14, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

kirkwaiblingerDec 17, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldbergDec 26, 2024

Choose a reason for hiding this comment

Uh oh!

kirkwaiblingerDec 26, 2024

Choose a reason for hiding this comment

Uh oh!

kirkwaiblingerDec 27, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldbergDec 27, 2024

Choose a reason for hiding this comment

Uh oh!

kirkwaiblingerDec 29, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldbergDec 29, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger commentedDec 13, 2024•
edited
Loading

netlifybot commentedDec 13, 2024•
edited
Loading

nx-cloudbot commentedDec 13, 2024•
edited
Loading

codecovbot commentedDec 14, 2024•
edited
Loading