fix: the last line of block comment doesn't converge

Enter-tainer · Oct 7, 2024 · dbe4418 · dbe4418
1 parent faf0caa
commit dbe4418
Show file tree

Hide file tree

Showing 11 changed files with 177 additions and 28 deletions.
diff --git a/src/pretty/func_call.rs b/src/pretty/func_call.rs
@@ -2,7 +2,7 @@ use itertools::Itertools;
 use pretty::BoxDoc;
 use typst_syntax::{ast::*, SyntaxKind, SyntaxNode};
 
-use crate::{pretty::trivia, util::FoldStyle, PrettyPrinter};
+use crate::{util::FoldStyle, PrettyPrinter};
 
 use super::{
     table,
@@ -76,7 +76,7 @@ impl<'a> ParenthesizedFuncCallArg<'a> {
                 inner
             }
             ParenthesizedFuncCallArg::LineComment(comment)
-            | ParenthesizedFuncCallArg::BlockComment(comment) => trivia(comment),
+            | ParenthesizedFuncCallArg::BlockComment(comment) => super::comment(comment),
         }
     }
 }

diff --git a/src/pretty/mod.rs b/src/pretty/mod.rs
@@ -105,7 +105,7 @@ impl PrettyPrinter {
                     let expr_doc = self.convert_expr(expr);
                     doc = doc.append(expr_doc);
                 } else {
-                    doc = doc.append(trivia(node));
+                    doc = doc.append(comment(node));
                 }
             }
         }
