Fix false negatives for hyphen in yml/plain-scalar rule (#32)

ota-meshi · Feb 3, 2021 · 08daf98 · 08daf98
1 parent 99b6b55
commit 08daf98
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 2 deletions.
diff --git a/src/rules/plain-scalar.ts b/src/rules/plain-scalar.ts
@@ -9,7 +9,7 @@ const SYMBOLS = new Set([
     "{",
     "}",
     // sequence
-    "-",
+    // "-",
     "[",
     "]",
     ",",
@@ -62,11 +62,16 @@ export default createRule("plain-scalar", {
         function canToPlain(
             node: AST.YAMLDoubleQuotedScalar | AST.YAMLSingleQuotedScalar,
         ) {
-            for (const char of node.value) {
+            for (let index = 0; index < node.value.length; index++) {
+                const char = node.value[index]
                 if (SYMBOLS.has(char)) {
                     return false
                 }
             }
+            if (/^\s*-\s+/u.test(node.value)) {
+                // “-” indicator
+                return false
+            }
             const parent =
                 node.parent.type === "YAMLWithMeta"
                     ? node.parent.parent

diff --git a/tests/fixtures/rules/plain-scalar/invalid/hyphen-test-errors.json b/tests/fixtures/rules/plain-scalar/invalid/hyphen-test-errors.json
@@ -0,0 +1,22 @@
+[
+    {
+        "message": "Must use plain style scalar.",
+        "line": 2,
+        "column": 1
+    },
+    {
+        "message": "Must use plain style scalar.",
+        "line": 4,
+        "column": 1
+    },
+    {
+        "message": "Must use plain style scalar.",
+        "line": 5,
+        "column": 1
+    },
+    {
+        "message": "Must use plain style scalar.",
+        "line": 6,
+        "column": 1
+    }
+]
diff --git a/tests/fixtures/rules/plain-scalar/invalid/hyphen-test-input.yml b/tests/fixtures/rules/plain-scalar/invalid/hyphen-test-input.yml
@@ -0,0 +1,6 @@
+# {}
+"-a": b
+"- a": b
+"-- a": b
+"a-a": b
+"a - a": b
diff --git a/tests/fixtures/rules/plain-scalar/invalid/hyphen-test-output.yml b/tests/fixtures/rules/plain-scalar/invalid/hyphen-test-output.yml
@@ -0,0 +1,6 @@
+# plain-scalar/invalid/hyphen-test-input.yml
+-a: b
+"- a": b
+-- a: b
+a-a: b
+a - a: b