feat(path): allow cross platform pattern matching

resolves #6166

Author: JanDeDobbeleer

Diff for: src/segments/path.go

@@ -619,14 +619,16 @@ func (pt *Path) replaceMappedLocations(inputPath string) (string, string) {
 
 	for _, key := range keys {
 		if strings.HasPrefix(key, regexPrefix) {
-			match, OK := regex.FindStringMatch(key[len(regexPrefix):], inputPath, 1)
+			input := strings.ReplaceAll(inputPath, `\`, `/`)
+			match, OK := regex.FindStringMatch(key[len(regexPrefix):], input, 1)
 			if !OK {
 				continue
 			}
 
 			// Replace the first match with the mapped location.
-			inputPath = strings.Replace(inputPath, match, pt.mappedLocations[key], 1)
-			return pt.parsePath(inputPath)
+			input = strings.Replace(input, match, pt.mappedLocations[key], 1)
+			input = path.Clean(input)
+			return pt.parsePath(input)
 		}
 
 		keyRoot, keyRelative := pt.parsePath(key)

Diff for: src/segments/path_windows_test.go

@@ -420,9 +420,34 @@ var testFullAndFolderPathCases = []testFullAndFolderPathCase{
 }
 
 var testFullPathCustomMappedLocationsCases = []testFullPathCustomMappedLocationsCase{
-	{Pwd: `\a\b\c\d`, MappedLocations: map[string]string{`\a\b`: "#"}, GOOS: runtime.WINDOWS, PathSeparator: `\`, Expected: `#\c\d`},
-	{Pwd: `\a\b\1234\d\e`, MappedLocations: map[string]string{`re:(\\a\\b\\[0-9]+\\d).*`: "#"}, GOOS: runtime.WINDOWS, PathSeparator: `\`, Expected: `#\e`},
-	{Pwd: `\a\b\1234\f\e`, MappedLocations: map[string]string{`re:(\\a\\b\\[0-9]+\\d).*`: "#"}, GOOS: runtime.WINDOWS, PathSeparator: `\`, Expected: `\a\b\1234\f\e`},
+	{
+		Pwd:             `\a\b\c\d`,
+		MappedLocations: map[string]string{`\a\b`: "#"},
+		GOOS:            runtime.WINDOWS,
+		PathSeparator:   `\`,
+		Expected:        `#\c\d`,
+	},
+	{
+		Pwd:             `\a\b\1234\d\e`,
+		MappedLocations: map[string]string{`re:(/a/b/[0-9]+/d).*`: "#"},
+		GOOS:            runtime.WINDOWS,
+		PathSeparator:   `\`,
+		Expected:        `#\e`,
+	},
+	{
+		Pwd:             `\a\b\1234\f\e`,
+		MappedLocations: map[string]string{`re:(/a/b/[0-9]+/d).*`: "#"},
+		GOOS:            runtime.WINDOWS,
+		PathSeparator:   `\`,
+		Expected:        `\a\b\1234\f\e`,
+	},
+	{
+		Pwd:             `C:\Users\taylo\Documents\GitHub\project`,
+		MappedLocations: map[string]string{`re:(.*Users/taylo/Documents/GitHub).*`: "github"},
+		GOOS:            runtime.WINDOWS,
+		PathSeparator:   `\`,
+		Expected:        `github\project`,
+	},
 }
 
 var testSplitPathCases = []testSplitPathCase{

Diff for: website/docs/segments/system/path.mdx

@@ -88,8 +88,8 @@ For example, to swap out `C:\Users\Leet\GitHub` with a GitHub icon, you can do t
   user Bill, who has a user account `Bill` on Windows and `bill` on Linux, `~/Foo` might match
   `C:\Users\Bill\Foo` or `C:\Users\Bill\foo` on Windows but only `/home/bill/Foo` on Linux.
 - For more complicated cases, you can use the `re:` prefix to use a regular expression with a capture group for matching.
-  For example, `"re:(C:\\[0-9]+\\Foo).*": "#"` will match `C:\123\Foo\Bar` and replace it with `#\Bar`. The regex is not
-  cross platform out of the box, unlike the first statement for non-regex matches.
+  For example, `"re:(C:/[0-9]+/Foo).*": "#"` will match `C:\123\Foo\Bar` and replace it with `#\Bar`. The path used for matching
+  will always use `/`, regardless of the operating system, allowing cross platform matching.
 
 ## Style