fix(fmt): Preserve newlines in most parsers (a-h#374)

parser/v2/calltemplateparser.go

@@ -29,5 +29,10 @@ func (p callTemplateExpressionParser) Parse(pi *parse.Input) (n Node, ok bool, e
 		return
 	}
 
+	// Parse trailing whitespace.
+	if _, _, err := addTrailingSpace(&r, pi, true); err != nil {
+		return r, false, err
+	}
+
 	return r, true, nil
 }

parser/v2/calltemplateparser_test.go

@@ -76,6 +76,28 @@ func TestCallTemplateExpressionParser(t *testing.T) {
 				},
 			},
 		},
+		{
+			name:  "call: can parse the initial expression and leave the text",
+			input: `{!Other(p.Test)} Home`,
+			expected: CallTemplateExpression{
+				Expression: Expression{
+					Value: "Other(p.Test)",
+					Range: Range{
+						From: Position{
+							Index: 2,
+							Line:  0,
+							Col:   2,
+						},
+						To: Position{
+							Index: 15,
+							Line:  0,
+							Col:   15,
+						},
+					},
+				},
+				TrailingSpace: SpaceHorizontal,
+			},
+		},
 	}
 	for _, tt := range tests {
 		tt := tt

parser/v2/elementparser.go

@@ -467,12 +467,7 @@ func addTrailingSpaceAndValidate(start parse.Position, e Element, pi *parse.Inpu
 		return e, false, err
 	}
 	// Add trailing space.
-	ws, _, err := parse.Whitespace.Parse(pi)
-	if err != nil {
-		return e, false, err
-	}
-	e.TrailingSpace, err = NewTrailingSpace(ws, true)
-	if err != nil {
+	if _, _, err := addTrailingSpace(&e, pi, true); err != nil {
 		return e, false, err
 	}
 

parser/v2/forexpressionparser.go

@@ -10,7 +10,10 @@ var forExpression parse.Parser[Node] = forExpressionParser{}
 type forExpressionParser struct{}
 
 func (forExpressionParser) Parse(pi *parse.Input) (n Node, ok bool, err error) {
-	var r ForExpression
+	r := ForExpression{
+		// Default behavior is always a trailing space
+		TrailingSpace: SpaceVertical,
+	}
 	start := pi.Index()
 
 	// Strip leading whitespace and look for `for `.
@@ -48,5 +51,15 @@ func (forExpressionParser) Parse(pi *parse.Input) (n Node, ok bool, err error) {
 		return
 	}
 
+	// Parse trailing whitespace.
+	if _, _, err := addTrailingSpace(&r, pi, true); err != nil {
+		return r, false, err
+	}
+
+	// If the trailing space is not vertical, set it to vertical.
+	if r.TrailingSpace != SpaceVertical && r.TrailingSpace != SpaceVerticalDouble {
+		r.TrailingSpace = SpaceVertical
+	}
+
 	return r, true, nil
 }

parser/v2/forexpressionparser_test.go

@@ -64,6 +64,7 @@ func TestForExpressionParser(t *testing.T) {
 						TrailingSpace: SpaceVertical,
 					},
 				},
+				TrailingSpace: SpaceVertical,
 			},
 		},
 		{
@@ -117,6 +118,7 @@ func TestForExpressionParser(t *testing.T) {
 						TrailingSpace: SpaceVertical,
 					},
 				},
+				TrailingSpace: SpaceVertical,
 			},
 		},
 	}

parser/v2/formattestdata/calltemplate_newline_is_preserved.txt

@@ -0,0 +1,34 @@
+-- in --
+package main
+
+templ test() {
+	<span></span>
+
+
+	{! Other(p.Test) }
+	{!Other(p.Test)} Home
+
+	<div>Some standard templ</div>
+
+{!Other(p.Test) }
+
+
+
+	<span></span>
+
+}
+-- out --
+package main
+
+templ test() {
+	<span></span>
+
+	@Other(p.Test)
+	@Other(p.Test) Home
+	<div>Some standard templ</div>
+
+	@Other(p.Test)
+
+	<span></span>
+
+}

parser/v2/formattestdata/comments_newline_is_preserved.txt

@@ -0,0 +1,31 @@
+-- in --
+package main
+
+templ test() {
+	<!-- This is a comment -->
+
+	// This is not included in the output.
+	<div>Some standard templ</div>
+
+
+	/* This is not included in the output too. */
+	/*
+		Leave this alone.
+	*/
+
+
+}
+-- out --
+package main
+
+templ test() {
+	<!-- This is a comment -->
+
+	// This is not included in the output.
+	<div>Some standard templ</div>
+
+	/* This is not included in the output too. */
+	/*
+		Leave this alone.
+	*/
+}

parser/v2/formattestdata/for_loops_are_placed_on_a_new_line.txt

@@ -4,7 +4,7 @@ package test
 templ input(items []string) {
 <div>{ "the" }<div>{ "other" }</div>for _, item := range items {
 <div>{ item }</div>
-}</div>
+}<span>After closing bracket</span></div>
 }
 -- out --
 package test
@@ -16,5 +16,6 @@ templ input(items []string) {
 		for _, item := range items {
 			<div>{ item }</div>
 		}
+		<span>After closing bracket</span>
 	</div>
 }

