-
-
Notifications
You must be signed in to change notification settings - Fork 4.9k
docs: use consistent naming recommendation #20250
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: use consistent naming recommendation #20250
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
497f5e4 to
d499064
Compare
d499064 to
4d23bd5
Compare
|
Thanks for catching this inconsistency. We should definitely align these recommendations. |
Co-authored-by: Milos Djermanovic <[email protected]>
lumirlumir
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
Would like @mdjermanovic to verify before merging.
mdjermanovic
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
The docs pages extend/plugin-migration-flat-config#backwards-compatibility and extend/plugins#backwards-compatibility-for-legacy-configs both recommended different namings for legacy configurations.
While the former page called for a suffix
-legacy, the latter recommends a prefix withlegacy-.The docs line recommending
legacy-as prefix had a more recent commit (7 months vs 2 years) and both eslint-plugin-vitest and eslint-plugin-package-json use this naming, so I opted to keep this version.Is there anything you'd like reviewers to focus on?
Please check whether the naming convention is the one you want to go with.