grindlemire/go-tui: internal/formatter/formatter_comment_test.go

10.6 KB Go 631 lines 2026-03-21 · 158ef0a raw
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631


package formatter

import (
	"testing"
)

// TestFormatCommentLeading tests leading comment preservation.
func TestFormatCommentLeading(t *testing.T) {
	type tc struct {
		input string
		want  string
	}

	tests := map[string]tc{
		"leading comment before component": {
			input: `package main

// This is a doc comment
templ Hello() {
	<span>Hello</span>
}
`,
			want: `package main

// This is a doc comment
templ Hello() {
	<span>Hello</span>
}
`,
		},
		"leading comment before element": {
			input: `package main

templ Hello() {
	// Comment before element
	<span>Hello</span>
}
`,
			want: `package main

templ Hello() {
	// Comment before element
	<span>Hello</span>
}
`,
		},
		"leading comment before if": {
			input: `package main

templ Hello(show bool) {
	// Comment before if
	if show {
		<span>Hello</span>
	}
}
`,
			want: `package main

templ Hello(show bool) {
	// Comment before if
	if show {
		<span>Hello</span>
	}
}
`,
		},
		"leading comment before for": {
			input: `package main

templ Hello(items []string) {
	// Comment before for
	for _, item := range items {
		<span>{item}</span>
	}
}
`,
			want: `package main

templ Hello(items []string) {
	// Comment before for
	for _, item := range items {
		<span>{item}</span>
	}
}
`,
		},
		"leading block comment": {
			input: `package main

/* Block comment
   spanning multiple lines */
templ Hello() {
	<span>Hello</span>
}
`,
			want: `package main

/*
Block comment
spanning multiple lines
*/
templ Hello() {
	<span>Hello</span>
}
`,
		},
		"leading comment before package": {
			input: `// File-level comment
package main

templ Hello() {
	<span>Hello</span>
}
`,
			want: `// File-level comment
package main

templ Hello() {
	<span>Hello</span>
}
`,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()
			got, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("Format() error = %v", err)
			}
			if got != tt.want {
				t.Errorf("Format() mismatch:\ngot:\n%s\nwant:\n%s", got, tt.want)
			}
		})
	}
}

// TestFormatCommentTrailing tests trailing comment preservation.
func TestFormatCommentTrailing(t *testing.T) {
	type tc struct {
		input string
		want  string
	}

	tests := map[string]tc{
		"trailing comment on element": {
			input: `package main

templ Hello() {
	<span>Hello</span>  // trailing
}
`,
			want: `package main

templ Hello() {
	<span>Hello</span>  // trailing
}
`,
		},
		"trailing comment on self-closing element": {
			input: `package main

templ Hello() {
	<hr />  // divider
}
`,
			want: `package main

templ Hello() {
	<hr />  // divider
}
`,
		},
		// Note: import trailing comments are attached to the next declaration
		// by the parser, so we skip this test for now.
		// "trailing comment on import": { ... }
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()
			got, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("Format() error = %v", err)
			}
			if got != tt.want {
				t.Errorf("Format() mismatch:\ngot:\n%s\nwant:\n%s", got, tt.want)
			}
		})
	}
}

// TestFormatCommentOrphan tests orphan comment preservation.
func TestFormatCommentOrphan(t *testing.T) {
	type tc struct {
		input string
		want  string
	}

	tests := map[string]tc{
		"orphan comment in component body": {
			input: `package main

templ Hello() {
	// orphan comment in body
	<span>Hello</span>
}
`,
			want: `package main

templ Hello() {
	// orphan comment in body
	<span>Hello</span>
}
`,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()
			got, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("Format() error = %v", err)
			}
			if got != tt.want {
				t.Errorf("Format() mismatch:\ngot:\n%s\nwant:\n%s", got, tt.want)
			}
		})
	}
}

// TestFormatCommentRoundTrip tests format idempotency with comments.
func TestFormatCommentRoundTrip(t *testing.T) {
	type tc struct {
		input string
	}

	tests := map[string]tc{
		"file with leading comments": {
			input: `// File comment
package main

// Doc comment
templ Hello() {
	<span>Hello</span>
}
`,
		},
		"file with trailing comments": {
			input: `package main

templ Hello() {
	<span>Hello</span>  // inline
}
`,
		},
		"complex file with many comments": {
			input: `// File comment
package main

import "fmt"

// Header component
templ Header(title string) {
	// Container
	<div class="header">
		<span>{title}</span>  // title text
	</div>
}
`,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()

			// First format
			first, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("First Format() error = %v", err)
			}

			// Second format (should be identical)
			second, err := fmtr.Format("test.gsx", first)
			if err != nil {
				t.Fatalf("Second Format() error = %v", err)
			}

			if first != second {
				t.Errorf("Round-trip failed:\nfirst:\n%s\nsecond:\n%s", first, second)
			}
		})
	}
}

