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
chore: add version to rules #16022
chore: add version to rules #16022
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
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, thank you for contributing ⭐
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.
To fix the lint, can you also add Version
to the know headers array?
Line 833 in 103860e
const knownHeaders = ["Rule Details", "Options", "Environments", "Examples", "Known Limitations", "When Not To Use It", "Compatibility"]; |
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.
Thanks for working on this! But I'm not sure if we want to add this section manually to each rule as it is done in this PR, or automatically generate it from Git history as we do for the current website. so I'll ask @nzakas what the plan was.
I haven't added the versions manually. I checked the Makefile.js file and in gensite function, there's a logic to add version and releases using version.JSON. I slightly modified that logic to add the version to the new docs. |
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.
Thanks for this, but we need to insert this data automatically because we won’t know the correct version for new rules until the release is made. We currently calculate the release version during release and automatically update the docs (in Makefile.JS). For the new site, we want to do the same thing and generate/update a data file with the version info.
Closing in favor of #16036 |
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:
Reference : #16008
What changes did you make? (Give an overview)
Is there anything you'd like reviewers to focus on?