parser/v2/formattestdata/for_loops_newline_is_preserved.txt

@@ -0,0 +1,33 @@
+-- in --
+package main
+
+templ x() {
+	<div>
+	<span></span>
+
+		for _, item := range items {
+
+			<div>{ item }</div>
+
+		}
+
+
+
+		<span>Foo Bar </span>
+	</div>
+}
+-- out --
+package main
+
+templ x() {
+	<div>
+		<span></span>
+
+		for _, item := range items {
+			<div>{ item }</div>
+
+		}
+
+		<span>Foo Bar </span>
+	</div>
+}

parser/v2/formattestdata/if_statement_newline_is_preserved.txt

@@ -0,0 +1,37 @@
+-- in --
+package main
+
+templ x() {
+	<div>
+	<span></span>
+
+	if true {
+					<span>Test</span>
+
+		} else {
+
+					<span>Test</span>
+			}
+
+
+
+		<span>Foo Bar </span>
+	</div>
+}
+-- out --
+package main
+
+templ x() {
+	<div>
+		<span></span>
+
+		if true {
+			<span>Test</span>
+
+		} else {
+			<span>Test</span>
+		}
+
+		<span>Foo Bar </span>
+	</div>
+}

parser/v2/formattestdata/if_statements_are_placed_on_a_new_line.txt

@@ -6,7 +6,7 @@ templ input(items []string) {
 <div>{ items[0] }</div>
 		} else {
 			<div>{ items[1] }</div>
-		}
+		} <span>After closing brace</span>
 </div>
 }
 -- out --
@@ -21,5 +21,6 @@ templ input(items []string) {
 		} else {
 			<div>{ items[1] }</div>
 		}
+		<span>After closing brace</span>
 	</div>
 }

parser/v2/formattestdata/switch_newline_is_preserved.txt

@@ -0,0 +1,43 @@
+-- in --
+package main
+
+templ x() {
+	<div>
+	<span></span>
+
+		switch items[0] {
+
+
+			case "a":
+				<div>{ items[0] }</div>
+
+
+			case "b":
+				<div>{ items[1] }</div>
+
+		}
+
+
+
+		<span>Foo Bar </span>
+	</div>
+}
+-- out --
+package main
+
+templ x() {
+	<div>
+		<span></span>
+
+		switch items[0] {
+			case "a":
+				<div>{ items[0] }</div>
+
+			case "b":
+				<div>{ items[1] }</div>
+
+		}
+
+		<span>Foo Bar </span>
+	</div>
+}

parser/v2/formattestdata/switch_statements_are_placed_on_a_new_line.txt

@@ -7,7 +7,7 @@ templ input(items []string) {
 <div>{ items[0] }</div>
 	case "b":
 <div>{ items[1] }</div>
-}</div>
+}<span>After closing bracket</span></div>
 }
 -- out --
 package test
@@ -22,5 +22,6 @@ templ input(items []string) {
 			case "b":
 				<div>{ items[1] }</div>
 		}
+		<span>After closing bracket</span>
 	</div>
 }

parser/v2/gocodeparser.go

@@ -32,12 +32,7 @@ var goCode = parse.Func(func(pi *parse.Input) (n Node, ok bool, err error) {
 	}
 
 	// Parse trailing whitespace.
-	ws, _, err := parse.Whitespace.Parse(pi)
-	if err != nil {
-		return r, false, err
-	}
-	r.TrailingSpace, err = NewTrailingSpace(ws, true)
-	if err != nil {
+	if _, _, err := addTrailingSpace(&r, pi, true); err != nil {
 		return r, false, err
 	}
 

parser/v2/htmlcommentparser.go

@@ -35,5 +35,10 @@ func (p htmlCommentParser) Parse(pi *parse.Input) (n Node, ok bool, err error) {
 		return
 	}
 
+	// Parse trailing whitespace.
+	if _, _, err := addTrailingSpace(&c, pi, true); err != nil {
+		return c, false, err
+	}
+
 	return c, true, nil
 }

parser/v2/ifexpressionparser.go

@@ -12,7 +12,10 @@ var untilElseIfElseOrEnd = parse.Any(StripType(elseIfExpression), StripType(else
 type ifExpressionParser struct{}
 
 func (ifExpressionParser) Parse(pi *parse.Input) (n Node, ok bool, err error) {
-	var r IfExpression
+	r := IfExpression{
+		// Default behavior is always a trailing space
+		TrailingSpace: SpaceVertical,
+	}
 	start := pi.Index()
 
 	if !peekPrefix(pi, "if ") {
@@ -60,6 +63,16 @@ func (ifExpressionParser) Parse(pi *parse.Input) (n Node, ok bool, err error) {
 		return
 	}
 
+	// Parse trailing whitespace.
+	if _, _, err := addTrailingSpace(&r, pi, true); err != nil {
+		return r, false, err
+	}
+
+	// If the trailing space is not vertical, set it to vertical.
+	if r.TrailingSpace != SpaceVertical && r.TrailingSpace != SpaceVerticalDouble {
+		r.TrailingSpace = SpaceVertical
+	}
+
 	return r, true, nil
 }