Enhanced theno-explicit-any rule to suggest replacingkeyof any with PropertyKey. added detection, helpful suggestion messages, auto-fix support, and test coverage.

propertykey for keyof any implementation

e6f8a16

Copy link

Contributor

typescript-eslintbot commentedApr 5, 2025

Thanks for the PR,@dbarabashh!

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 commentedApr 5, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`2c6c6fa`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/67f679f05f98ab00098a66bf
😎 Deploy Preview	https://deploy-preview-11032--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 91 (🟢 up 3 from production) Accessibility: 100 (no change from production) Best Practices: 100 (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 commentedApr 5, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commit2c6c6fa.

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

☁️Nx Cloud last updated this comment at2025-04-11 17:32:53 UTC

dbarabashh changed the title~~feat(no-explicit-any): suggest to replace keyof any with PropertyKey~~feat(eslint-plugin): suggest to replace keyof any with PropertyKey

Apr 5, 2025

Copy link

codecovbot commentedApr 5, 2025•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.01%. Comparing base(052b7f9) to head(2c6c6fa).
Report is 12 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@##             main   #11032      +/-   ##==========================================- Coverage   88.03%   88.01%   -0.02%==========================================  Files         470      470                Lines       16801    16811      +10       Branches     4745     4749       +4     ==========================================+ Hits        14790    14797       +7- Misses       1664     1667       +3  Partials      347      347

Flag	Coverage Δ
unittest	`88.01% <100.00%> (-0.02%)`	⬇️

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

Files with missing lines	Coverage Δ
...ackages/eslint-plugin/src/rules/no-explicit-any.ts	`97.05% <100.00%> (+0.63%)`	⬆️

... and3 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

ContributorAuthor

dbarabashh commentedApr 5, 2025•
edited
Loading

Hey,

I ran into a small issue. codecov is flagging line of code that is not covered by tests:

functioncreatePropertyKeyFixer(node:TSESTree.Node){return(fixer:TSESLint.RuleFixer)=>{if(node.parent&&node.parent.type===AST_NODE_TYPES.TSTypeOperator){returnfixer.replaceText(node.parent,'PropertyKey');}returnfixer.replaceText(node,'unknown');// ← This line isn't covered};}

It is fallback that should never actually run I only call this function when we've already checked that the node has a parent that іs a keyof operator.

what is the best way to handle this?

Just add ignore comment to make Codecov happy?not sure 😐
Delete fallback?
Try to somehow test this edge case (though that seems tricky)

Any thoughts on what is usually preferred for these kinds of situations? Thanks!

Copy link

Member

JoshuaKGoldberg commentedApr 7, 2025

Great question! We've been hoping to write a blog post on the subject:#10388.

Roughly, it's either of the following:

The code truly can never be hit, so it should be removed
The code can actually be hit, so test coverage should be added

If the type checker is pressuring you to write code that you don't think is necessary (e.g. thenode.parent checks) then you can either:

Use anas assertion
- This tends to come up withnode.parent checks:Enhancement: add strictparent types for nodes that have well-defined parents #6225,Enhancement: add strictparent types for nodes that have well-defined parents #10682, etc.
- If you think there's anode.parent that should have a more specific type, please do file an issue, this is a pretty regular headache 🙃
Refactor the code to get around trade-offs in control flow analysis (e.g. storing a variable with a type-narrowed value)
- If you ever want to spend a "fun" afternoon deep diving into this:Trade-offs in Control Flow Analysis microsoft/TypeScript#9998

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

Apr 7, 2025

Copy link

ContributorAuthor

dbarabashh commentedApr 7, 2025

Thanks for the detailed reply@JoshuaKGoldberg

I’ll go through all the topics you mentioned in your comment.

simplify property key fixer

620d613

Copy link

ContributorAuthor

dbarabashh commentedApr 7, 2025•
edited
Loading

Thanks again for the comment you left it had a lot of great insights, and I especially enjoyed your article.

So, I pushed a commit with my solution.

Of course, its not the best one out there, but following your article, I intentionally picked the worst and most unsafe approach 🙃. That said, the situation isn't as simple as it seems, so I will try to explain it in words maybe someone will find it helpful in the future.

Using type assertion just to bypass type checking is generally a bad idea. Without solid test coverage, this approach can go wrong fast, and other node types might end up being handled incorrectly.

in this particular case, I came to the following conclusions:

Since we have a check insideisNodeWithinKeyofAny that guaranteesnode.parent exists and is of typeTSTypeOperator withoperator === 'keyof',
andcreatePropertyKeyFixer is only called after that check,
the previous version of createPropertyKeyFixer had an extra check for something that was already verified.

according to@JoshuaKGoldberg article, in this case, type assertion actuallyis the best strategy, because:

the check is indeed redundant (yikes),
and we know for sure that the type is correct (so we are not really bypassing the type system).

JoshuaKGoldberg requested changes

Apr 7, 2025

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.

Thanks for keeping working on this - I think you're in the right track with the removing a runtime check. 👍

packages/eslint-plugin/src/rules/no-explicit-any.ts OutdatedShow resolvedHide resolved

packages/eslint-plugin/tests/rules/no-explicit-any.test.ts OutdatedShow resolvedHide resolved

dbarabashh added2 commits

April 8, 2025 22:08

updated tests and refactored code

1ddd122

removed unused imports

9f778cd

dbarabashh mentioned this pull request

Apr 9, 2025

Repo: [no-explicit-any.test.ts] Switch auto-generated test cases to hand-written#11039

Closed

dbarabashh requested a review fromJoshuaKGoldberg

April 9, 2025 13:11

github-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party label

Apr 9, 2025

JoshuaKGoldberg changed the title~~feat(eslint-plugin): suggest to replace keyof any with PropertyKey~~feat(eslint-plugin): [no-explicit-any] suggest to replace keyof any with PropertyKey

Apr 9, 2025

JoshuaKGoldberg reviewed

Apr 9, 2025

View reviewed changes

packages/eslint-plugin/src/rules/no-explicit-any.ts OutdatedShow resolvedHide resolved

JoshuaKGoldberg requested changes

Apr 9, 2025

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.

Progress 🚀, but some un-resolved conversations still?

inline suggestion objects and fix type annotation

2c6c6fa

dbarabashh requested a review fromJoshuaKGoldberg

April 9, 2025 14:03

JoshuaKGoldberg approved these changes

Apr 11, 2025

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.

💯 thanks!

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

Apr 11, 2025

JoshuaKGoldberg merged commit3ccd79c intotypescript-eslint:main

Apr 14, 2025

59 checks passed

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

Apr 17, 2025

Update typescript-eslint monorepo to v8.30.1

7fbf8e8

| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 || npm        | @typescript-eslint/parser        | 8.29.0 | 8.30.1 |## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14)##### 🩹 Fixes-   **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072))##### ❤️ Thank You-   Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger)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.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14)##### 🚀 Features-   **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032))##### 🩹 Fixes-   **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950))##### ❤️ Thank You-   Dima Barabash [@dbarabashh](https://github.com/dbarabashh)-   Ronen AmielYou 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.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07)##### 🩹 Fixes-   **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998))##### ❤️ Thank You-   Ronen AmielYou 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.

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

Apr 17, 2025

Update typescript-eslint monorepo to v8.30.1

913f53a

| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 || npm        | @typescript-eslint/parser        | 8.29.0 | 8.30.1 |## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14)##### 🩹 Fixes-   **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072))##### ❤️ Thank You-   Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger)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.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14)##### 🚀 Features-   **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032))##### 🩹 Fixes-   **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950))##### ❤️ Thank You-   Dima Barabash [@dbarabashh](https://github.com/dbarabashh)-   Ronen AmielYou 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.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07)##### 🩹 Fixes-   **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998))##### ❤️ Thank You-   Ronen AmielYou 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.

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

Apr 19, 2025

Update typescript-eslint monorepo to v8.30.1

98e7e9d

| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 || npm        | @typescript-eslint/parser        | 8.29.0 | 8.30.1 |## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14)##### 🩹 Fixes-   **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072))##### ❤️ Thank You-   Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger)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.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14)##### 🚀 Features-   **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032))##### 🩹 Fixes-   **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950))##### ❤️ Thank You-   Dima Barabash [@dbarabashh](https://github.com/dbarabashh)-   Ronen AmielYou 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.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07)##### 🩹 Fixes-   **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998))##### ❤️ Thank You-   Ronen AmielYou 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.

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

Apr 20, 2025

Update typescript-eslint monorepo to v8.30.1

8590980

| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.29.0 | 8.30.1 || npm        | @typescript-eslint/parser        | 8.29.0 | 8.30.1 |## [v8.30.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8301-2025-04-14)##### 🩹 Fixes-   **eslint-plugin:** fix mistake with eslintrc config generation ([#11072](typescript-eslint/typescript-eslint#11072))##### ❤️ Thank You-   Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger)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.30.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8300-2025-04-14)##### 🚀 Features-   **eslint-plugin:** \[no-explicit-any] suggest to replace keyof any with PropertyKey ([#11032](typescript-eslint/typescript-eslint#11032))##### 🩹 Fixes-   **eslint-plugin:** \[promise-function-async] use a different error message for functions with promise and non-promise types ([#10950](typescript-eslint/typescript-eslint#10950))##### ❤️ Thank You-   Dima Barabash [@dbarabashh](https://github.com/dbarabashh)-   Ronen AmielYou 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.29.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8291-2025-04-07)##### 🩹 Fixes-   **eslint-plugin:** \[no-deprecated] report on deprecated imported variable used as property ([#10998](typescript-eslint/typescript-eslint#10998))##### ❤️ Thank You-   Ronen AmielYou 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

Apr 22, 2025

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!

feat(eslint-plugin): [no-explicit-any] suggest to replace keyof any with PropertyKey#11032

feat(eslint-plugin): [no-explicit-any] suggest to replace keyof any with PropertyKey#11032

Uh oh!

Conversation

dbarabashh commentedApr 5, 2025

PR Checklist

Overview

Uh oh!

typescript-eslintbot commentedApr 5, 2025

Uh oh!

netlifybot commentedApr 5, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

nx-cloudbot commentedApr 5, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

codecovbot commentedApr 5, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dbarabashh commentedApr 5, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

JoshuaKGoldberg commentedApr 7, 2025

Uh oh!

dbarabashh commentedApr 7, 2025

Uh oh!

dbarabashh commentedApr 7, 2025• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

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!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

netlifybot commentedApr 5, 2025•
edited
Loading

nx-cloudbot commentedApr 5, 2025•
edited
Loading

codecovbot commentedApr 5, 2025•
edited
Loading

dbarabashh commentedApr 5, 2025•
edited
Loading

dbarabashh commentedApr 7, 2025•
edited
Loading