Skip to content

Add new rule no-deprecated-experimental-components #325

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

Merged
merged 12 commits into from
Apr 10, 2025

Conversation

TylerJDev
Copy link
Member

@TylerJDev TylerJDev commented Apr 8, 2025

Part of https://github.com/github/primer/issues/4786

Introduces a new ESLint rule to discourage the use of deprecated experimental components. This will mainly be utilized for SelectPanelV2, but is generalized to potentially include other experimental components.

Copy link

changeset-bot bot commented Apr 8, 2025

🦋 Changeset detected

Latest commit: 481a89c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
eslint-plugin-primer-react Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@TylerJDev
Copy link
Member Author

@francinelucca - I changed the rule name to no-deprecated-experimental-components in case we ever need to do this in the future with another experimental component. Curious what you think! Should we keep it, or should we go back to no-experimental-selectpanel?

@TylerJDev TylerJDev requested a review from francinelucca April 8, 2025 21:27
Copy link
Member

@francinelucca francinelucca left a comment

Choose a reason for hiding this comment

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

Love it! some small changes

@TylerJDev TylerJDev marked this pull request as ready for review April 9, 2025 14:39
@TylerJDev TylerJDev requested a review from a team as a code owner April 9, 2025 14:39
@TylerJDev TylerJDev requested a review from hectahertz April 9, 2025 19:33
meta: {
type: 'problem',
docs: {
description: 'Use deprecated components from the `@primer/react/deprecated` entrypoint',
Copy link
Member

Choose a reason for hiding this comment

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

oop, can we fix this description? 🙏

Copy link
Member Author

Choose a reason for hiding this comment

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

Yup! Should now be "Use a stable component from the @primer/react/deprecated entrypoint, or check the docs for alternatives".

@TylerJDev TylerJDev merged commit f689fcc into main Apr 10, 2025
8 checks passed
@TylerJDev TylerJDev deleted the add-no-deprecated-experimental-components-rule branch April 10, 2025 15:06
@primer-css primer-css mentioned this pull request Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants