8000 feat(eslint-plugin): [no-explicit-any] suggest to replace keyof any with PropertyKey by dbarabashh · Pull Request #11032 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Apr 14, 2025
Merged

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

merged 5 commits into from
Apr 14, 2025

Conversation

dbarabashh
Copy link
Contributor

PR Checklist

Overview

Enhanced the no-explicit-any rule to suggest replacing keyof any with PropertyKey. added detection, helpful suggestion messages, auto-fix support, and test coverage.

@typescript-eslint
Copy link
Contributor

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.

@netlify Netlify
Copy link
netlify bot commented Apr 5, 2025 •
edited
Loading

✅ Deploy Preview for typescript-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...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
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 your Netlify site configuration.

@nx-cloud Nx Cloud
Copy link
nx-cloud bot commented Apr 5, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 2c6c6fa.

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 at 2025-04-11 17:32:53 UTC

@dbarabashh 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
@codecov Codecov
Copy link
codecov bot commented Apr 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%) ⬆️

... and 3 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.

@dbarabashh
Copy link
Contributor Author
dbarabashh commented Apr 5, 2025 •
edited
Loading

Hey,

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

function createPropertyKeyFixer(node: TSESTree.Node) {
  return (fixer: TSESLint.RuleFixer) => {
    if (node.parent && node.parent.type === AST_NODE_TYPES.TSTypeOperator) {
      return fixer.replaceText(node.parent, 'PropertyKey');
    }
    return fixer.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!

@JoshuaKGoldberg
Copy link
Member

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. the node.parent checks) then you can either:

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Apr 7, 2025
@dbarabashh
Copy link
Contributor Author

Thanks for the detailed reply @JoshuaKGoldberg

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

@dbarabashh
Copy link
Contributor Author
dbarabashh commented Apr 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 inside isNodeWithinKeyofAny that guarantees node.parent exists and is of type TSTypeOperator with operator === 'keyof',
  • and createPropertyKeyFixer 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 actually is 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
JoshuaKGoldberg requested changes Apr 7, 2025
View reviewed changes
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.

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

@dbarabashh dbarabashh mentioned this pull request Apr 9, 2025
Closed
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Apr 9, 2025
@JoshuaKGoldberg 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
JoshuaKGoldberg requested changes Apr 9, 2025
View reviewed changes
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.

Progress 🚀, but some un-resolved conversations still?

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Apr 11, 2025
View reviewed changes
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.

💯 thanks!

@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 Apr 11, 2025
@JoshuaKGoldberg JoshuaKGoldberg merged commit 3ccd79c into typescript-eslint:main Apr 14, 2025
59 checks passed
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Apr 17, 2025
@renovate
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 Amiel

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.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 Amiel

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.
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Apr 17, 2025
@renovate
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 Amiel

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.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 Amiel

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.
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Apr 19, 2025
@renovate
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 Amiel

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.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 Amiel

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.
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Apr 20, 2025
@renovate
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 Amiel

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.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 Amiel

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 Apr 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enhancement: [no-explicit-any] suggest to replace keyof any with PropertyKey
2 participants
@dbarabashh @JoshuaKGoldberg
0