Check symbols before GOOD/BAD comments in docs (#1880)

vuejs · May 7, 2022 · 9344af8 · 9344af8
1 parent 309cace
commit 9344af8
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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()
 }