Merge pull request #1 from thecodesmith/copilot/implement-escaping-special-characters

thecodesmith · web-flow · commit 91be5a5548ab · 2026-03-12T16:44:04.000-05:00
fix(cobra): escape newlines, tabs, and carriage returns in kdlQuoteAlways
diff --git a/integrations/cobra/cobra_usage_test.go b/integrations/cobra/cobra_usage_test.go
@@ -313,6 +313,75 @@ func TestStringDefaultZero(t *testing.T) {
 	assertContains(t, got, `default="0"`)
 }
 
+func TestSpecialCharacterEscaping(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    string
+		expected string
+	}{
+		{
+			name:     "newline in help",
+			input:    "Line one\nLine two",
+			expected: `"Line one\nLine two"`,
+		},
+		{
+			name:     "tab in help",
+			input:    "col1\tcol2",
+			expected: `"col1\tcol2"`,
+		},
+		{
+			name:     "carriage return in help",
+			input:    "text\rmore",
+			expected: `"text\rmore"`,
+		},
+		{
+			name:     "backslash in help",
+			input:    `path\to\file`,
+			expected: `"path\\to\\file"`,
+		},
+		{
+			name:     "double quote in help",
+			input:    `say "hello"`,
+			expected: `"say \"hello\""`,
+		},
+		{
+			name:     "mixed special characters",
+			input:    "line1\nline2\ttab\r\nwindows",
+			expected: `"line1\nline2\ttab\r\nwindows"`,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := kdlQuoteAlways(tt.input)
+			if got != tt.expected {
+				t.Errorf("kdlQuoteAlways(%q) = %q, want %q", tt.input, got, tt.expected)
+			}
+		})
+	}
+}
+
+func TestNewlineInCommandHelp(t *testing.T) {
+	root := &cobra.Command{
+		Use:   "app",
+		Short: "Short help",
+		Long:  "First line.\nSecond line.\n\nThird paragraph.",
+	}
+
+	got := Generate(root)
+
+	assertContains(t, got, `long_about "First line.\nSecond line.\n\nThird paragraph."`)
+}
+
+func TestSpecialCharsInFlagHelp(t *testing.T) {
+	cmd := &cobra.Command{Use: "app"}
+	cmd.Flags().String("format", "", "Output format:\n  json\n  yaml")
+
+	got := Generate(cmd)
+
+	assertContains(t, got, `help="Output format:\n  json\n  yaml"`)
+}
+
 // --- helpers ---
 
 func assertContains(t *testing.T, got, want string) {
diff --git a/integrations/cobra/kdl.go b/integrations/cobra/kdl.go
@@ -303,6 +303,9 @@ func kdlQuote(s string) string {
 func kdlQuoteAlways(s string) string {
 	s = strings.ReplaceAll(s, `\`, `\\`)
 	s = strings.ReplaceAll(s, `"`, `\"`)
+	s = strings.ReplaceAll(s, "\n", `\n`)
+	s = strings.ReplaceAll(s, "\t", `\t`)
+	s = strings.ReplaceAll(s, "\r", `\r`)
 	return `"` + s + `"`
 }
 

Original file line number	Diff line number	Diff line change
`@@ -303,6 +303,9 @@ func kdlQuote(s string) string {`
`303`	`303`	`func kdlQuoteAlways(s string) string {`
`304`	`304`	s = strings.ReplaceAll(s, `\`, `\\`)
`305`	`305`	s = strings.ReplaceAll(s, `"`, `\"`)
	`306`	+ s = strings.ReplaceAll(s, "\n", `\n`)
	`307`	+ s = strings.ReplaceAll(s, "\t", `\t`)
	`308`	+ s = strings.ReplaceAll(s, "\r", `\r`)
`306`	`309`	return `"` + s + `"`
`307`	`310`	`}`
`308`	`311`