feat: add stage_fixed option (#445)

docs/configuration.md

@@ -32,13 +32,15 @@
   - [`root`](#root)
   - [`exclude`](#exclude)
   - [`fail_text`](#fail_text)
+  - [`stage_fixed`](#stage_fixed)
   - [`interactive`](#interactive)
 - [Script](#script)
   - [`runner`](#runner)
   - [`skip`](#skip)
   - [`tags`](#tags)
   - [`env`](#env)
   - [`fail_text`](#fail_text)
+  - [`stage_fixed`](#stage_fixed)
   - [`interactive`](#interactive)
 - [Examples](#examples)
 - [More info](#more-info)
@@ -901,6 +903,26 @@ SUMMARY: (done in 0.01 seconds)
 🥊  lint: Add node executable to $PATH env
 ```
 
+### `stage_fixed`
+
+**Default: `false`**
+
+> Used **only for `pre-commit`** hook. Is ignored for other hooks.
+
+When set to `true` lefthook will automatically call `git add` on files after running the command or script. For a command if [`files`](#files) option was specified, the specified command will be used to retrieve files for `git add`. For scripts and commands without [`files`](#files) option `{staged_files}` template will be used. All filters ([`glob`](#glob), [`exclude`](#exclude)) will be applied if specified.
+
+**Example**
+
+```yml
+# lefthook.yml
+
+pre-commit:
+  commands:
+    lint:
+      run: npm run lint --fix {staged_files}
+      stage_fixed: true
+```
+
 ### `interactive`
 
 **Default: `false`**

internal/config/command.go

@@ -25,6 +25,7 @@ type Command struct {
 
 	FailText    string `mapstructure:"fail_text"`
 	Interactive bool   `mapstructure:"interactive"`
+	StageFixed  bool   `mapstructure:"stage_fixed"`
 }
 
 func (c Command) Validate() error {

internal/config/script.go

@@ -18,6 +18,7 @@ type Script struct {
 
 	FailText    string `mapstructure:"fail_text"`
 	Interactive bool   `mapstructure:"interactive"`
+	StageFixed  bool   `mapstructure:"stage_fixed"`
 }
 
 func (s Script) DoSkip(gitState git.State) bool {

internal/git/repository.go

@@ -272,6 +272,18 @@ func (r *Repository) DropUnstagedStash() error {
 	return nil
 }
 
+func (r *Repository) AddFiles(files []string) error {
+	if len(files) == 0 {
+		return nil
+	}
+
+	_, err := r.Git.CmdArgs(
+		append([]string{"git", "add"}, files...)...,
+	)
+
+	return err
+}
+
 // FilesByCommand accepts git command and returns its result as a list of filepaths.
 func (r *Repository) FilesByCommand(command string) ([]string, error) {
 	lines, err := r.Git.CmdLines(command)

internal/lefthook/runner/executor.go

@@ -8,8 +8,8 @@ import (
 type ExecuteOptions struct {
 	name, root, failText string
 	args                 []string
-	interactive          bool
 	env                  map[string]string
+	interactive          bool
 }
 
 // Executor provides an interface for command execution.

internal/lefthook/runner/prepare_command.go

@@ -11,7 +11,12 @@ import (
 	"github.com/evilmartians/lefthook/internal/log"
 )
 
-func (r *Runner) prepareCommand(name string, command *config.Command) ([]string, error) {
+type commandArgs struct {
+	all   []string
+	files []string
+}
+
+func (r *Runner) prepareCommand(name string, command *config.Command) (*commandArgs, error) {
 	if command.Skip != nil && command.DoSkip(r.Repo.State()) {
 		return nil, errors.New("settings")
 	}
@@ -34,14 +39,14 @@ func (r *Runner) prepareCommand(name string, command *config.Command) ([]string,
 		log.Error(err)
 		return nil, errors.New("error")
 	}
-	if len(args) == 0 {
+	if args == nil || len(args.all) == 0 {
 		return nil, errors.New("no files for inspection")
 	}
 
 	return args, nil
 }
 
-func (r *Runner) buildCommandArgs(command *config.Command) ([]string, error) {
+func (r *Runner) buildCommandArgs(command *config.Command) (*commandArgs, error) {
 	filesCommand := r.Hook.Files
 	if command.Files != "" {
 		filesCommand = command.Files
@@ -56,6 +61,7 @@ func (r *Runner) buildCommandArgs(command *config.Command) ([]string, error) {
 		},
 	}
 
+	filteredFiles := []string{}
 	runString := command.Run
 	for filesType, filesFn := range filesTypeToFn {
 		// Checking substitutions and skipping execution if it is empty.
@@ -76,7 +82,7 @@ func (r *Runner) buildCommandArgs(command *config.Command) ([]string, error) {
 			if len(filesPrepared) == 0 {
 				return nil, nil
 			}
-
+			filteredFiles = append(filteredFiles, filesPrepared...)
 			runString = replaceQuoted(runString, filesType, filesPrepared)
 		}
 	}
@@ -88,7 +94,10 @@ func (r *Runner) buildCommandArgs(command *config.Command) ([]string, error) {
 
 	log.Debug("[lefthook] executing: ", runString)
 
-	return strings.Split(runString, " "), nil
+	return &commandArgs{
+		files: filteredFiles,
+		all:   strings.Split(runString, " "),
+	}, nil
 }
 
 func prepareFiles(command *config.Command, files []string) []string {

internal/lefthook/runner/runner.go

@@ -279,14 +279,26 @@ func (r *Runner) runScript(script *config.Script, path string, file os.FileInfo)
 		defer log.StartSpinner()
 	}
 
-	r.run(ExecuteOptions{
+	finished := r.run(ExecuteOptions{
 		name:        file.Name(),
 		root:        r.Repo.RootPath,
 		args:        args,
 		failText:    script.FailText,
 		interactive: script.Interactive && !r.DisableTTY,
 		env:         script.Env,
 	}, r.Hook.Follow)
+
+	if finished && config.HookUsesStagedFiles(r.HookName) && script.StageFixed {
+		files, err := r.Repo.StagedFiles()
+		if err != nil {
+			log.Warn("Couldn't stage fixed files:", err)
+			return
+		}
+
+		if err := r.Repo.AddFiles(files); err != nil {
+			log.Warn("Couldn't stage fixed files:", err)
+		}
+	}
 }
 
 func (r *Runner) runCommands() {
@@ -346,17 +358,33 @@ func (r *Runner) runCommand(name string, command *config.Command) {
 		defer log.StartSpinner()
 	}
 
-	r.run(ExecuteOptions{
+	finished := r.run(ExecuteOptions{
 		name:        name,
 		root:        filepath.Join(r.Repo.RootPath, command.Root),
-		args:        args,
+		args:        args.all,
 		failText:    command.FailText,
 		interactive: command.Interactive && !r.DisableTTY,
 		env:         command.Env,
 	}, r.Hook.Follow)
+
+	if finished && config.HookUsesStagedFiles(r.HookName) && command.StageFixed {
+		files := args.files
+		if len(files) == 0 {
+			stagedFiles, err := r.Repo.StagedFiles()
+			if err != nil {
+				log.Warn("Couldn't stage fixed files:", err)
+				return
+			}
+			files = prepareFiles(command, stagedFiles)
+		}
+
+		if err := r.Repo.AddFiles(files); err != nil {
+			log.Warn("Couldn't stage fixed files:", err)
+		}
+	}
 }
 
-func (r *Runner) run(opts ExecuteOptions, follow bool) {
+func (r *Runner) run(opts ExecuteOptions, follow bool) bool {
 	log.SetName(opts.name)
 	defer log.UnsetName(opts.name)
 
@@ -368,7 +396,7 @@ func (r *Runner) run(opts ExecuteOptions, follow bool) {
 		} else {
 			r.success(opts.name)
 		}
-		return
+		return err == nil
 	}
 
 	out := bytes.NewBuffer(make([]byte, 0))
@@ -384,14 +412,16 @@ func (r *Runner) run(opts ExecuteOptions, follow bool) {
 	}
 
 	if err == nil && r.SkipSettings.SkipExecution() {
-		return
+		return false
 	}
 
 	log.Infof("%s\n%s", execName, out)
 	if err != nil {
 		log.Infof("%s", err)
 	}
 	log.Infof("\n")
+
+	return err == nil
 }
 
 // Returns whether two arrays have at least one similar element.