// TestFormatCommentGroupSeparation tests that blank lines between comment groups are preserved.
func TestFormatCommentGroupSeparation(t *testing.T) {
	type tc struct {
		input string
		want  string
	}

	tests := map[string]tc{
		"preserve blank line between comment groups": {
			input: `package main

// Unassigned block comment
// For package comment

// ItemList test
templ Hello() {
	<span>Hello</span>
}
`,
			want: `package main

// Unassigned block comment
// For package comment

// ItemList test
templ Hello() {
	<span>Hello</span>
}
`,
		},
		"preserve blank line inside component": {
			input: `package main

templ Hello() {
	// First comment

	// Second comment
	<span>Hello</span>
}
`,
			want: `package main

templ Hello() {
	// First comment

	// Second comment
	<span>Hello</span>
}
`,
		},
		"no blank line when comments are adjacent": {
			input: `package main

// First comment
// Second comment
templ Hello() {
	<span>Hello</span>
}
`,
			want: `package main

// First comment
// Second comment
templ Hello() {
	<span>Hello</span>
}
`,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()
			got, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("Format() error = %v", err)
			}
			if got != tt.want {
				t.Errorf("Format() mismatch:\ngot:\n%s\nwant:\n%s", got, tt.want)
			}
		})
	}
}

// TestFormatLineCommentSpacing tests proper spacing after // in line comments.
func TestFormatLineCommentSpacing(t *testing.T) {
	type tc struct {
		input string
		want  string
	}

	tests := map[string]tc{
		"missing space after //": {
			input: `package main

//comment without space
templ Hello() {
	<span>Hello</span>
}
`,
			want: `package main

// comment without space
templ Hello() {
	<span>Hello</span>
}
`,
		},
		"already has space": {
			input: `package main

// comment with space
templ Hello() {
	<span>Hello</span>
}
`,
			want: `package main

// comment with space
templ Hello() {
	<span>Hello</span>
}
`,
		},
		"trailing comment missing space": {
			input: `package main

templ Hello() {
	<span>Hello</span>  //trailing
}
`,
			want: `package main

templ Hello() {
	<span>Hello</span>  // trailing
}
`,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()
			got, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("Format() error = %v", err)
			}
			if got != tt.want {
				t.Errorf("Format() mismatch:\ngot:\n%s\nwant:\n%s", got, tt.want)
			}
		})
	}
}

// TestFormatInlineBlockComment tests proper formatting of inline block comments.
func TestFormatInlineBlockComment(t *testing.T) {
	type tc struct {
		input string
		want  string
	}

	tests := map[string]tc{
		"missing space before closing": {
			input: `package main

import "fmt"

templ Hello(item string) {
	<span>{fmt.Sprintf("> %s", /* ItemList item*/ item)}</span>
}
`,
			want: `package main

import "fmt"

templ Hello(item string) {
	<span>{fmt.Sprintf("> %s", /* ItemList item */ item)}</span>
}
`,
		},
		"missing space after opening": {
			input: `package main

templ Hello(x int) {
	<span>{/*test*/ x}</span>
}
`,
			want: `package main

templ Hello(x int) {
	<span>{/* test */ x}</span>
}
`,
		},
		"missing both spaces": {
			input: `package main

templ Hello(x int) {
	<span>{/*test comment*/ x}</span>
}
`,
			want: `package main

templ Hello(x int) {
	<span>{/* test comment */ x}</span>
}
`,
		},
		"already properly formatted": {
			input: `package main

templ Hello(x int) {
	<span>{/* test */ x}</span>
}
`,
			want: `package main

templ Hello(x int) {
	<span>{/* test */ x}</span>
}
`,
		},
		"empty block comment": {
			input: `package main

templ Hello(x int) {
	<span>{/**/ x}</span>
}
`,
			want: `package main

templ Hello(x int) {
	<span>{/* */ x}</span>
}
`,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()
			got, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("Format() error = %v", err)
			}
			if got != tt.want {
				t.Errorf("Format() mismatch:\ngot:\n%s\nwant:\n%s", got, tt.want)
			}
		})
	}
}

// TestFormatCommentComplex tests complex scenarios with comments at all positions.
func TestFormatCommentComplex(t *testing.T) {
	type tc struct {
		input string
		want  string
	}

	tests := map[string]tc{
		"comments at various positions": {
			// Note: The parser attaches comments before import to the following component,
			// so we adjust our test to not have a comment immediately before import.
			input: `// File-level comment
package main

import "fmt"

// Main component documentation
// Multiple lines
templ Main(items []string, selected int) {
	// Container div
	<div class="main">
		// Loop through items
		for i, item := range items {
			// Conditional rendering
			if i == selected {
				<span class="selected">{item}</span>
			} else {
				<span>{item}</span>
			}
		}
	</div>
}

// Helper function
func helper(s string) string {
	return fmt.Sprintf("[%s]", s)
}
`,
			want: `// File-level comment
package main

import "fmt"

// Main component documentation
// Multiple lines
templ Main(items []string, selected int) {
	// Container div
	<div class="main">
		// Loop through items
		for i, item := range items {
			// Conditional rendering
			if i == selected {
				<span class="selected">{item}</span>
			} else {
				<span>{item}</span>
			}
		}
	</div>
}

// Helper function
func helper(s string) string {
	return fmt.Sprintf("[%s]", s)
}
`,
		},
	}

	for name, tt := range tests {
		t.Run(name, func(t *testing.T) {
			fmtr := newTestFormatter()
			got, err := fmtr.Format("test.gsx", tt.input)
			if err != nil {
				t.Fatalf("Format() error = %v", err)
			}
			if got != tt.want {
				t.Errorf("Format() mismatch:\ngot:\n%s\nwant:\n%s", got, tt.want)
			}
		})
	}
}
grindlemire/go-tui code browser
