fix: escape non-standard characters in the filename path

cmd/generate/codeowners/output.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"sort"
 	"strings"
+	"regexp"
 
 	"github.com/open-sauced/pizza-cli/pkg/config"
 )
@@ -58,13 +59,13 @@ func writeGitHubCodeownersChunk(authorStats AuthorStats, config *config.Spec, fi
 	}
 
 	if len(topContributors) > 0 {
-		_, err := fmt.Fprintf(file, "%s @%s\n", srcFilename, strings.Join(resultSlice, " @"))
+		_, err := fmt.Fprintf(file, "%s @%s\n", cleanFilename(srcFilename), strings.Join(resultSlice, " @"))
 		if err != nil {
 			return nil, fmt.Errorf("error writing to %s file: %w", outputPath, err)
 		}
 	} else {
 		// no code owners to attribute to file
-		_, err := fmt.Fprintf(file, "%s\n", srcFilename)
+		_, err := fmt.Fprintf(file, "%s\n", cleanFilename(srcFilename))
 		if err != nil {
 			return nil, fmt.Errorf("error writing to %s file: %w", outputPath, err)
 		}
@@ -116,3 +117,13 @@ func getTopContributorAttributions(authorStats AuthorStats, n int, config *confi
 
 	return topContributors
 }
+
+func cleanFilename(filename string) string {
+	// Split the filename in case its rename, see https://github.com/open-sauced/pizza-cli/issues/101
+	parsedFilename := strings.Split(filename, " ")[0]
+	// Replace anything that is not a word, period, single quote, dash, space, forward slash, or backslash with an escaped version
+	re := regexp.MustCompile(`([^\w\.\'\-\s\/\\])`)
+	escapedFilename := re.ReplaceAllString(parsedFilename, "\\$0")
+
+	return escapedFilename
+}

cmd/generate/codeowners/output_test.go

@@ -0,0 +1,27 @@
+package codeowners
+
+import (
+		"testing"
+)
+
+func TestCleanFilename(testRunner *testing.T) {
+	var tests = []struct {
+		name string
+		input string
+		expected  string
+	}{
+			{"path/to/(home).go", "path/to/(home).go", `path/to/\(home\).go`},
+			{"path/to/[home].go", "path/to/[home].go", `path/to/\[home\].go`},
+			{"path/to/+page.go", "path/to/+page.go", `path/to/\+page.go`},
+			{"path/to/go-home.go", "path/to/go-home.go", `path/to/go-home.go`},
+	}
+
+	for _, testItem := range tests {
+		testRunner.Run(testItem.name, func(tester *testing.T) {
+			ans := cleanFilename(testItem.input)
+			if ans != testItem.expected {
+				tester.Errorf("got %s, expected %s", ans, testItem.expected)
+			}
+		})
+	}
+}