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.

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

Enhancement: Add a console.warn to experimental-utils #5982

Closed
4 tasks done
JoshuaKGoldberg opened this issue Nov 13, 2022 · 1 comment
Closed
4 tasks done

Enhancement: Add a console.warn to experimental-utils #5982

JoshuaKGoldberg opened this issue Nov 13, 2022 · 1 comment
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 enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Proposal Please Confirm You Have Done The Following...

Relevant Package

utils

My proposal is suitable for this project

  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

The @typescript-eslint/utils package used to be called @typescript-eslint/experimental-utils. We procrastinated removing the experimental- from the name for a while, then finally did it in #4139. We left the old experimental- package behind so as to not break things for people. But, it'd be good for them to stop referring to the old package name.

See this line in experimental-utils README.md:

> ⚠ A future major version of this old package will `console.warn` to ask you to switch.

Now that we're working on breaking changes for our next major version, v6, we can add that console.warn in!

Proposal: in https://github.com/typescript-eslint/typescript-eslint/blob/91d71bcf6b2f822116d25b281e289fe1d5005401/packages/experimental-utils/src/index.ts, add a console.warn that says something like the text from the README.md:

**This package is purely a re-export of `@typescript-eslint/utils`.**
You should switch to importing from that non-experimental package instead.

Fail

n/a

Pass

n/a

Additional Info

This is a breaking change and will need to target the v6 branch.

@JoshuaKGoldberg JoshuaKGoldberg added enhancement New feature or request good first issue Good for newcomers breaking change This change will require a new major version to be released accepting prs Go ahead, send a pull request that resolves this issue labels Nov 13, 2022
@JoshuaKGoldberg JoshuaKGoldberg added this to the 6.0.0 milestone Nov 30, 2022
@JoshuaKGoldberg
Copy link
Member Author

Fixed in #6179.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant