feat(typescript-estree): deprecate createDefaultProgram

[JoshuaKGoldberg]

BREAKING CHANGE:
Renames a part of the public typescript-estree API

PR Checklist

• Addresses an existing open issue: fixes Refactor: Deprecate createDefaultProgram/shouldCreateDefaultProgram #5857
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Renames createDefaultProgram to deprecated__createDefaultProgram, with associated @deprecated TSDoc tags and warnings.

[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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ae52f07. 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 46 targets

• Node 14 - nx test @typescript-eslint/eslint-plugin --coverage=false
• Node 18 - nx test @typescript-eslint/eslint-plugin
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 18 - nx test @typescript-eslint/scope-manager
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/utils
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx test @typescript-eslint/visitor-keys
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/scope-manager --coverage=false
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/utils --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/parser --coverage=false
• Node 14 - nx test @typescript-eslint/type-utils --coverage=false
• nx run-many --target=typecheck --all --parallel
• Node 14 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 14 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[codecov]

Codecov Report

Merging #5890 (ae52f07) into v6 (fcf3f9d) will increase coverage by 0.07%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##               v6    #5890      +/-   ##
==========================================
+ Coverage   91.36%   91.44%   +0.07%     
==========================================
  Files         364      355       -9     
  Lines       12134    12058      -76     
  Branches     3540     3530      -10     
==========================================
- Hits        11086    11026      -60     
+ Misses        748      733      -15     
+ Partials      300      299       -1     

Flag	Coverage Δ
unittest	91.44% <100.00%> (+0.07%)	⬆️

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

Impacted Files	Coverage Δ
...-estree/src/create-program/createDefaultProgram.ts	78.26% <ø> (ø)
...pt-estree/src/parseSettings/createParseSettings.ts	96.82% <ø> (ø)
...-estree/src/create-program/createProjectProgram.ts	93.47% <100.00%> (ø)
packages/scope-manager/src/analyze.ts	57.89% <0.00%> (-7.49%)	⬇️
packages/scope-manager/src/ScopeManager.ts	77.21% <0.00%> (-2.54%)	⬇️
packages/typescript-estree/src/convert.ts	97.59% <0.00%> (-0.30%)	⬇️
...ackages/scope-manager/src/referencer/Referencer.ts	95.90% <0.00%> (-0.07%)	⬇️
packages/utils/src/ts-eslint/CLIEngine.ts	33.33% <0.00%> (ø)
packages/utils/src/eslint-utils/RuleCreator.ts	75.00% <0.00%> (ø)
...plugin/src/rules/explicit-module-boundary-types.ts	91.04% <0.00%> (ø)
... and 10 more

[bradzacher]

note: marking as a feat so that it shows up in the changelog.

[bradzacher]

looking good to me!

[bradzacher]

YOU AMERICANS AND YOUR BAD SPELLINGS

[JoshuaKGoldberg]

😂 cspell was yelling at me!