diff --git a/pkg/convert/tldr.go b/pkg/convert/tldr.go index 54dcde8..6bb85da 100644 --- a/pkg/convert/tldr.go +++ b/pkg/convert/tldr.go @@ -138,14 +138,14 @@ func substituteTldrPlaceholder(cmd, raw, name string) string { // var block reads top-to-bottom in source order. func classifyTldrPlaceholders(raws []string) []tldrPlaceholder { out := make([]tldrPlaceholder, 0, len(raws)) - nameCount := make(map[string]int) + used := make(map[string]bool) for _, raw := range raws { ph := classifyTldrPlaceholder(raw) - uniq := nameCount[ph.Name] - nameCount[ph.Name] = uniq + 1 - if uniq > 0 { - ph.Name = fmt.Sprintf("%s_%d", ph.Name, uniq+1) + base := ph.Name + for suffix := 2; used[ph.Name]; suffix++ { + ph.Name = fmt.Sprintf("%s_%d", base, suffix) } + used[ph.Name] = true out = append(out, ph) } return out diff --git a/pkg/convert/tldr_names_test.go b/pkg/convert/tldr_names_test.go new file mode 100644 index 0000000..5b38e29 --- /dev/null +++ b/pkg/convert/tldr_names_test.go @@ -0,0 +1,48 @@ +package convert + +import "testing" + +func TestConvertTldrGeneratedNamesStayUnique(t *testing.T) { + for _, tc := range []struct { + name, command, wantCommand, wantVars string + }{ + { + name: "natural suffix after collision", + command: "echo {{a-b}} {{a_b}} {{a_b_2}} {{a-b}}", + wantCommand: "echo $a_b $a_b_2 $a_b_2_2 $a_b", + wantVars: "var a_b = printf '%s\\n' 'a-b' --- --header \"a-b\"\n" + + "var a_b_2 = printf '%s\\n' 'a_b' --- --header \"a_b\"\n" + + "var a_b_2_2 = printf '%s\\n' 'a_b_2' --- --header \"a_b_2\"\n", + }, + { + name: "natural suffix before collision", + command: "echo {{a_b_2}} {{a_b}} {{a-b}} {{a_b_2}}", + wantCommand: "echo $a_b_2 $a_b $a_b_3 $a_b_2", + wantVars: "var a_b_2 = printf '%s\\n' 'a_b_2' --- --header \"a_b_2\"\n" + + "var a_b = printf '%s\\n' 'a_b' --- --header \"a_b\"\n" + + "var a_b_3 = printf '%s\\n' 'a-b' --- --header \"a-b\"\n", + }, + { + name: "multiple reserved suffixes", + command: "echo {{a-b}} {{a_b_2}} {{a_b_3}} {{a_b}} {{a_b}}", + wantCommand: "echo $a_b $a_b_2 $a_b_3 $a_b_4 $a_b_4", + wantVars: "var a_b = printf '%s\\n' 'a-b' --- --header \"a-b\"\n" + + "var a_b_2 = printf '%s\\n' 'a_b_2' --- --header \"a_b_2\"\n" + + "var a_b_3 = printf '%s\\n' 'a_b_3' --- --header \"a_b_3\"\n" + + "var a_b_4 = printf '%s\\n' 'a_b' --- --header \"a_b\"\n", + }, + } { + t.Run(tc.name, func(t *testing.T) { + input := "# echo\n- Print values:\n`" + tc.command + "`\n" + got, err := ConvertTldr(input, "echo.md") + if err != nil { + t.Fatal(err) + } + want := "# Converted TLDR for Echo\n\n## Print values\n\n```sh\n" + + tc.wantCommand + "\n```\n\n\n" + if got != want { + t.Fatalf("ConvertTldr() =\n%s\nwant:\n%s", got, want) + } + }) + } +}