Skip to content

feat(typescript-estree): deprecate createDefaultProgram #5890

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
Oct 27, 2022
Merged

feat(typescript-estree): deprecate createDefaultProgram #5890

merged 5 commits into from
Oct 27, 2022

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Oct 26, 2022 •
edited
Loading

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

PR Checklist

Overview

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

@JoshuaKGoldberg JoshuaKGoldberg added the breaking change This change will require a new major version to be released label Oct 26, 2022
@typescript-eslint
Copy link
Contributor

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
Copy link

nx-cloud bot commented Oct 26, 2022 •
edited
Loading

☁️ 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

Sent with 💌 from NxCloud.

@codecov
Copy link

codecov bot commented Oct 26, 2022 •
edited
Loading

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 bradzacher added this to the 6.0.0 milestone Oct 26, 2022
@bradzacher bradzacher added the enhancement New feature or request label Oct 26, 2022
@bradzacher bradzacher changed the title chore(typescript-estree): deprecate createDefaultProgram feat(typescript-estree): deprecate createDefaultProgram Oct 26, 2022
@bradzacher
Copy link
Member

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

bradzacher
bradzacher approved these changes Oct 26, 2022
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

looking good to me!
deprecate_dalek

@bradzacher bradzacher added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Oct 26, 2022
bradzacher
bradzacher approved these changes Oct 27, 2022
View reviewed changes
packages/typescript-estree/README.md
@@ -208,7 +208,7 @@ interface ParseAndGenerateServicesOptions extends ParseOptions {

/**
* @deprecated - this flag will be removed in the next major.
* Do not rely on the behaviour provided by this flag.
* Do not rely on the behavior provided by this flag.
Copy link
Member

@bradzacher bradzacher Oct 27, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

image

YOU AMERICANS AND YOUR BAD SPELLINGS

Copy link
Member Author

Choose a reason for hiding this comment

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

😂 cspell was yelling at me!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 9b5fa0b into typescript-eslint:v6 Oct 27, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the deprecated-create-default-program branch October 27, 2022 05:02
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Nov 12, 2022
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher 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 breaking change This change will require a new major version to be released enhancement New feature or request
Projects
None yet
Milestone
6.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@JoshuaKGoldberg @bradzacher