feat(eslint-plugin): [no-deprecated] add rule #9783

JoshuaKGoldberg · 2024-08-12T16:42:44Z

PR Checklist

Addresses an existing open issue: fixes Rule proposal: Warn when deprecated APIs are used (eslint-plugin-deprecation) #8988
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Reimplements logic from scratch - both for licensing reasons and because I wanted to see how the structure would differ from previous implementations. After doing it myself, then looking back at the others, I think it ended up closest to eslint-plugin-deprecation by coincidence.

💖

typescript-eslint · 2024-08-12T16:42:46Z

Thanks for the PR, @JoshuaKGoldberg!

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 · 2024-08-12T16:43:02Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`5cd8b82`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/66c5f66bce745d0008b76f6f
😎 Deploy Preview	https://deploy-preview-9783--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (no change from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 90 (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.

packages/eslint-plugin/src/rules/no-deprecated.ts

nx-cloud · 2024-08-12T16:45:39Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 5cd8b82. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

packages/eslint-plugin/src/rules/no-deprecated.ts

JoshuaKGoldberg · 2024-08-15T17:24:32Z

yarn.lock

-    eslint-visitor-keys: ^3.4.1
-  checksum: 67c7e6003d5af042d8703d11538fca9d76899f0119130b373402819ae43f0bc90d18656aa7add25a24427ccf1a0efd0804157ba83b0d4e145f06107d7d1b7433
-  languageName: node
-  linkType: hard


Aside: it is very pleasing to no longer have a dependency on v6 versions of our packages. 🙃

codecov · 2024-08-15T17:42:40Z

Codecov Report

Attention: Patch coverage is 92.75362% with 5 lines in your changes missing coverage. Please review.

Project coverage is 88.04%. Comparing base (6250dab) to head (5cd8b82).
Report is 1 commits behind head on main.

Files	Patch %	Lines
packages/eslint-plugin/src/rules/no-deprecated.ts	92.75%	1 Missing and 4 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9783      +/-   ##
==========================================
+ Coverage   88.01%   88.04%   +0.02%     
==========================================
  Files         406      407       +1     
  Lines       13879    13948      +69     
  Branches     4055     4078      +23     
==========================================
+ Hits        12216    12280      +64     
- Misses       1354     1355       +1     
- Partials      309      313       +4

Flag	Coverage Δ
unittest	`88.04% <92.75%> (+0.02%)`	⬆️

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

Files	Coverage Δ
packages/type-utils/src/typeFlagUtils.ts	`84.61% <ø> (ø)`
packages/typescript-estree/src/convert.ts	`28.90% <ø> (ø)`
packages/typescript-estree/src/getModifiers.ts	`66.66% <ø> (ø)`
packages/typescript-estree/src/node-utils.ts	`51.34% <ø> (ø)`
packages/utils/src/ts-eslint/RuleTester.ts	`50.00% <ø> (ø)`
packages/eslint-plugin/src/rules/no-deprecated.ts	`92.75% <92.75%> (ø)`

kirkwaiblinger

Looks great to me, just a few questions!

eslint.config.mjs

packages/eslint-plugin/docs/rules/no-deprecated.mdx

Co-authored-by: Kirk Waiblinger <[email protected]>

Josh-Cena

Maybe mention deprecation/deprecation and why we have this rule?

packages/eslint-plugin/tests/docs-eslint-output-snapshots/no-deprecated.shot

bradzacher · 2024-08-21T13:16:59Z

packages/eslint-plugin/src/rules/no-deprecated.ts

