Docs: Display emoji/notice for rules with suggestions

eslint · Jul 23, 2021 · 9b04a51 · 9b04a51
1 parent 4dd81b3
commit 9b04a51
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/_layouts/doc.liquid b/_layouts/doc.liquid
@@ -30,6 +30,7 @@
         | replace: '<p>(fixable) ', '<p class="fixable icon">'
         | replace: '(recommended)', '<span title="recommended" aria-label="recommended">✓</span>'
         | replace: '(fixable)', '<span title="fixable" aria-label="fixable">🔧</span>'
+        | replace: '(hasSuggestions)', '<span title="hasSuggestions" aria-label="fixable">💡</span>'
       }}
     </article>
   </main>

diff --git a/_layouts/rules.liquid b/_layouts/rules.liquid
@@ -16,6 +16,7 @@
       {{ content
         | replace: '(recommended)', '<span title="recommended" aria-label="recommended">✓</span>'
         | replace: '(fixable)', '<span title="fixable" aria-label="fixable">🔧</span>'
+        | replace: '(hasSuggestions)', '<span title="hasSuggestions" aria-label="hasSuggestions">💡</span>'
       }}
     </article>
   </main>

diff --git a/docs/rules/index.liquid b/docs/rules/index.liquid
@@ -14,6 +14,7 @@ layout: doc
     <colgroup>
       <col class="recommended" />
       <col class="fixable" />
+      <col class="hasSuggestions" />
       <col class="name" />
       <col class="description" />
     </colgroup>
@@ -22,6 +23,7 @@ layout: doc
         <tr>
         <td>{% if rule.recommended %}(recommended){% endif %}</td>
         <td>{% if rule.fixable %}(fixable){% endif %}</td>
+        <td>{% if rule.meta.docs.suggestion %}(hasSuggestions){% endif %}</td>
         <td markdown="1"><a href="{{ rule.name }}">{{ rule.name }}</a> </td>
         <td markdown="1">{{ rule.description }} </td>
         </tr>

diff --git a/src/styles/lib/overrides.less b/src/styles/lib/overrides.less
@@ -100,6 +100,10 @@ p {
     content: "🔧"; /* wrench */
   }
 
+  &.hasSuggestions:before {
+    content: "💡"; /* lightbulb */
+  }
+
   &.incorrect:before {
     content: "\e126"; /* thumbs-down */
   }