feat(typescript-estree): warn on deprecated AST property accesses

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes Enhancement: Add test-only console warnings to deprecated AST properties  #6469
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

Follows up on #5384 by wrapping the @deprecated properties with a getter that, when a new suppressDeprecatedPropertyWarnings option isn't enabled, console.warns about the properties.

suppressDeprecatedPropertyWarnings defaults to process.env.NODE_ENV !== "test" (false in Jest and similar). Meaning, it'll only log in tests by default.

This also has the benefit of making the new property not enumerable, which cleans up the AST snapshots and playground representation of the AST to not have the seemingly duplicate properties. 🧹

[nx-cloud]

☁️ Nx Cloud Report

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

📂 See all runs for this branch

---

✅ Successfully ran 51 targets

• Node 18 - nx test eslint-plugin
• Node 14 - nx test eslint-plugin --coverage=false
• Node 18 - nx test scope-manager
• Node 18 - nx test utils
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test typescript-estree
• Node 18 - nx test visitor-keys
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test type-utils
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx run-many --target=build --parallel --exclude website
• nx run-many --target=lint --parallel
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test repo-tools
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test typescript-estree --coverage=false
• Node 18 - nx test parser
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test eslint-plugin-tslint
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test ast-spec
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 18 - nx test eslint-plugin-internal
• Node 14 - nx test visitor-keys --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test scope-manager --coverage=false
• Node 18 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test eslint-plugin-internal --coverage=false
• Node 14 - nx test type-utils --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test ast-spec --coverage=false
• Node 14 - nx test parser --coverage=false
• Node 14 - nx test repo-tools --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx test utils --coverage=false
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• nx run-many --target=typecheck --parallel
• nx run integration-tests:test
• Node 14 - nx test eslint-plugin-tslint --coverage=false
• nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• Node 14 - nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website
• nx run-many --target=build --parallel --exclude website

---

Sent with 💌 from NxCloud.

[typescript-eslint]

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]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	9a8066f
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/640eb9e61eef190008144572
😎 Deploy Preview	https://deploy-preview-6525--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[codecov]

Codecov Report

Merging #6525 (9a8066f) into v6 (f0f45a9) will increase coverage by 0.01%.
The diff coverage is 46.15%.

Additional details and impacted files

@@            Coverage Diff             @@
##               v6    #6525      +/-   ##
==========================================
+ Coverage   87.40%   87.42%   +0.01%     
==========================================
  Files         365      365              
  Lines       12508    12517       +9     
  Branches     3694     3696       +2     
==========================================
+ Hits        10933    10943      +10     
+ Misses       1213     1212       -1     
  Partials      362      362              

Flag	Coverage Δ
unittest	87.42% <46.15%> (+0.01%)	⬆️

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

Impacted Files	Coverage Δ
packages/typescript-estree/src/ast-converter.ts	100.00% <ø> (ø)
...pt-estree/src/parseSettings/createParseSettings.ts	85.71% <0.00%> (-1.79%)	⬇️
packages/typescript-estree/src/convert.ts	31.76% <47.36%> (+1.23%)	⬆️

[bradzacher]

this is looking good to me! should be really helpful to help people migrate.

I wonder if we should only log during testing scenarios..? It might spam users otherwise. Hmmm

[JoshuaKGoldberg]

only log during testing scenarios

Right now that's the default:

typescript-eslint/packages/typescript-estree/src/parseSettings/createParseSettings.ts

Lines 76 to 78 in 0c7af52

	suppressDeprecatedPropertyWarnings:
	options.suppressDeprecatedPropertyWarnings ??
	process.env.NODE_ENV !== 'test',

[bradzacher]

@JoshuaKGoldberg rebase this on v6 and fix the build and you're good to land!

[fisker]

@JoshuaKGoldberg This change breaks Prettier, we do an AST transform after parse, which will override some of those properties. I decide not to use the new properties because babel still use those old properties, I was thinking to update print logic after babel adopt those changes. Do you think maybe we can add a setter? CI Log

[fisker]

Or maybe when suppressDeprecatedPropertyWarnings: false, not to use Object.defineProperty?