@@ -464,12 +464,9 @@ impl PrettyPrinter {
             {
                 if !codes.is_empty() && is_attached_comment(i) {
                     let last = codes.pop().unwrap();
-                    codes.push(
-                        last.append(BoxDoc::space())
-                            .append(to_doc(std::borrow::Cow::Borrowed(node.text()), true)),
-                    );
+                    codes.push(last.append(BoxDoc::space()).append(comment(node)));
                 } else {
-                    codes.push(to_doc(std::borrow::Cow::Borrowed(node.text()), true));
+                    codes.push(comment(node));
                 }
             } else if node.kind() == SyntaxKind::Space {
                 let newline_cnt = node.text().chars().filter(|c| *c == '\n').count();
@@ -815,10 +812,10 @@ impl PrettyPrinter {
                 doc = doc.append(BoxDoc::text("else"));
                 doc = doc.append(BoxDoc::space());
             } else if child.kind() == SyntaxKind::BlockComment {
-                doc = doc.append(trivia(child));
+                doc = doc.append(comment(child));
                 doc = doc.append(BoxDoc::space());
             } else if child.kind() == SyntaxKind::LineComment {
-                doc = doc.append(trivia(child));
+                doc = doc.append(comment(child));
                 doc = doc.append(BoxDoc::hardline());
             } else {
                 match expr_type {
@@ -862,10 +859,10 @@ impl PrettyPrinter {
                 doc = doc.append(BoxDoc::text("while"));
                 doc = doc.append(BoxDoc::space());
             } else if child.kind() == SyntaxKind::BlockComment {
-                doc = doc.append(trivia(child));
+                doc = doc.append(comment(child));
                 doc = doc.append(BoxDoc::space());
             } else if child.kind() == SyntaxKind::LineComment {
-                doc = doc.append(trivia(child));
+                doc = doc.append(comment(child));
                 doc = doc.append(BoxDoc::hardline());
             } else if let Some(expr) = child.cast() {
                 doc = doc.append(self.convert_expr(expr));
@@ -1069,22 +1066,44 @@ impl PrettyPrinter {
     }
 }
 
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum StripMode {
+    None,
+    Prefix,
+    PrefixOnBoundaryMarkers,
+}
+
 fn trivia(node: &SyntaxNode) -> BoxDoc<'_, ()> {
-    to_doc(std::borrow::Cow::Borrowed(node.text()), false)
+    to_doc(std::borrow::Cow::Borrowed(node.text()), StripMode::None)
+}
+
+fn comment(node: &SyntaxNode) -> BoxDoc<'_, ()> {
+    to_doc(std::borrow::Cow::Borrowed(node.text()), StripMode::Prefix)
 }
 
-pub fn to_doc(s: Cow<'_, str>, strip_prefix: bool) -> BoxDoc<'_, ()> {
-    let get_line = |s: &str| {
-        if strip_prefix {
-            s.trim_start().to_string()
+pub fn to_doc(s: Cow<'_, str>, strip_prefix: StripMode) -> BoxDoc<'_, ()> {
+    let get_line = |i: itertools::Position, line: &str| {
+        let should_trim = matches!(strip_prefix, StripMode::Prefix)
+            || (matches!(strip_prefix, StripMode::PrefixOnBoundaryMarkers)
+                && matches!(
+                    i,
+                    itertools::Position::First
+                        | itertools::Position::Last
+                        | itertools::Position::Only
+                ));
+
+        if should_trim {
+            line.trim_start().to_string()
         } else {
-            s.to_string()
+            line.to_string()
         }
     };
     // String::lines() doesn't include the trailing newline
     let has_trailing_newline = s.ends_with('\n');
     let res = BoxDoc::intersperse(
-        s.lines().map(|s| BoxDoc::text(get_line(s))),
+        s.lines()
+            .with_position()
+            .map(|(i, s)| BoxDoc::text(get_line(i, s))),
         BoxDoc::hardline(),
     );
     if has_trailing_newline {
@@ -1109,7 +1128,7 @@ mod tests {
             "123\n4568\n789\n",
         ];
         for test in tests.into_iter() {
-            insta::assert_debug_snapshot!(to_doc(test.into(), false));
+            insta::assert_debug_snapshot!(to_doc(test.into(), StripMode::None));
         }
     }
 

diff --git a/tests/assets/unit/comment/comment-convergence.typ b/tests/assets/unit/comment/comment-convergence.typ
@@ -0,0 +1,22 @@
+#[
+  /* bar
+  */
+]
+
+-   /* bar
+   */ 123
+
+- /* bar
+   */
+
+#[
+  /* Somebody write this up:
+   - 1000 participants.
+   - 2x2 data design. */
+]
+
+#[
+  // Somebody write this up:
+  //  - 1000 participants.
+  //  - 2x2 data design.
+]
diff --git a/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-0.snap b/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-0.snap
@@ -5,8 +5,8 @@ input_file: tests/assets/unit/comment/block-comment.typ
 ---
 Our study design is as follows:
 /* Somebody write this up:
-   - 1000 participants.
-   - 2x2 data design. */
+- 1000 participants.
+- 2x2 data design. */
 
 #if draw-edge == auto {
   draw-edge = (

diff --git a/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-120.snap b/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-120.snap
@@ -5,8 +5,8 @@ input_file: tests/assets/unit/comment/block-comment.typ
 ---
 Our study design is as follows:
 /* Somebody write this up:
-   - 1000 participants.
-   - 2x2 data design. */
+- 1000 participants.
+- 2x2 data design. */
 
 #if draw-edge == auto {
   draw-edge = (

diff --git a/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-40.snap b/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-40.snap
@@ -5,8 +5,8 @@ input_file: tests/assets/unit/comment/block-comment.typ
 ---
 Our study design is as follows:
 /* Somebody write this up:
-   - 1000 participants.
-   - 2x2 data design. */
+- 1000 participants.
+- 2x2 data design. */
 
 #if draw-edge == auto {
   draw-edge = (

diff --git a/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-80.snap b/tests/snapshots/assets__check_file@unit-comment-block-comment.typ-80.snap
@@ -5,8 +5,8 @@ input_file: tests/assets/unit/comment/block-comment.typ
 ---
 Our study design is as follows:
 /* Somebody write this up:
-   - 1000 participants.
-   - 2x2 data design. */
+- 1000 participants.
+- 2x2 data design. */
 
 #if draw-edge == auto {
   draw-edge = (

diff --git a/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-0.snap b/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-0.snap
@@ -0,0 +1,27 @@
+---
+source: tests/assets.rs
+expression: doc_string
+input_file: tests/assets/unit/comment/comment-convergence.typ
+---
+#[
+  /* bar
+  */
+]
+
+-   /* bar
+   */ 123
+
+- /* bar
+   */
+
+#[
+  /* Somebody write this up:
+  - 1000 participants.
+  - 2x2 data design. */
+]
+
+#[
+  // Somebody write this up:
+  //  - 1000 participants.
+  //  - 2x2 data design.
+]
diff --git a/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-120.snap b/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-120.snap
@@ -0,0 +1,27 @@
+---
+source: tests/assets.rs
+expression: doc_string
+input_file: tests/assets/unit/comment/comment-convergence.typ
+---
+#[
+  /* bar
+  */
+]
+
+-   /* bar
+   */ 123
+
+- /* bar
+   */
+
+#[
+  /* Somebody write this up:
+  - 1000 participants.
+  - 2x2 data design. */
+]
+
+#[
+  // Somebody write this up:
+  //  - 1000 participants.
+  //  - 2x2 data design.
+]
diff --git a/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-40.snap b/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-40.snap
@@ -0,0 +1,27 @@
+---
+source: tests/assets.rs
+expression: doc_string
+input_file: tests/assets/unit/comment/comment-convergence.typ
+---
+#[
+  /* bar
+  */
+]
+
+-   /* bar
+   */ 123
+
+- /* bar
+   */
+
+#[
+  /* Somebody write this up:
+  - 1000 participants.
+  - 2x2 data design. */
+]
+
+#[
+  // Somebody write this up:
+  //  - 1000 participants.
+  //  - 2x2 data design.
+]
diff --git a/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-80.snap b/tests/snapshots/assets__check_file@unit-comment-comment-convergence.typ-80.snap
@@ -0,0 +1,27 @@
+---
+source: tests/assets.rs
+expression: doc_string
+input_file: tests/assets/unit/comment/comment-convergence.typ
+---
+#[
+  /* bar
+  */
+]
+
+-   /* bar
+   */ 123
+
+- /* bar
+   */
+
+#[
+  /* Somebody write this up:
+  - 1000 participants.
+  - 2x2 data design. */
+]
+
+#[
+  // Somebody write this up:
+  //  - 1000 participants.
+  //  - 2x2 data design.
+]