Markdown: Preserve multiple spaces in inline code (#13590)

prettier · Oct 14, 2022 · 8df3b5e · 8df3b5e
1 parent 001d8b0
commit 8df3b5e
Show file tree

Hide file tree

Showing 23 changed files with 498 additions and 51 deletions.
diff --git a/changelog_unreleased/markdown/13590.md b/changelog_unreleased/markdown/13590.md
@@ -0,0 +1,15 @@
+#### Preserve multiple spaces in inline code (#13590 by @kachkaev and @thorn0)
+
+Previously, multiple whitespace characters in inline code were collapsed into a single space. This is no longer happening to match [CommonMark spec](https://spec.commonmark.org/0.30/#backtick-string).
+
+<!-- prettier-ignore -->
+```markdown
+<!-- Input -->
+`   foo   bar   baz   `
+
+<!-- Prettier stable -->
+` foo bar baz `
+
+<!-- Prettier main -->
+`   foo   bar   baz   `
+```
diff --git a/src/language-markdown/clean.js b/src/language-markdown/clean.js
@@ -33,7 +33,7 @@ function clean(ast, newObj, parent) {
   }
 
   if (ast.type === "inlineCode") {
-    newObj.value = ast.value.replace(/[\t\n ]+/g, " ");
+    newObj.value = ast.value.replace(/\n/g, " ");
   }
 
   if (ast.type === "wikiLink") {

diff --git a/src/language-markdown/print-preprocess.js b/src/language-markdown/print-preprocess.js
@@ -6,7 +6,6 @@ const isSingleCharRegex = /^.$/su;
 function preprocess(ast, options) {
   ast = restoreUnescapedCharacter(ast, options);
   ast = mergeContinuousTexts(ast);
-  ast = transformInlineCode(ast, options);
   ast = transformIndentedCodeblockAndMarkItsParentList(ast, options);
   ast = markAlignedList(ast, options);
   ast = splitTextIntoSentences(ast, options);
@@ -25,16 +24,6 @@ function transformImportExport(ast) {
   });
 }
 
-function transformInlineCode(ast, options) {
-  return mapAst(ast, (node) => {
-    if (node.type !== "inlineCode" || options.proseWrap === "preserve") {
-      return node;
-    }
-
-    return { ...node, value: node.value.replace(/\s+/g, " ") };
-  });
-}
-
 function restoreUnescapedCharacter(ast, options) {
   return mapAst(ast, (node) =>
     node.type !== "text" ||

diff --git a/src/language-markdown/printer-markdown.js b/src/language-markdown/printer-markdown.js
@@ -169,10 +169,19 @@ function genericPrint(path, options, print) {
     case "delete":
       return ["~~", printChildren(path, options, print), "~~"];
     case "inlineCode": {
-      const backtickCount = getMinNotPresentContinuousCount(node.value, "`");
-      const style = "`".repeat(backtickCount || 1);
-      const gap = backtickCount && !/^\s/.test(node.value) ? " " : "";
-      return [style, gap, node.value, gap, style];
+      const code =
+        options.proseWrap === "preserve"
+          ? node.value
+          : node.value.replace(/\n/g, " ");
+      const backtickCount = getMinNotPresentContinuousCount(code, "`");
+      const backtickString = "`".repeat(backtickCount || 1);
+      const padding =
+        code.startsWith("`") ||
+        code.endsWith("`") ||
+        (/^[\n ]/.test(code) && /[\n ]$/.test(code) && /[^\n ]/.test(code))
+          ? " "
+          : "";
+      return [backtickString, padding, code, padding, backtickString];
     }
     case "wikiLink": {
       let contents = "";

diff --git a/tests/format/js/multiparser-markdown/__snapshots__/jsfmt.spec.js.snap b/tests/format/js/multiparser-markdown/__snapshots__/jsfmt.spec.js.snap
@@ -109,7 +109,7 @@ markdown\`
 
 =====================================output=====================================
 markdown\`
-  const cssString = css\\\` background-color: \\$\\{color('base')\\}\\\`;
+  const cssString = css\\\`  background-color: \\$\\{color('base')\\}\\\`;
 \`;
 
 markdown\`