fix(js_formatter): fix comment with single instruction within a contr…

…ol flow body (#1655)
biomejs · Jan 25, 2024 · 6a768ed · 6a768ed
1 parent 1616d55
commit 6a768ed
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 228 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,8 @@ Read our [guidelines for writing a good changelog entry](https://github.com/biom
 
 - Fix [#1508](https://github.com/biomejs/biome/issues/1508) by excluding deleted files from being processed. Contributed by @ematipico
 
+- Fix [#1173](https://github.com/biomejs/biome/issues/1173). Fix the formatting of a single instruction with commented in a control flow body to ensure consistency. Contributed by @mdm317
+
 ### Configuration
 
 ### Editors

diff --git a/crates/biome_js_formatter/src/comments.rs b/crates/biome_js_formatter/src/comments.rs
@@ -280,8 +280,12 @@ fn handle_continue_break_comment(
 
     let enclosing = comment.enclosing_node();
 
-    if let Some(preceding) = comment.preceding_node() {
-        if preceding.kind() == JsSyntaxKind::JS_LABEL {
+    if let (Some(preceding), Some(parent)) =
+        (comment.preceding_node(), comment.enclosing_node().parent())
+    {
+        if preceding.kind() == JsSyntaxKind::JS_LABEL
+            && parent.kind() != JsSyntaxKind::JS_FOR_STATEMENT
+        {
             return CommentPlacement::trailing(preceding.clone(), comment);
         }
     }

diff --git a/...ome_js_formatter/tests/specs/prettier/js/for/continue-and-break-comment-without-blocks.js b/...ome_js_formatter/tests/specs/prettier/js/for/continue-and-break-comment-without-blocks.js
@@ -85,14 +85,13 @@ for (const f in {}) break
 label1: for (;;) continue label1 /* comment */
 ;
 
-// FIXME: TODO: reformat issue
-// label1: for (;;) continue label1
-// /* comment */
-// ;
+label1: for (;;) continue label1
+/* comment */
+;
 
-// label1: for (;;) continue label1 // comment
-// ;
+label1: for (;;) continue label1 // comment
+;
 
-// label1: for (;;) continue label1
-// // comment
-// ;
+label1: for (;;) continue label1
+// comment
+;
diff --git a/...er/tests/specs/prettier/js/for/continue-and-break-comment-without-blocks.js.prettier-snap b/...er/tests/specs/prettier/js/for/continue-and-break-comment-without-blocks.js.prettier-snap
@@ -58,7 +58,7 @@ for (const f in {}) continue;
 for (const f in {}) break;
 /* comment */
 
-label1: for (;;) continue label1 /* comment */;
+label1: for (;;) continue label1; /* comment */
 
 label1: for (;;) continue label1;
 /* comment */

diff --git a/...s_formatter/tests/specs/prettier/js/for/continue-and-break-comment-without-blocks.js.snap b/...s_formatter/tests/specs/prettier/js/for/continue-and-break-comment-without-blocks.js.snap
diff --git a/website/src/content/docs/internals/changelog.mdx b/website/src/content/docs/internals/changelog.mdx
@@ -24,6 +24,8 @@ Read our [guidelines for writing a good changelog entry](https://github.com/biom
 
 - Fix [#1508](https://github.com/biomejs/biome/issues/1508) by excluding deleted files from being processed. Contributed by @ematipico
 
+- Fix [#1173](https://github.com/biomejs/biome/issues/1173). Fix the formatting of a single instruction with commented in a control flow body to ensure consistency. Contributed by @mdm317
+
 ### Configuration
 
 ### Editors