+      symbol: ts.Signature | ts.Symbol | undefined,
+    ): string | undefined {
+      const tag = symbol
+        ?.getJsDocTags(checker)


this forces us to do "jsdoc parsing" by default :(
I kind of wish we could do it without using this -- eg with a regex so we can speed up parsing.

OH, this just reminded me we have JSDocParsingMode. Adding jsDocParsingMode: 'none' to the test file's languageOptions.parserOptions causes all the invalid tests to fail for not having any parsed JSDocs. Great.

I think we're going to want to do our own regex-based parsing. I'll put the PR back in draft in the meantime.

I think this is one of the few usecases of jsdoc via TS AST in the ecosystem. So yeah if we can remove this then we can consider flipping the default in the next version to speed up parsing in the general case!

Well, I tried using on symbol.valueDeclaration and symbol.valueDeclaration.parent in the first invalid test case:

ts.getJSDocCommentsAndTags: Nothing retrieved

tsutils.forEachComment: Retrieved the comment, but took ~750ms

deprecation/deprecation also uses symbol.getJsDocTags and suffers from the same issue. We don't (yet?) default jsdocParsingMode to 'none' or 'type-info' for lint users. I added a thrown error for those modes in 5cd8b82.

Back-linking to past conversation (cc @jakebailey as FYI): #7997 (comment)

Proposal: let's treat "do our own regex-based parsing" as a followup?

Edit: #9857

Yeah for sure - file an issue.
Wasnt sposed to be a blocking comment. More of a "hey if we can that'd be good" thing

Perhaps it's worth adding @deprecated to the list of tags that we parse out unconditionally in the API? Would that be simpler?

That could work yeah! Do you know what the performance impact would be?

I'd have to test and see. Unfortunate though as my enum names were too clever, @deprecated is not used for checking :(

FloEdelmann · 2024-08-27T14:09:34Z

The rule was renamed to no-deprecated before merge, could you please adjust the PR title and the changelog, to reduce confusion?

JoshuaKGoldberg · 2024-08-27T14:36:00Z

Alas, changing the commit history & linked changelogs would be hard 😞 sorry about that. I edited the PR title just to help folks find it.

WIP: no-deprecation

ddfc6bb

JoshuaKGoldberg mentioned this pull request Aug 12, 2024

Rule proposal: Warn when deprecated APIs are used (eslint-plugin-deprecation) #8988

Closed

6 tasks

JoshuaKGoldberg commented Aug 12, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-deprecated.ts Show resolved Hide resolved

I think it's mostly there

b1aa8d6

JoshuaKGoldberg changed the title ~~WIP: no-deprecation~~ feat(eslint-plugin): [no-deprecation] add rule Aug 15, 2024

JoshuaKGoldberg added 4 commits August 15, 2024 01:26

A couple small issues

1a320a4

Merge branch 'main' into josh-wip-deprecation

1faf836

Start on docs

b94a7f1

Generated configs and ran tests

7bd2242

JoshuaKGoldberg commented Aug 15, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-deprecated.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg marked this pull request as ready for review August 15, 2024 17:15

Remove deprecation/deprecation and disable ours as needed

18d6490

JoshuaKGoldberg marked this pull request as draft August 15, 2024 17:19

Remove deprecation/deprecation and disable ours as needed

fcc6579

JoshuaKGoldberg force-pushed the josh-wip-deprecation branch from 2116020 to fcc6579 Compare August 15, 2024 17:21

updated inline comments

58904a2

JoshuaKGoldberg commented Aug 15, 2024

View reviewed changes

JoshuaKGoldberg added 3 commits August 15, 2024 14:43

Fixed up call likes

cf34241

Fixed up exports

84817a6

The repo is passing now

3b89fd4

JoshuaKGoldberg marked this pull request as ready for review August 16, 2024 01:46

JoshuaKGoldberg requested a review from a team August 16, 2024 01:47

lil comment

4bdbc1d

kirkwaiblinger requested changes Aug 16, 2024

View reviewed changes

JoshuaKGoldberg and others added 2 commits August 19, 2024 07:37

Merge branch 'main' into josh-wip-deprecation

653ddd3

Apply suggestions from code review

580860c

Co-authored-by: Kirk Waiblinger <[email protected]>

yarn test -u

d07bac6

kirkwaiblinger previously approved these changes Aug 20, 2024

View reviewed changes

Josh-Cena previously approved these changes Aug 20, 2024

View reviewed changes

Explicitly mention deprecated/deprecated

0f4e484

JoshuaKGoldberg dismissed stale reviews from Josh-Cena and kirkwaiblinger via 0f4e484 August 20, 2024 15:58

kirkwaiblinger previously approved these changes Aug 20, 2024

View reviewed changes

Merge branch 'main'

80e116a

JoshuaKGoldberg dismissed kirkwaiblinger’s stale review via 80e116a August 20, 2024 19:37

bradzacher previously approved these changes Aug 21, 2024

View reviewed changes

no more see

8ec542b

JoshuaKGoldberg dismissed bradzacher’s stale review via 8ec542b August 21, 2024 13:59

JoshuaKGoldberg marked this pull request as draft August 21, 2024 14:01

Throw error for jsDocParsingMode

5cd8b82

JoshuaKGoldberg marked this pull request as ready for review August 21, 2024 14:30

JoshuaKGoldberg requested a review from bradzacher August 21, 2024 14:30

JoshuaKGoldberg removed the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Aug 21, 2024

bradzacher approved these changes Aug 21, 2024

View reviewed changes

JoshuaKGoldberg mentioned this pull request Aug 21, 2024

⚡️ Performance: Default parserOptions.jsDocParsingMode to 'none' or 'type-info' #9857

Open

JoshuaKGoldberg merged commit 57e4120 into typescript-eslint:main Aug 21, 2024
63 of 64 checks passed

JoshuaKGoldberg deleted the josh-wip-deprecation branch August 21, 2024 15:15

JoshuaKGoldberg mentioned this pull request Aug 21, 2024

⚡️ Performance: Use a dedicated quick JSDoc parser for no-deprecated #9858

Open

frantic1048 mentioned this pull request Aug 26, 2024

Enable the new @typescript-eslint/no-deprecated rule RightCapitalHQ/frontend-style-guide#192

Open

JoshuaKGoldberg changed the title ~~feat(eslint-plugin): [no-deprecation] add rule~~ feat(eslint-plugin): [no-deprecated] add rule Aug 27, 2024

This was referenced Aug 28, 2024

Add support for ESLint v9 gund/eslint-plugin-deprecation#79

Draft

ESLint v9 compatibility gund/eslint-plugin-deprecation#78

Closed

abrahamguo mentioned this pull request Sep 2, 2024

chore: remove unused eslint-plugin-deprecation .d.ts #9910

Merged

3 tasks

github-actions bot locked as resolved and limited conversation to collaborators Sep 6, 2024

Uh oh!

feat(eslint-plugin): [no-deprecated] add rule #9783

feat(eslint-plugin): [no-deprecated] add rule #9783

Uh oh!

Conversation

JoshuaKGoldberg commented Aug 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented Aug 12, 2024

Uh oh!

netlify bot commented Aug 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

Uh oh!

nx-cloud bot commented Aug 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Aug 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kirkwaiblinger left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Josh-Cena left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg Aug 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg Aug 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

FloEdelmann commented Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JoshuaKGoldberg commented Aug 27, 2024

Uh oh!

Uh oh!

JoshuaKGoldberg commented Aug 12, 2024 •

edited

Loading

netlify bot commented Aug 12, 2024 •

edited

Loading

nx-cloud bot commented Aug 12, 2024 •

edited

Loading

codecov bot commented Aug 15, 2024 •

edited

Loading

JoshuaKGoldberg Aug 21, 2024 •

edited

Loading

JoshuaKGoldberg Aug 21, 2024 •

edited

Loading

FloEdelmann commented Aug 27, 2024 •

edited

Loading