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: Prepare data for website to indicate rules with suggestions #14830

Merged
merged 3 commits into from Jul 29, 2021

Conversation

bmish
Copy link
Sponsor Member

@bmish bmish commented Jul 23, 2021

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 to meta.hasSuggestions.

Is there anything you'd like reviewers to focus on?

No.

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Jul 23, 2021
@bmish bmish changed the title Docs: Display emoji/notice on website for rules with suggestions Docs: Prepare data for website to indicate rules with suggestions Jul 23, 2021
@@ -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,
Copy link
Member

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

Copy link
Sponsor Member Author

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.

Copy link
Member

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.

Makefile.js Show resolved Hide resolved
Makefile.js Outdated Show resolved Hide resolved
Makefile.js Outdated Show resolved Hide resolved
@mdjermanovic mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion build This change relates to ESLint's build process and removed triage An ESLint team member will look at this issue soon labels Jul 25, 2021
@mdjermanovic
Copy link
Member

Marked as accepted since eslint/archive-website#859 is accepted.

bmish and others added 2 commits July 25, 2021 23:38
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Contributor

@snitin315 snitin315 left a comment

Choose a reason for hiding this comment

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

LGTM

@bmish bmish merged commit d53d906 into eslint:master Jul 29, 2021
@bmish bmish deleted the docs-hasSuggestions branch July 29, 2021 18:09
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jan 26, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jan 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion build This change relates to ESLint's build process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add emoji and notice to indicate which rules provide suggestions
4 participants