Fix printing comment for the last operand of union types (#18798)

changelog_unreleased/typescript/18798.md

@@ -0,0 +1,40 @@
+#### Fix printing comment for the last operand of union types (#18798 by @fisker)
+
+<!-- prettier-ignore -->
+```tsx
+// Input
+type Foo2 = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) & Bar; // Final comment2
+type Foo2 = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) | Bar; // Final comment2
+
+// Prettier stable
+type Foo2 = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) &
+  Bar; // Final comment2
+type Foo2 =
+  | (
+      | "thing1" // Comment1
+      | "thing2"
+    ) // Comment2
+  | Bar; // Final comment2
+
+// Prettier main
+type Foo2 = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) &
+  Bar; // Final comment2
+type Foo2 =
+  | (
+      | "thing1" // Comment1
+      | "thing2" // Comment2
+    )
+  | Bar; // Final comment2
+```

src/language-js/comments/handle-comments.js

@@ -20,6 +20,7 @@ import { isObjectProperty } from "../utilities/is-object-property.js";
 import { isPrettierIgnoreComment } from "../utilities/is-prettier-ignore-comment.js";
 import { isTypeCastComment } from "../utilities/is-type-cast-comment.js";
 import {
+  isArrayType,
   isBinaryCastExpression,
   isCallLikeExpression,
   isCallOrNewExpression,
@@ -994,7 +995,7 @@ function handleSwitchDefaultCaseComments({
 }
 
 /**
- * Handle `Comment2` and `Comment4`.
+ * Handle `Comment2`, `Comment4`, `Comment6`.
  *
  *   type Foo = (
  *     | "thing1" // Comment1
@@ -1006,6 +1007,11 @@ function handleSwitchDefaultCaseComments({
  *     | "thing2" // Comment4
  *   ) & Bar;
  *
+ *   type Foo = (
+ *     | "thing1" // Comment5
+ *     | "thing2" // Comment6
+ *   ) | Bar;
+ *
  * @param {CommentContext} context
  * @returns {boolean}
  */
@@ -1017,10 +1023,9 @@ function handleLastUnionElementInExpression({
 }) {
   if (
     isUnionType(precedingNode) &&
-    (((enclosingNode.type === "TSArrayType" ||
-      enclosingNode.type === "ArrayTypeAnnotation") &&
-      !followingNode) ||
-      isIntersectionType(enclosingNode))
+    ((isArrayType(enclosingNode) && !followingNode) ||
+      isIntersectionType(enclosingNode) ||
+      isUnionType(enclosingNode))
   ) {
     addTrailingComment(precedingNode.types.at(-1), comment);
     return true;

src/language-js/utilities/node-types.js

@@ -132,4 +132,9 @@ export const isChainElementWrapper = createTypeCheckFunction([
   "TSNonNullExpression",
 ]);
 
+export const isArrayType = createTypeCheckFunction([
+  "TSArrayType",
+  "ArrayTypeAnnotation",
+]);
+
 export * from "./literal.js";

tests/format/flow/union/__snapshots__/format.test.js.snap

@@ -22,37 +22,6 @@ const myValue = (callcallcallcallcallcall(
 ================================================================================
 `;
 
-exports[`comments.js format 1`] = `
-====================================options=====================================
-parsers: ["flow"]
-printWidth: 80
-                                                                                | printWidth
-=====================================input======================================
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-)[]; // Final comment1
-
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-) & Bar; // Final comment2
-
-=====================================output=====================================
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-)[]; // Final comment1
-
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-) &
-  Bar; // Final comment2
-
-================================================================================
-`;
-
 exports[`union.js format 1`] = `
 ====================================options=====================================
 parsers: ["flow"]

tests/format/typescript/union/__snapshots__/format.test.js.snap

@@ -1,36 +1,5 @@
 // Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
-exports[`comments.ts format 1`] = `
-====================================options=====================================
-parsers: ["typescript"]
-printWidth: 80
-                                                                                | printWidth
-=====================================input======================================
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-)[]; // Final comment1
-
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-) & Bar; // Final comment2
-
-=====================================output=====================================
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-)[]; // Final comment1
-
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-) &
-  Bar; // Final comment2
-
-================================================================================
-`;
-
 exports[`inlining.ts format 1`] = `
 ====================================options=====================================
 parsers: ["typescript"]

tests/format/typescript/union/comments.ts

@@ -1,9 +0,0 @@
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-)[]; // Final comment1
-
-type Foo = (
-  | "thing1" // Comment1
-  | "thing2" // Comment2
-) & Bar; // Final comment2

tests/format/typescript/union/comments/__snapshots__/format.test.js.snap

@@ -208,7 +208,10 @@ type A2 =
   | c;
 
 type A4 =
-  | (A | B) // comment 1
+  | (
+      | A
+      | B // comment 1
+    )
   // comment2
   | (A | B);
 

tests/format/typescript/union/consistent-with-flow/__snapshots__/format.test.js.snap

@@ -380,6 +380,49 @@ type B2 =
 ================================================================================
 `;
 
+exports[`union-last-comment.ts format 1`] = `
+====================================options=====================================
+parsers: ["typescript", "flow"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+type Foo = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+)[]; // Final comment1
+
+type Foo = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) & Bar; // Final comment2
+
+type Foo = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) | Bar; // Final comment2
+
+=====================================output=====================================
+type Foo = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+)[]; // Final comment1
+
+type Foo = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) &
+  Bar; // Final comment2
+
+type Foo =
+  | (
+      | "thing1" // Comment1
+      | "thing2" // Comment2
+    )
+  | Bar; // Final comment2
+
+================================================================================
+`;
+
 exports[`within-tuple.ts format 1`] = `
 ====================================options=====================================
 parsers: ["typescript", "flow"]

tests/format/typescript/union/consistent-with-flow/union-last-comment.ts

@@ -7,3 +7,8 @@ type Foo = (
   | "thing1" // Comment1
   | "thing2" // Comment2
 ) & Bar; // Final comment2
+
+type Foo = (
+  | "thing1" // Comment1
+  | "thing2" // Comment2
+) | Bar; // Final comment2