Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat(eslint-plugin): [no-deprecated] add allow options#10585

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
JoshuaKGoldberg merged 6 commits intotypescript-eslint:mainfromyeonjuan:fixes/9899
Jan 13, 2025

Conversation

yeonjuan
Copy link
Contributor

@yeonjuanyeonjuan commentedJan 1, 2025•
edited
Loading

PR Checklist

Overview

This PR addresses issue#9899.
Add anallow option of typeTypeOrValueSpecifier. The types/values specified in theallow option are allowed to be used even if deprecated.

kirkwaiblinger and ronami reacted with heart emoji
@typescript-eslint
Copy link
Contributor

Thanks for the PR,@yeonjuan!

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 onhttps://opencollective.com/typescript-eslint.

@netlifyNetlify
Copy link

netlifybot commentedJan 1, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit4ee9616
🔍 Latest deploy loghttps://app.netlify.com/sites/typescript-eslint/deploys/677d6302257c5a0008b73ea2
😎 Deploy Previewhttps://deploy-preview-10585--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: 100 (🟢 up 7 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.

@nx-cloudNx Cloud
Copy link

nx-cloudbot commentedJan 1, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commit4ee9616.

CommandStatusDurationResult
nx test eslint-plugin --coverage=false✅ Succeeded7m 16sView ↗
nx test eslint-plugin✅ Succeeded5m 46sView ↗
nx test typescript-eslint --coverage=false✅ Succeeded19sView ↗
nx test utils --coverage=false✅ Succeeded<1sView ↗
nx test scope-manager --coverage=false✅ Succeeded<1sView ↗
nx test visitor-keys --coverage=false✅ Succeeded<1sView ↗
nx run types:build✅ Succeeded<1sView ↗
nx test type-utils --coverage=false✅ Succeeded<1sView ↗
Additional runs (24)✅ Succeeded...View ↗

☁️Nx Cloud last updated this comment at2025-01-07 17:40:14 UTC

await apiV2();

