feat: support singleQuote

ikatyang · ikatyang · commit 77116914f1e4 · 2018-06-19T15:19:25.000+08:00
diff --git a/src/language-yaml/printer-yaml.js b/src/language-yaml/printer-yaml.js
@@ -169,12 +169,48 @@ function _print(node, parentNode, path, options, print) {
       return concat(["&", node.value]);
     case "plain":
       return join(hardline, node.value.replace(/\n/g, "\n\n").split("\n"));
-    case "quoteDouble": // TODO: --single-quote
-    case "quoteSingle":
-      return options.originalText.slice(
-        node.position.start.offset,
-        node.position.end.offset
+    case "quoteDouble":
+    case "quoteSingle": {
+      const singleQuote = "'";
+      const doubleQuote = '"';
+      const originalQuote =
+        node.type === "quoteDouble" ? doubleQuote : singleQuote;
+      const raw = options.originalText.slice(
+        node.position.start.offset + 1,
+        node.position.end.offset - 1
       );
+      if (
+        (node.type === "quoteSingle" && raw.includes("\\")) ||
+        (node.type === "quoteDouble" && /\\[^"]/.test(raw))
+      ) {
+        // only quoteDouble can use escape chars
+        // and quoteSingle do not need to escape backslashes
+        return originalQuote + raw + originalQuote;
+      } else if (raw.includes(doubleQuote)) {
+        return (
+          singleQuote +
+          (node.type === "quoteDouble"
+            ? // double quote needs to be escaped by backslash in quoteDouble
+              raw.replace(/\\"/g, doubleQuote)
+            : raw) +
+          singleQuote
+        );
+      }
+
+      if (raw.includes(singleQuote)) {
+        return (
+          doubleQuote +
+          (node.type === "quoteSingle"
+            ? // single quote needs to be escaped by 2 single quotes in quoteSingle
+              raw.replace(/''/g, singleQuote)
+            : raw) +
+          doubleQuote
+        );
+      }
+
+      const quote = options.singleQuote ? singleQuote : doubleQuote;
+      return quote + raw + quote;
+    }
     case "blockFolded": // TODO: --prose-wrap
     case "blockLiteral": {
       const value =
@@ -453,6 +489,10 @@ function clean(node, newNode /*, parent */) {
           return null;
         }
         break;
+      case "quoteDouble":
+      case "quoteSingle":
+        newNode.type = "quote";
+        break;
     }
   }
 }
diff --git a/tests/markdown/__snapshots__/jsfmt.spec.js.snap b/tests/markdown/__snapshots__/jsfmt.spec.js.snap
@@ -1393,7 +1393,7 @@ Copy the following config into your \`.pre-commit-config.yaml\` file:
 
 \`\`\`yaml
 - repo: https://github.com/prettier/prettier
-  sha: '' # Use the sha or tag you want to point at
+  sha: "" # Use the sha or tag you want to point at
   hooks:
     - id: prettier
 \`\`\`
@@ -3772,7 +3772,7 @@ YAML:
 \`\`\`yaml
 semi: false
 overrides:
-  - files: "*.test.js"
+  - files: '*.test.js'
     options:
       semi: true
 \`\`\`
diff --git a/tests/yaml_mapping/__snapshots__/jsfmt.spec.js.snap b/tests/yaml_mapping/__snapshots__/jsfmt.spec.js.snap
@@ -295,7 +295,7 @@ exports[`quote-key.yml 1`] = `
 'b': 123
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 "a": 123
-'b': 123
+"b": 123
 
 `;
 
@@ -304,7 +304,7 @@ exports[`quote-key.yml 2`] = `
 'b': 123
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 "a": 123
-'b': 123
+"b": 123
 
 `;
 
diff --git a/tests/yaml_quote/__snapshots__/jsfmt.spec.js.snap b/tests/yaml_quote/__snapshots__/jsfmt.spec.js.snap
@@ -0,0 +1,43 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`quote.yml 1`] = `
+- "123"
+- '123'
+- "''"
+- '""'
+- ''''
+- "\\"\\""
+- '\\n123'
+- "\\n123"
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- "123"
+- "123"
+- "''"
+- '""'
+- "'"
+- '""'
+- '\\n123'
+- "\\n123"
+
+`;
+
+exports[`quote.yml 2`] = `
+- "123"
+- '123'
+- "''"
+- '""'
+- ''''
+- "\\"\\""
+- '\\n123'
+- "\\n123"
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- '123'
+- '123'
+- "''"
+- '""'
+- "'"
+- '""'
+- '\\n123'
+- "\\n123"
+
+`;
diff --git a/tests/yaml_quote/jsfmt.spec.js b/tests/yaml_quote/jsfmt.spec.js
@@ -0,0 +1,2 @@
+run_spec(__dirname, ["yaml"]);
+run_spec(__dirname, ["yaml"], { singleQuote: true });
diff --git a/tests/yaml_quote/quote.yml b/tests/yaml_quote/quote.yml
@@ -0,0 +1,8 @@
+- "123"
+- '123'
+- "''"
+- '""'
+- ''''
+- "\"\""
+- '\n123'
+- "\n123"
diff --git a/tests/yaml_spec/__snapshots__/jsfmt.spec.js.snap b/tests/yaml_spec/__snapshots__/jsfmt.spec.js.snap
@@ -295,7 +295,7 @@ baz: 2
 exports[`colon-in-double-quoted-string.yml 1`] = `
 "foo: bar\\": baz"
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-"foo: bar\\": baz"
+'foo: bar": baz'
 
 `;
 
@@ -719,7 +719,7 @@ exports[`non-specific-tags-on-scalars.yml 1`] = `
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 - plain
 - "double quoted"
-- 'single quoted'
+- "single quoted"
 - >
   block
 - plain again
@@ -1114,7 +1114,7 @@ control: "\\b1998\\t1999\\t2000\\n"
 hex esc: "\\x0d\\x0a is \\r\\n"
 
 single: '"Howdy!" he cried.'
-quoted: ' # Not a ''comment''.'
+quoted: " # Not a 'comment'."
 tie-fighter: '|\\-*-/|'
 
 `;
@@ -1412,7 +1412,7 @@ exports[`spec-example-5-8-quoted-scalar-indicators.yml 1`] = `
 single: 'text'
 double: "text"
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-single: 'text'
+single: "text"
 double: "text"
 
 `;
@@ -1883,7 +1883,7 @@ exports[`spec-example-7-8-single-quoted-implicit-keys.yml 1`] = `
   'implicit flow key' : value,
  ]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-'implicit block key': ['implicit flow key': value]
+"implicit block key": ["implicit flow key": value]
 
 `;
 
@@ -1893,10 +1893,10 @@ exports[`spec-example-7-9-single-quoted-lines.yml 1`] = `
  2nd non-empty 
 	3rd non-empty '
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-' 1st non-empty
+" 1st non-empty
 
  2nd non-empty 
-	3rd non-empty '
+	3rd non-empty "
 
 `;
 
@@ -1966,8 +1966,8 @@ single: pair,
 ]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ["double
- quoted", 'single
-           quoted', plain text, [nested], single: pair]
+ quoted", "single
+           quoted", plain text, [nested], single: pair]
 
 `;
 
@@ -2054,7 +2054,7 @@ exports[`spec-example-7-23-flow-content.yml 1`] = `
 - [a, b]
 - { a: b }
 - "a"
-- 'b'
+- "b"
 - c
 
 `;
@@ -2067,7 +2067,7 @@ exports[`spec-example-7-24-flow-nodes.yml 1`] = `
 - !!str
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 - !!str "a"
-- 'b'
+- "b"
 - &anchor "c"
 - *anchor
 - !!str
@@ -2726,7 +2726,7 @@ exports[`whitespace-after-scalars-in-flow.yml 1`] = `
 - [      ]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 - [a, b, c]
-- { "a": b, c: 'd', e: "f" }
+- { "a": b, c: "d", e: "f" }
 - []
 
 `;
@@ -2747,15 +2747,15 @@ top6:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 "top1":
   "key1": &alias1 scalar1
-'top2':
-  'key2': &alias2 scalar2
+"top2":
+  "key2": &alias2 scalar2
 top3: &node3
   *alias1 : scalar3
 top4:
   *alias2 : scalar4
 top5: scalar5
 top6:
-  &anchor6 'key6': scalar6
+  &anchor6 "key6": scalar6
 
 `;
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+run_spec(__dirname, ["yaml"]);`
	`2`	`+run_spec(__dirname, ["yaml"], { singleQuote: true });`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +- "123"
 +- '123'
 +- "''"
 +- '""'
 +- ''''
 +- "\"\""
 +- '\n123'
 +- "\n123"