feat: add 'merge_request.modified_files_list(patterns...)' that return the list of files modified, matching the optional pattern(s)

Author: jippi

.scm-engine.example.yml

@@ -98,8 +98,7 @@ label:
     description: "Modified this a service directory"
     color: "$pink"
     script: >
-      map(merge_request.diff_stats, { .path })
-      | filter({ hasPrefix(#, "internal/service/") })
+      merge_request.modified_files_list("internal/service/")
       | map({ filepath_dir(#) })
       | map({ trimPrefix(#, "internal/") })
       | uniq()
@@ -113,8 +112,7 @@ label:
     description: "Modified this my-command command"
     color: "$purple"
     script: >
-      map(merge_request.diff_stats, { .path })
-      | filter({ hasPrefix(#, "internal/app/my-command/subcommands/") })
+      merge_request.modified_files_list("internal/app/my-command/subcommands/")
       | map({ filepath_dir(#) })
       | map({ trimPrefix(#, "internal/app/my-command/subcommands/") })
       | map({ string("command/" + #) })

README.md

@@ -468,7 +468,17 @@ Returns wether any of the provided files patterns have been modified in the Merg
 The file patterns use the [`.gitignore` format](https://git-scm.com/docs/gitignore#_pattern_format).
 
 ```expr
-merge_request.modified_files("*.go", "docs/")
+merge_request.modified_files("*.go", "docs/") == true
+```
+
+#### `merge_request.modified_files_list`
+
+Returns an array of files matching the provided (optional) pattern thas has been modified in the Merge Request.
+
+The file patterns use the [`.gitignore` format](https://git-scm.com/docs/gitignore#_pattern_format).
+
+```expr
+merge_request.modified_files_list("*.go", "docs/") == ["example/file.go", "docs/index.md"]
 ```
 
 #### `merge_request.has_label`

pkg/scm/gitlab/context_merge_request.go

@@ -17,10 +17,21 @@ func (e ContextMergeRequest) HasLabel(in string) bool {
 	return false
 }
 
+func (e ContextMergeRequest) ModifiedFilesList(patterns ...string) []string {
+	return e.findModifiedFiles(patterns...)
+}
+
 // Partially lifted from https://github.com/hmarr/codeowners/blob/main/match.go
 func (e ContextMergeRequest) ModifiedFiles(patterns ...string) bool {
+	return len(e.findModifiedFiles(patterns...)) > 0
+}
+
+// Partially lifted from https://github.com/hmarr/codeowners/blob/main/match.go
+func (e ContextMergeRequest) findModifiedFiles(patterns ...string) []string {
 	leftAnchoredLiteral := false
 
+	output := []string{}
+
 	for _, pattern := range patterns {
 		if !strings.ContainsAny(pattern, "*?\\") && pattern[0] == '/' {
 			leftAnchoredLiteral = true
@@ -31,6 +42,7 @@ func (e ContextMergeRequest) ModifiedFiles(patterns ...string) bool {
 			panic(err)
 		}
 
+	NEXT_FILE:
 		for _, changedFile := range e.DiffStats {
 			// Normalize Windows-style path separators to forward slashes
 			testPath := filepath.ToSlash(changedFile.Path)
@@ -45,27 +57,35 @@ func (e ContextMergeRequest) ModifiedFiles(patterns ...string) bool {
 
 				// If the pattern ends with a slash we can do a simple prefix match
 				if prefix[len(prefix)-1] == '/' && strings.HasPrefix(testPath, prefix) {
-					return true
+					output = append(output, testPath)
+
+					continue NEXT_FILE
 				}
 
 				// If the strings are the same length, check for an exact match
 				if len(testPath) == len(prefix) && testPath == prefix {
-					return true
+					output = append(output, testPath)
+
+					continue NEXT_FILE
 				}
 
 				// Otherwise check if the test path is a subdirectory of the pattern
 				if len(testPath) > len(prefix) && testPath[len(prefix)] == '/' && testPath[:len(prefix)] == prefix {
-					return true
+					output = append(output, testPath)
+
+					continue NEXT_FILE
 				}
 			}
 
 			if regex.MatchString(testPath) {
-				return true
+				output = append(output, testPath)
+
+				continue NEXT_FILE
 			}
 		}
 	}
 
-	return false
+	return output
 }
 
 // buildPatternRegex compiles a new regexp object from a gitignore-style pattern string