Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Docs: Add emoji and notice to indicate which rules provide suggestions #859

Closed
bmish opened this issue Jul 23, 2021 · 1 comment · Fixed by #860 or eslint/eslint#14830
Closed

Docs: Add emoji and notice to indicate which rules provide suggestions #859

bmish opened this issue Jul 23, 2021 · 1 comment · Fixed by #860 or eslint/eslint#14830
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion
Projects

Comments

@bmish
Copy link
Sponsor Member

bmish commented Jul 23, 2021

A number of core ESLint rules can provide automated suggestions. I would like to update the ESLint website (rules list and individual rule docs) to indicate which rules provide these suggestions.

  • Add a 💡 emoji (represents idea/suggestion) next to rules that provide suggestions in the rules list/table
  • Add the following to the top of individual rule docs:
    • 💡 Some problems reported by this rule are manually fixable by editor suggestions.

Benefits of this change:

  • Similar to how it's useful to know which rules have an autofixer, it's also useful to know which rules provide suggestions, as such functionality can enable easier adoption and usage of a rule
  • Mentioning suggestions can help increase awareness of the relatively-new suggestions feature that was only released in 2019-11 -- encouraging greater usage of it and the addition of suggestions to more rules

A number of plugins I work on have already added the suggestion emoji/notice to their rules table and individual rule docs:

And in fact, enabling plugins to reliably show the above emoji/notice is one of the reasons why I pushed for requiring rules with suggestions to enable meta.hasSuggestions for us to key off of (eslint/eslint#14573).

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Jul 23, 2021
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Jul 23, 2021
@nzakas
Copy link
Member

nzakas commented Jul 24, 2021

Seems reasonable. FYI, you don’t need to open an issue for this sort of thing. Just opening a PR is fine. The most likely feedback is “can I see a screenshot?” so doing the PR with the change so we can see the deploy preview helps make the case.

@nzakas nzakas added accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jul 24, 2021
@nzakas nzakas moved this from Needs Triage to Pull Request Opened in Triage Jul 24, 2021
Triage automation moved this from Pull Request Opened to Complete Jul 29, 2021
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
Projects
Archived in project
Triage
Complete
2 participants