feat: add support for MATCHED_FILES and PACKAGE_FILES step argument

docs/reference.md

@@ -76,10 +76,14 @@ A set of arguments is provided by Mookme, that can be directly used in the hooks
 
 ````json title="hooks/commit-msg.json"
 {
-    "command": "run-something $1" // Will be replaced with the value of `args`
+    "command": "run-something $1" // (1)!
+    "command": "run-something $MATCHED_FILES" // (2)!
+    "command": "run-something $PACKAGE_FILES" // (3)!
 }
 ````
 
-- `$1`
+1. The argument being passed by git to the hook file. See [the Git documentation on the hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for more details about what it contains depending on the hook type being executed.
 
-The argument being passed by git to the hook file. See [the Git documentation on the hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) for more details about what it contains depending on the hook type being executed.
+2. The list of changed files matched by the onlyOn option of this step, separated by a space. If the onlyOn option is not set, it will be replaced with an empty string.
+
+3. The list of changed files in the package folder, separated by a space.

mkdocs.yml

@@ -17,6 +17,7 @@ theme:
 
   features:
     - content.tabs.link
+    - content.code.annotate
 
   palette:
     - media: "(prefers-color-scheme)"

packages/configuration/hook.go

@@ -49,5 +49,6 @@ var ALL_HOOKS_STRING = []string{
 
 type Hook struct {
 	Path  string
+	Files []string
 	Steps []Step
 }

packages/configuration/loader.go

@@ -162,13 +162,15 @@ func LoadHooksConfiguration(directory string, hookType HookType) ([]Hook, error)
 					OnlyOn:              step.OnlyOn,
 					From:                step.From,
 					ID:                  uuid.NewString(),
+					Files:               make([]string, 0),
 				})
 			}
 
 		}
 
 		hooks = append(hooks, Hook{
 			Path:  filepath.Dir(filepath.Dir(path)),
+			Files: make([]string, 0),
 			Steps: steps,
 		})
 	}

packages/configuration/step.go

@@ -29,4 +29,5 @@ type Step struct {
 	Serial              bool
 	From                *string
 	PackageRelativePath string
+	Files               []string
 }

packages/executor/executor.go

@@ -150,6 +150,9 @@ func (h *HookExecutor) RunStep(step *configuration.Step) {
 	h.onStepStatusChange(step, StepExecutionStatusRunning)
 
 	cmd := strings.ReplaceAll(step.Command, "$1", strings.Join(h.gitCommandArguments, " "))
+	cmd = strings.ReplaceAll(cmd, "$MATCHED_FILES", strings.Join(step.Files, " "))
+	cmd = strings.ReplaceAll(cmd, "$PACKAGE_FILES", strings.Join(h.hook.Files, ""))
+
 	command := exec.Command("sh", "-c", cmd)
 	command.Dir = h.hook.Path
 

packages/meta/version.go

@@ -1,3 +1,3 @@
 package meta
 
-const GOOKME_CLI_VERSION = "0.4.0"
+const GOOKME_CLI_VERSION = "0.5.0"

packages/scheduler/scheduler.go

@@ -60,8 +60,9 @@ func FilterHooksWithChangeset(
 	// If the hook is not in the changeset, skip it
 
 	for _, hook := range hooks {
-		matchedPaths := filterChangesetWithPrefix(changedPaths, hook.Path)
-		if len(matchedPaths) > 0 {
+		hook.Files = append(hook.Files, filterChangesetWithPrefix(changedPaths, hook.Path)...)
+
+		if len(hook.Files) > 0 {
 			filtered = append(filtered, hook)
 		} else {
 			logger.Debugf("Hook %s did not match any file, dropping", hook.Path)
@@ -97,8 +98,9 @@ func FilterStepsWithOnlyOn(
 			if err != nil {
 				continue
 			}
+			step.Files = append(step.Files, changedPathsWithPattern...)
 
-			if len(changedPathsWithPattern) > 0 {
+			if len(step.Files) > 0 {
 				steps = append(steps, step)
 			} else {
 				logger.Debugf("Step %s:%s did not match any file using pattern %s, dropping", step.PackageRelativePath, step.Name, *onlyOn)