Preserve trailing comments. Fixes #38.

Also eliminate useless trailing space after `:` when the node has no `name`.
cucumber · Oct 15, 2023 · 85eb3aa · 85eb3aa
1 parent c1543e6
commit 85eb3aa
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 1 deletion.
diff --git a/javascript/src/pretty.ts b/javascript/src/pretty.ts
@@ -93,7 +93,8 @@ function prettyKeywordContainer(
     .concat(prettyTags(tags, syntax, level))
     .concat(keywordPrefix(level, syntax))
     .concat(stepContainer.keyword)
-    .concat(': ')
+    .concat(':')
+    .concat(stepContainer.name ? ' ' : '')
     .concat(stepContainer.name)
     .concat('\n')
     .concat(description)

diff --git a/javascript/src/walkGherkinDocument.ts b/javascript/src/walkGherkinDocument.ts
@@ -41,6 +41,7 @@ export function walkGherkinDocument<Acc>(
       }
     }
   }
+  acc = walkComments(popRemainingContents(), acc);
   return acc
 
   function walkComments(comments: readonly messages.Comment[], acc: Acc): Acc {
@@ -114,6 +115,10 @@ export function walkGherkinDocument<Acc>(
     }
     return commentsStack.splice(0, count)
   }
+
+  function popRemainingContents(): readonly messages.Comment[] {
+    return commentsStack.splice(0, commentsStack.length)
+  }
 }
 
 

diff --git a/javascript/test/prettyTest.ts b/javascript/test/prettyTest.ts
@@ -190,6 +190,24 @@ Feature: hello
 `)
   })
 
+  it('renders trailing comments', () => {
+    checkGherkinToAstToGherkin(`# one
+Feature: hello
+
+  Scenario: one
+    # one
+    Given a doc string:
+      """
+      a
+      \\"\\"\\"
+      b
+      """
+      # two
+  # three
+# four
+`)
+  });
+
   it('renders descriptions when set', () => {
     checkGherkinToAstToGherkin(`Feature: hello
   So this is a feature