function foo(
element: HTMLFrameSetElement, // HTMLFrameSetElement is deprecated (not specified in the option)
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

HTMLFrameSetElement is deprecated, so when I check it in the playground, it shows a lint error. However, snapshot tests don't show lint errors, so maybe this is a bug in the snapshot test tsconfig configuration?

Choose a reason for hiding this comment

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

Hunch: that's from one including DOM types and the other not. I think switching this from alib allow to afile orpackage allow would bypass that - and also be more representative of how most users would want to see this. But#9269 makes that hard because what we use in the playground isn't actually the same as docs and rule tests...

How about going with a@deprecated global fromlib.es5.d.ts, maybeescape?http://localhost:3000/play#ts=5.7.2&fileType=.ts&code=KYZwxghgDsAUBEATgbwH-gSgFAFcB2okMCApAKIAsJAYgGw0DCmQA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQAIBcBPABxQGNoBLY-AWhXkoDt8B6Jge1oBNFjpEZAIb5E3dGADa4bDkTRoHaJAA0M2VlnZIQ%2BPA4B3CdK1bNp2ZABmigLYTIjAEar1FnEyG3ED8kNKQbqYAvkHYALphobKREKHBQA&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA&tokens=false

Examples of code for this rule with:```json{"allow": [{"from":"file","name":"escape" }]}```<Tabs><TabItemvalue="❌ Incorrect">```ts option='{"allow":[{"from":"lib","name":"escape"}]}'unescape('...');```</TabItem><TabItemvalue="✅ Correct">```ts option='{"allow":[{"from":"file","name":"escape"}]}'escape('...');```</TabItem></Tabs>

yeonjuan reacted with thumbs up emoji
@codecovCodecov
Copy link

codecovbot commentedJan 1, 2025•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.95%. Comparing base(d63ea3b) to head(4ee9616).
Report is 18 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@##             main   #10585      +/-   ##==========================================+ Coverage   86.90%   86.95%   +0.04%==========================================  Files         446      446                Lines       15505    15512       +7       Branches     4517     4519       +2     ==========================================+ Hits        13475    13488      +13+ Misses       1675     1669       -6  Partials      355      355
FlagCoverage Δ
unittest86.95% <100.00%> (+0.04%)⬆️

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

Files with missing linesCoverage Δ
packages/eslint-plugin/src/rules/no-deprecated.ts94.33% <100.00%> (+0.22%)⬆️

... and3 files with indirect coverage changes

@yeonjuanyeonjuan marked this pull request as ready for reviewJanuary 2, 2025 13:20
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Functionality looks stellar! Just discussing docs changes now I think.

await apiV2();

function foo(
element: HTMLFrameSetElement, // HTMLFrameSetElement is deprecated (not specified in the option)

Choose a reason for hiding this comment

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

Hunch: that's from one including DOM types and the other not. I think switching this from alib allow to afile orpackage allow would bypass that - and also be more representative of how most users would want to see this. But#9269 makes that hard because what we use in the playground isn't actually the same as docs and rule tests...

How about going with a@deprecated global fromlib.es5.d.ts, maybeescape?http://localhost:3000/play#ts=5.7.2&fileType=.ts&code=KYZwxghgDsAUBEATgbwH-gSgFAFcB2okMCApAKIAsJAYgGw0DCmQA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQAIBcBPABxQGNoBLY-AWhXkoDt8B6Jge1oBNFjpEZAIb5E3dGADa4bDkTRoHaJAA0M2VlnZIQ%2BPA4B3CdK1bNp2ZABmigLYTIjAEar1FnEyG3ED8kNKQbqYAvkHYALphobKREKHBQA&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA&tokens=false

Examples of code for this rule with:```json{"allow": [{"from":"file","name":"escape" }]}```<Tabs><TabItemvalue="❌ Incorrect">```ts option='{"allow":[{"from":"lib","name":"escape"}]}'unescape('...');```</TabItem><TabItemvalue="✅ Correct">```ts option='{"allow":[{"from":"file","name":"escape"}]}'escape('...');```</TabItem></Tabs>

yeonjuan reacted with thumbs up emoji
@JoshuaKGoldbergJoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party labelJan 7, 2025
@yeonjuan
Copy link
ContributorAuthor

@JoshuaKGoldberg Thanks! Fixed!3b45f65

JoshuaKGoldberg
JoshuaKGoldberg previously approved these changesJan 7, 2025
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Shining gold five-pointed star with a light shine effect

yeonjuan reacted with heart emoji
"allow": [
{ "from": "file", "name": "apiV1" },
{ "from": "lib", "name": "escape" },
{ "from": "package", "name": "Bar", "package": "bar-lib" }

Choose a reason for hiding this comment

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

Nit: since the package isn't referenced in the examples..

Suggested change
{ "from": "package", "name": "Bar", "package": "bar-lib" }

yeonjuan reacted with thumbs up emoji
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Oh. Thanks!
4ee9616

@JoshuaKGoldbergJoshuaKGoldberg 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 responseIssues waiting for a reply from the OP or another party labelsJan 7, 2025
Copy link
Member

@ronamironami left a comment•
edited
Loading

Choose a reason for hiding this comment

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

The PR looks great, thank you 💯

Some thoughts:

Testing various cases, it seemsTypeOrValueSpecifier is a bit more limited for the use-cases of this rule.

For example, I didn't manage to configure theallow option not to report these:1,2. I haven't usedTypeOrValueSpecifier extensively, so this might be an oversight on my end.

kirkwaiblinger reacted with thumbs up emoji
@JoshuaKGoldberg
Copy link
Member

Yeah I suspect if this option gets a lot of usage, we'll get >=1 feature request to expand that format. 👍

@JoshuaKGoldbergJoshuaKGoldberg merged commit6dda0a4 intotypescript-eslint:mainJan 13, 2025
60 of 62 checks passed
renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull requestJan 13, 2025
##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13)##### 🚀 Features-   **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565))-   **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585))-   **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551))##### 🩹 Fixes-   **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602))-   **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593))##### ❤️ Thank You-   Josh Goldberg ✨-   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.
renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull requestJan 13, 2025
##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13)##### 🚀 Features-   **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565))-   **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585))-   **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551))##### 🩹 Fixes-   **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602))-   **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593))##### ❤️ Thank You-   Josh Goldberg ✨-   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.
renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull requestJan 14, 2025
##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13)##### 🚀 Features-   **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565))-   **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585))-   **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551))##### 🩹 Fixes-   **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602))-   **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593))##### ❤️ Thank You-   Josh Goldberg ✨-   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.
renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull requestJan 15, 2025
##### [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13)##### 🚀 Features-   **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565))-   **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585))-   **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551))##### 🩹 Fixes-   **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602))-   **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593))##### ❤️ Thank You-   Josh Goldberg ✨-   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.
renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull requestJan 15, 2025
| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.19.1 | 8.20.0 || npm        | @typescript-eslint/parser        | 8.19.1 | 8.20.0 |## [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13)##### 🚀 Features-   **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565))-   **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585))-   **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551))##### 🩹 Fixes-   **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602))-   **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593))##### ❤️ Thank You-   Josh Goldberg ✨-   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.
renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull requestJan 15, 2025
| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.19.1 | 8.20.0 || npm        | @typescript-eslint/parser        | 8.19.1 | 8.20.0 |## [v8.20.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8200-2025-01-13)##### 🚀 Features-   **eslint-plugin:** \[consistent-type-assertions] add arrayLiteralTypeAssertions options ([#10565](typescript-eslint/typescript-eslint#10565))-   **eslint-plugin:** \[no-deprecated] add allow options ([#10585](typescript-eslint/typescript-eslint#10585))-   **eslint-plugin:** \[no-misused-spread] add new rule ([#10551](typescript-eslint/typescript-eslint#10551))##### 🩹 Fixes-   **eslint-plugin:** \[no-unnecessary-condition] don't flag optional chaining for union types with an unconstrained type parameters ([#10602](typescript-eslint/typescript-eslint#10602))-   **eslint-plugin:** \[no-shadow] ignore ordering of type declarations ([#10593](typescript-eslint/typescript-eslint#10593))##### ❤️ Thank You-   Josh Goldberg ✨-   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-actionsgithub-actionsbot locked asresolvedand limited conversation to collaboratorsJan 21, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@ronamironamironami approved these changes

@JoshuaKGoldbergJoshuaKGoldbergJoshuaKGoldberg left review comments

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-deprecated] Add 'allow' option for specific types or values
3 participants
@yeonjuan@JoshuaKGoldberg@ronami
[8]ページ先頭
©2009-2025 Movatter.jp