Add parenthesis around leading multiline comment in return statement (#…

…15037)
prettier · Jul 16, 2023 · 8da37cc · 8da37cc
1 parent a5a556f
commit 8da37cc
Show file tree

Hide file tree

Showing 4 changed files with 274 additions and 1 deletion.
diff --git a/changelog_unreleased/javascript/15037.md b/changelog_unreleased/javascript/15037.md
@@ -0,0 +1,29 @@
+#### Add parenthesis around leading multiline comment in return statement (#15037 by @auvred)
+
+<!-- prettier-ignore -->
+```jsx
+// Input
+function fn() {
+  return (
+    /**
+     * @type {...}
+     */ expresssion
+  )
+}
+
+// Prettier stable
+function fn() {
+  return /**
+   * @type {...}
+   */ expresssion;
+}
+
+// Prettier main
+function fn() {
+  return (
+    /**
+     * @type {...}
+     */ expresssion
+  );
+}
+```
diff --git a/src/language-js/print/function.js b/src/language-js/print/function.js
@@ -11,13 +11,16 @@ import {
   getFunctionParameters,
   hasLeadingOwnLineComment,
   isBinaryish,
+  isJsxElement,
   hasComment,
   CommentCheckFlags,
   isCallExpression,
   getCallArguments,
   hasNakedLeftSide,
   getLeftSide,
 } from "../utils/index.js";
+import hasNewlineInRange from "../../utils/has-newline-in-range.js";
+import { locEnd, locStart } from "../loc.js";
 import {
   printFunctionParameters,
   shouldGroupFunctionParameters,
@@ -286,7 +289,17 @@ function printThrowStatement(path, options, print) {
 // (the leftmost leaf node) and, if it (or its parents) has any
 // leadingComments, returns true (so it can be wrapped in parens).
 function returnArgumentHasLeadingComment(options, argument) {
-  if (hasLeadingOwnLineComment(options.originalText, argument)) {
+  if (
+    hasLeadingOwnLineComment(options.originalText, argument) ||
+    (hasComment(argument, CommentCheckFlags.Leading, (comment) =>
+      hasNewlineInRange(
+        options.originalText,
+        locStart(comment),
+        locEnd(comment),
+      ),
+    ) &&
+      !isJsxElement(argument))
+  ) {
     return true;
   }
 

diff --git a/tests/format/js/comments/__snapshots__/jsfmt.spec.js.snap b/tests/format/js/comments/__snapshots__/jsfmt.spec.js.snap
@@ -4733,6 +4733,53 @@ function inlineComment() {
   ) || 42
 }
 
+function multilineBlockSameLine() {
+  return (
+    /**
+    * @type {string}
+    */ 'result'
+  )
+}
+
+function multilineBlockNextLine() {
+  return (
+    /**
+    * @type {string}
+    */ 
+    'result'
+  )
+}
+
+function multilineBlockSameLineJsx() {
+  return (
+    /**
+    * JSX Same line
+    */ <div></div>
+  )
+}
+
+function multilineBlockNextLineJsx() {
+  return (
+    /**
+    * JSX Next line
+    */
+    <div></div>
+  )
+}
+
+function singleLineBlockSameLine() {
+  return (
+    /** Result -> */ 'result'
+  )
+}
+
+function singleLineBlockNextLine() {
+  return (
+    /** Result below */ 
+    'result'
+  )
+}
+
 =====================================output=====================================
 function jsx() {
   return (
@@ -4864,6 +4911,51 @@ function inlineComment() {
   return /* hi */ 42 || 42
 }
 
+function multilineBlockSameLine() {
+  return (
+    /**
+     * @type {string}
+     */ "result"
+  )
+}
+
+function multilineBlockNextLine() {
+  return (
+    /**
+     * @type {string}
+     */
+    "result"
+  )
+}
+
+function multilineBlockSameLineJsx() {
+  return (
+    /**
+     * JSX Same line
+     */ <div></div>
+  )
+}
+
+function multilineBlockNextLineJsx() {
+  return (
+    /**
+     * JSX Next line
+     */
+    <div></div>
+  )
+}
+
+function singleLineBlockSameLine() {
+  return /** Result -> */ "result"
+}
+
+function singleLineBlockNextLine() {
+  return (
+    /** Result below */
+    "result"
+  )
+}
+
 ================================================================================
 `;
 
@@ -4995,6 +5087,53 @@ function inlineComment() {
   ) || 42
 }
 
+function multilineBlockSameLine() {
+  return (
+    /**
+    * @type {string}
+    */ 'result'
+  )
+}
+
+function multilineBlockNextLine() {
+  return (
+    /**
+    * @type {string}
+    */ 
+    'result'
+  )
+}
+
+function multilineBlockSameLineJsx() {
+  return (
+    /**
+    * JSX Same line
+    */ <div></div>
+  )
+}
+
+function multilineBlockNextLineJsx() {
+  return (
+    /**
+    * JSX Next line
+    */
+    <div></div>
+  )
+}
+
+function singleLineBlockSameLine() {
+  return (
+    /** Result -> */ 'result'
+  )
+}
+
+function singleLineBlockNextLine() {
+  return (
+    /** Result below */ 
+    'result'
+  )
+}
+
 =====================================output=====================================
 function jsx() {
   return (
@@ -5126,6 +5265,51 @@ function inlineComment() {
   return /* hi */ 42 || 42;
 }
 
+function multilineBlockSameLine() {
+  return (
+    /**
+     * @type {string}
+     */ "result"
+  );
+}
+
+function multilineBlockNextLine() {
+  return (
+    /**
+     * @type {string}
+     */
+    "result"
+  );
+}
+
+function multilineBlockSameLineJsx() {
+  return (
+    /**
+     * JSX Same line
+     */ <div></div>
+  );
+}
+
+function multilineBlockNextLineJsx() {
+  return (
+    /**
+     * JSX Next line
+     */
+    <div></div>
+  );
+}
+
+function singleLineBlockSameLine() {
+  return /** Result -> */ "result";
+}
+
+function singleLineBlockNextLine() {
+  return (
+    /** Result below */
+    "result"
+  );
+}
+
 ================================================================================
 `;
 

diff --git a/tests/format/js/comments/return-statement.js b/tests/format/js/comments/return-statement.js
@@ -119,3 +119,50 @@ function inlineComment() {
     /* hi */ 42
   ) || 42
 }
+
+function multilineBlockSameLine() {
+  return (
+    /**
+    * @type {string}
+    */ 'result'
+  )
+}
+
+function multilineBlockNextLine() {
+  return (
+    /**
+    * @type {string}
+    */ 
+    'result'
+  )
+}
+
+function multilineBlockSameLineJsx() {
+  return (
+    /**
+    * JSX Same line
+    */ <div></div>
+  )
+}
+
+function multilineBlockNextLineJsx() {
+  return (
+    /**
+    * JSX Next line
+    */
+    <div></div>
+  )
+}
+
+function singleLineBlockSameLine() {
+  return (
+    /** Result -> */ 'result'
+  )
+}
+
+function singleLineBlockNextLine() {
+  return (
+    /** Result below */ 
+    'result'
+  )
+}