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

Docs: Better Callouts for all / strict / strict-type-checked Config Stability #9073

Closed
2 tasks done
bachmacintosh opened this issue May 10, 2024 · 1 comment · Fixed by #9257
Closed
2 tasks done
Assignees
Labels
documentation Documentation ("docs") that needs adding/updating team assigned A member of the typescript-eslint team should work on this.

Comments

@bachmacintosh
Copy link

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Currently on the Shared Configs page, there is a small blurb near the top of the page that reads:

With the exception of all, strict, and strict-type-checked, all configurations are considered "stable". Rule additions and removals are treated as breaking changes and will only be done in major version bumps.

However, when a user visits a rule (e.g. no-dynamic-delete ), and clicks on the link to the config and how to add it to their ESLint config, they are taken past this blurb, and may never see it.

The CAUTIONs under the strict and strict-type-checked configs, as well as the WARNING under the all config, could be updated, or a new admonishment of some kind (ie a CAUTION or WARNING) could be added to each one, to say essentially the inverse of the blurb at the top, with text such as:

This configuration is not considered "stable" under Semantic Versioning (SemVer); its enabled rules and/or their settings may change even outside of major version updates.

This would better call out their not being considered "stable," especially being under an admonishment instead of a blockquote blurb, and make the wording visible as soon as a user arrives at the config from a rule, instead of relying on their scrolling to the top of the page to get the information. Optionally, the blurb could be removed as well.

Affected URL(s)

@bachmacintosh bachmacintosh added documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look labels May 10, 2024
@JoshuaKGoldberg
Copy link
Member

FWIW I think this is a good idea. We probably don't need to spend more than a single line for each of the configs.

@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Jun 3, 2024
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jun 4, 2024
@JoshuaKGoldberg JoshuaKGoldberg added team assigned A member of the typescript-eslint team should work on this. and removed accepting prs Go ahead, send a pull request that resolves this issue labels Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation ("docs") that needs adding/updating team assigned A member of the typescript-eslint team should work on this.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants