fix(formatter): correct checking comments around the return argument (#14585)

Author: Dunqing

crates/oxc_formatter/src/write/return_or_throw_statement.rs

@@ -123,39 +123,39 @@ fn has_argument_leading_comments(argument: &AstNode<Expression>, f: &Formatter<'
         let start = left_side.span().start;
         let comments = f.comments().comments_before(start);
 
-        let is_line_comment_or_multi_line_comment = |comments: &[Comment]| {
+        if f.comments().comments_before_iter(start).any(|comment| {
+            source_text.contains_newline(comment.span)
+                || source_text.is_end_of_line_comment(comment)
+        }) {
+            return true;
+        }
+
+        let is_own_line_comment_or_multi_line_comment = |comments: &[Comment]| {
             comments.iter().any(|comment| {
-                comment.is_line()
+                source_text.is_own_line_comment(comment)
                     || source_text.contains_newline(comment.span)
-                    || source_text.is_end_of_line_comment(comment)
             })
         };
 
-        if is_line_comment_or_multi_line_comment(comments) {
-            return true;
-        }
-
         // This check is based on
         // <https://github.com/prettier/prettier/blob/7584432401a47a26943dd7a9ca9a8e032ead7285/src/language-js/comments/handle-comments.js#L335-L349>
         if let ExpressionLeftSide::Expression(left_side) = left_side {
             let has_leading_own_line_comment = match left_side.as_ref() {
                 Expression::ChainExpression(chain) => {
                     if let ChainElement::StaticMemberExpression(member) = &chain.expression {
-                        is_line_comment_or_multi_line_comment(
-                            f.comments().comments_in_range(
-                                member.object.span().end,
-                                member.property.span.end,
-                            ),
-                        )
+                        let comments = f
+                            .comments()
+                            .comments_in_range(member.object.span().end, member.property.span.end);
+                        is_own_line_comment_or_multi_line_comment(comments)
                     } else {
                         false
                     }
                 }
                 Expression::StaticMemberExpression(member) => {
-                    is_line_comment_or_multi_line_comment(
-                        f.comments()
-                            .comments_in_range(member.object.span().end, member.property.span.end),
-                    )
+                    let comments = f
+                        .comments()
+                        .comments_in_range(member.object.span().end, member.property.span.end);
+                    is_own_line_comment_or_multi_line_comment(comments)
                 }
                 _ => false,
             };

crates/oxc_formatter/tests/fixtures/js/comments/return.js

@@ -0,0 +1,8 @@
+function escapePathForGlob(path) {
+  return fastGlob
+    .escapePath(
+      path.replaceAll("\\", "\0"), // Workaround for fast-glob#262 (part 1)
+    )
+    .replaceAll(String.raw`\!`, "@(!)") // Workaround for fast-glob#261
+    .replaceAll("\0", String.raw`@(\\)`); // Workaround for fast-glob#262 (part 2)
+}

crates/oxc_formatter/tests/fixtures/js/comments/return.js.snap

@@ -0,0 +1,24 @@
+---
+source: crates/oxc_formatter/tests/fixtures/mod.rs
+---
+==================== Input ====================
+function escapePathForGlob(path) {
+  return fastGlob
+    .escapePath(
+      path.replaceAll("\\", "\0"), // Workaround for fast-glob#262 (part 1)
+    )
+    .replaceAll(String.raw`\!`, "@(!)") // Workaround for fast-glob#261
+    .replaceAll("\0", String.raw`@(\\)`); // Workaround for fast-glob#262 (part 2)
+}
+
+==================== Output ====================
+function escapePathForGlob(path) {
+  return fastGlob
+    .escapePath(
+      path.replaceAll("\\", "\0"), // Workaround for fast-glob#262 (part 1)
+    )
+    .replaceAll(String.raw`\!`, "@(!)") // Workaround for fast-glob#261
+    .replaceAll("\0", String.raw`@(\\)`); // Workaround for fast-glob#262 (part 2)
+}
+
+===================== End =====================