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: Prepare data for website to indicate rules with suggestions #14830
Conversation
@@ -197,7 +197,8 @@ function generateRuleIndexPage() { | |||
name: basename, | |||
description: rule.meta.docs.description, | |||
recommended: rule.meta.docs.recommended || false, | |||
fixable: !!rule.meta.fixable | |||
fixable: !!rule.meta.fixable, |
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.
FYI: This is changing in v8.0.0. It will be meta.hasSuggestions. See #13398
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.
I think you meant to link to #14573? I'll update that PR after this is merged to ensure this code refers to meta.hasSuggestions
once that change takes place.
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.
That works too. I was intending to point out that meta.docs.suggestions would be going away.
Marked as accepted since eslint/archive-website#859 is accepted. |
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
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
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!
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
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[X] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Prepare for the ESLint website to display an emoji/notice for rules with suggestions.
Fixes eslint/archive-website#859
Other part to this change: eslint/archive-website#860
TODO: After this is merged, remember to update #14573 to change the new usage of
meta.docs.suggestion
tometa.hasSuggestions
.Is there anything you'd like reviewers to focus on?
No.