Skip to content
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

Refactor: Deprecate createDefaultProgram/shouldCreateDefaultProgram #5857

Closed
JoshuaKGoldberg opened this issue Oct 20, 2022 · 2 comments
Closed

Refactor: Deprecate createDefaultProgram/shouldCreateDefaultProgram #5857

JoshuaKGoldberg opened this issue Oct 20, 2022 · 2 comments
Assignees
@JoshuaKGoldberg
Labels
accepting prs Go ahead, send a pull request that resolves this issue breaking change This change will require a new major version to be released refactor PRs that refactor code only

Comments

@JoshuaKGoldberg
Copy link
Member

Overview

Back in the day, if a user didn't provide a parserOptions.project, @typescript-eslint/parser would create one behind-the-scenes for them. This was convenient but came at severe performance cost: the parser would recompute a bunch of information for each file added.

We wish to remove the createDefaultProgram option. But, there may be some users who still rely on it. See #3627.

For now, our plan will be:

  1. In the upcoming major version, rename it to deprecated__createDefaultProgram
  2. Remove it in the next major version
@JoshuaKGoldberg JoshuaKGoldberg added breaking change This change will require a new major version to be released refactor PRs that refactor code only accepting prs Go ahead, send a pull request that resolves this issue labels Oct 20, 2022
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Oct 25, 2022
@JoshuaKGoldberg
Copy link
Member Author

I'll send a PR once #5834 is in.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 26, 2022
Merged
3 tasks
@JoshuaKGoldberg
Copy link
Member Author

#5890 is merged into #5886; closing this issue now accordingly. It'll be released as a part of the v6 major release.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
accepting prs Go ahead, send a pull request that resolves this issue breaking change This change will require a new major version to be released refactor PRs that refactor code only
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JoshuaKGoldberg