From 9344af8114d457eab996f3ec2439839a37b291fa Mon Sep 17 00:00:00 2001
From: Flo Edelmann <florian-edelmann@online.de>
Date: Sat, 7 May 2022 13:21:01 +0200
Subject: [PATCH] Check symbols before GOOD/BAD comments in docs (#1880)

---
 docs/rules/no-restricted-class.md             |  2 +-
 docs/rules/no-restricted-custom-event.md      |  2 +-
 .../no-use-computed-property-like-method.md   |  2 +-
 tools/update-docs.js                          | 20 +++++++++++++++++++
 4 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/docs/rules/no-restricted-class.md b/docs/rules/no-restricted-class.md
index d67e5d8b2..849c71e8c 100644
--- a/docs/rules/no-restricted-class.md
+++ b/docs/rules/no-restricted-class.md
@@ -35,7 +35,7 @@ in the rule configuration.
   <div :class="'forbidden'" />
   <div :class="'forbidden ' + someString" />
   <div :class="[someString, 'forbidden']" />
-  <!-- ✗ GOOD -->
+  <!-- ✓ GOOD -->
   <div class="allowed-class" />
 </template>
 
diff --git a/docs/rules/no-restricted-custom-event.md b/docs/rules/no-restricted-custom-event.md
index bc48def0a..b77feac14 100644
--- a/docs/rules/no-restricted-custom-event.md
+++ b/docs/rules/no-restricted-custom-event.md
@@ -31,7 +31,7 @@ This rule takes a list of strings, where each string is a custom event name or p
 <template>
   <!-- ✗ BAD -->
   <input @input="$emit('input', $event.target.value)">
-  <!-- ✗ GOOD -->
+  <!-- ✓ GOOD -->
   <input @input="$emit('update:value', $event.target.value)">
 </template>
 <script>
diff --git a/docs/rules/no-use-computed-property-like-method.md b/docs/rules/no-use-computed-property-like-method.md
index 33e49d653..27d6363d1 100644
--- a/docs/rules/no-use-computed-property-like-method.md
+++ b/docs/rules/no-use-computed-property-like-method.md
@@ -320,7 +320,7 @@ export default {
       this.computedReturnPropsFunction
       this.computedReturnPropsFunction()
       /* ✗ BAD */
-      /* Nope. everything is GOOD!! */
+      /* Nope. everything is good!! */
     }
   }
 }
diff --git a/tools/update-docs.js b/tools/update-docs.js
index c34f3e1a0..80211d278 100644
--- a/tools/update-docs.js
+++ b/tools/update-docs.js
@@ -223,6 +223,25 @@ ${
 
     return this
   }
+
+  checkGoodBadSymbols() {
+    const lines = this.content.split('\n')
+    for (const [lineNumber, line] of lines.entries()) {
+      const lineNumberFilePath = `${this.filePath}:${lineNumber + 1}`
+
+      if (line.includes('GOOD') && !line.includes('✓ GOOD')) {
+        throw new Error(
+          `Expected '✓ GOOD' instead of '${line}' in '${lineNumberFilePath}'`
+        )
+      }
+
+      if (line.includes('BAD') && !line.includes('✗ BAD')) {
+        throw new Error(
+          `Expected '✗ BAD' instead of '${line}' in '${lineNumberFilePath}'`
+        )
+      }
+    }
+  }
 }
 
 for (const rule of rules) {
@@ -234,4 +253,5 @@ for (const rule of rules) {
     .adjustCodeBlocks()
     .write()
     .checkHeadings()
+    .checkGoodBadSymbols()
 }