Fix K3WX.yaml (comments in map key) bug in yaml-test-suite (#18324)

kovsu · fisker · web-flow · commit a14c44f30ea7 · 2025-11-27T14:23:14.000+08:00
Co-authored-by: fisker Cheung &lt;lionkay@gmail.com&gt;
diff --git a/changelog_unreleased/yaml/18324.md b/changelog_unreleased/yaml/18324.md
@@ -0,0 +1,15 @@
+#### Use explicit key style for flow-mapping keys with trailing comments (#18324 by @kovsu, @fisker)
+
+<!-- prettier-ignore -->
+```yaml
+# Input
+{ "foo" # comment
+  :bar }
+
+# Prettier stable
+{ "foo": bar } # comment
+
+# Prettier main
+{ ? "foo" # comment
+  : bar }
+```
diff --git a/src/language-yaml/print/mapping-item.js b/src/language-yaml/print/mapping-item.js
@@ -135,6 +135,7 @@ function printMappingItem(path, options, print) {
     isAbsolutelyPrintedAsSingleLineNode(key.content, options) &&
     !hasLeadingComments(key.content) &&
     !hasMiddleComments(key.content) &&
+    !hasTrailingComment(key.content) &&
     !hasEndComments(key)
   ) {
     return conditionalGroup([[printedKey, implicitMappingValue]]);
diff --git a/tests/format/yaml/flow-mapping/comments/__snapshots__/format.test.js.snap b/tests/format/yaml/flow-mapping/comments/__snapshots__/format.test.js.snap
@@ -0,0 +1,53 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`key.yml format 1`] = `
+====================================options=====================================
+parsers: ["yaml"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+{"key" # 1
+:value}
+---
+{["key"] # 2
+:value}
+---
+{
+# 3
+"key"
+:value}
+---
+{
+&[
+"key",
+# 4
+""]
+:value}
+---
+{"key": # 1
+value}
+
+=====================================output=====================================
+{ ? "key" # 1
+  : value }
+---
+{ ? ["key"] # 2
+  : value }
+---
+{
+  # 3
+  "key": value,
+}
+---
+{ ? & [
+      "key",
+      # 4
+      "",
+    ]
+  : value }
+---
+{ ? "key" # 1
+  : value }
+
+================================================================================
+`;
diff --git a/tests/format/yaml/flow-mapping/comments/format.test.js b/tests/format/yaml/flow-mapping/comments/format.test.js
@@ -0,0 +1 @@
+runFormatTest(import.meta, ["yaml"]);
diff --git a/tests/format/yaml/flow-mapping/comments/key.yml b/tests/format/yaml/flow-mapping/comments/key.yml
@@ -0,0 +1,20 @@
+{"key" # 1
+:value}
+---
+{["key"] # 2
+:value}
+---
+{
+# 3
+"key"
+:value}
+---
+{
+&[
+"key",
+# 4
+""]
+:value}
+---
+{"key": # 1
+value}
diff --git a/tests/format/yaml/yaml-test-suite/__snapshots__/format.test.js.snap b/tests/format/yaml/yaml-test-suite/__snapshots__/format.test.js.snap
@@ -3847,6 +3847,24 @@ printWidth: 80
 ================================================================================
 `;
 
+exports[`snippet: K3WX.yaml - Colon and adjacent value after comment on next line format 1`] = `
+====================================options=====================================
+parsers: ["yaml"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+---
+{ "foo" # comment
+  :bar }
+
+=====================================output=====================================
+---
+{ ? "foo" # comment
+  : bar }
+
+================================================================================
+`;
+
 exports[`snippet: K4SU.yaml - Multiple Entry Block Sequence format 1`] = `
 ====================================options=====================================
 parsers: ["yaml"]
diff --git a/tests/format/yaml/yaml-test-suite/format.test.js b/tests/format/yaml/yaml-test-suite/format.test.js
@@ -20,7 +20,6 @@ const BUGS = new Set([
   "DE56-4.yaml",
   "JEF9-2.yaml",
   "JEF9-3.yaml",
-  "K3WX.yaml",
   "L24T-2.yaml",
 ]);
 
