Remove hacks for single-element unions/intersections

changelog_unreleased/typescript/10457.md

@@ -0,0 +1,13 @@
+#### Fix misplaced comments in unions and intersections (#10457 by @thorn0)
+
+<!-- prettier-ignore -->
+```ts
+// Input
+type Foo = "1" | "2" /* two */ | "3";
+
+// Prettier stable
+type Foo = "1" | "2" | /* two */ "3";
+
+// Prettier main
+type Foo = "1" | "2" /* two */ | "3";
+```

src/language-js/clean.js

@@ -197,6 +197,14 @@ function clean(ast, newObj, parent) {
   if (ast.type === "InterpreterDirective") {
     newObj.value = newObj.value.trimEnd();
   }
+
+  // Prettier removes degenerate union and intersection types with only one member.
+  if (
+    (ast.type === "TSIntersectionType" || ast.type === "TSUnionType") &&
+    ast.types.length === 1
+  ) {
+    return newObj.types[0];
+  }
 }
 
 clean.ignoredProperties = ignoredProperties;

src/language-js/comments.js

@@ -886,22 +886,6 @@ function isRealFunctionLikeNode(node) {
   );
 }
 
-/**
- * @param {Node} enclosingNode
- * @returns {RegExp | void}
- */
-function getGapRegex(enclosingNode) {
-  if (
-    enclosingNode &&
-    enclosingNode.type !== "BinaryExpression" &&
-    enclosingNode.type !== "LogicalExpression"
-  ) {
-    // Support degenerate single-element unions and intersections.
-    // E.g.: `type A = /* 1 */ & B`
-    return /^[\s&(|]*$/;
-  }
-}
-
 /**
  * @param {any} node
  * @returns {Node[] | void}
@@ -980,7 +964,6 @@ module.exports = {
   handleEndOfLineComment,
   handleRemainingComment,
   isTypeCastComment,
-  getGapRegex,
   getCommentChildNodes,
   willPrintOwnComments,
 };

src/language-js/needs-parens.js

@@ -405,8 +405,10 @@ function needsParens(path, options) {
     case "TSUnionType":
     case "TSIntersectionType":
       if (
-        parent.type === "TSUnionType" ||
-        parent.type === "TSIntersectionType"
+        (parent.type === "TSUnionType" ||
+          parent.type === "TSIntersectionType") &&
+        parent.types.length > 1 &&
+        (!node.types || node.types.length > 1)
       ) {
         return true;
       }

src/language-js/parse-postprocess.js

@@ -129,15 +129,6 @@ function postprocess(ast, options) {
         node.typeAnnotation.range = [locStart(node), locEnd(node)];
         return node.typeAnnotation;
       }
-      case "TSUnionType":
-      case "TSIntersectionType":
-        if (node.types.length === 1) {
-          const [firstType] = node.types;
-          // override loc, so that comments are attached properly
-          firstType.range = [locStart(node), locEnd(node)];
-          return firstType;
-        }
-        break;
       case "TSTypeParameter":
         // babel-ts
         if (typeof node.name === "string") {

src/language-js/printer-estree.js

@@ -1088,6 +1088,5 @@ module.exports = {
     endOfLine: handleComments.handleEndOfLineComment,
     remaining: handleComments.handleRemainingComment,
   },
-  getGapRegex: handleComments.getGapRegex,
   getCommentChildNodes: handleComments.getCommentChildNodes,
 };

tests/typescript/union/__snapshots__/jsfmt.spec.js.snap

@@ -1,5 +1,37 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`comments.ts format 1`] = `
+====================================options=====================================
+parsers: ["typescript"]
+printWidth: 80
+                                                                                | printWidth
+=====================================input======================================
+type A1 = a /* 1 */ | b;
+type A2 = a | /* 1 */ b;
+type A3 = (a /* 1 */) | b;
+type A4 = a | (/* 1 */ b);
+type A5 = (a) /* 1 */ | b;
+type A6 = a | /* 1 */ (b);
+
+type B1 = a /* 1 */ /* 2 */ | b;
+type B2 = a /* 1 */ | /* 2 */ b;
+type B3 = a | /* 1 */ /* 2 */ b;
+
+=====================================output=====================================
+type A1 = a /* 1 */ | b;
+type A2 = a | /* 1 */ b;
+type A3 = a /* 1 */ | b;
+type A4 = a | /* 1 */ b;
+type A5 = a /* 1 */ | b;
+type A6 = a | /* 1 */ b;
+
+type B1 = a /* 1 */ /* 2 */ | b;
+type B2 = a /* 1 */ | /* 2 */ b;
+type B3 = a | /* 1 */ /* 2 */ b;
+
+================================================================================
+`;
+
 exports[`inlining.ts format 1`] = `
 ====================================options=====================================
 parsers: ["typescript"]

tests/typescript/union/comments.ts

@@ -0,0 +1,10 @@
+type A1 = a /* 1 */ | b;
+type A2 = a | /* 1 */ b;
+type A3 = (a /* 1 */) | b;
+type A4 = a | (/* 1 */ b);
+type A5 = (a) /* 1 */ | b;
+type A6 = a | /* 1 */ (b);
+
+type B1 = a /* 1 */ /* 2 */ | b;
+type B2 = a /* 1 */ | /* 2 */ b;
+type B3 = a | /* 1 */ /* 2 */ b;