Opt-in to auto-corrections? Custom fix commands that are different than the run command?

[technicalpickles]

Is there a way to let users opt in/out of autofixing globally? I'm migrating our teams from https://github.com/gusto/committer which has a flag to run the pre-commit hook with a fix.

We can also configure a separate command for fixing, with autostage, ie:

  - name: SVGO
    command: script/committer-svgo.sh
    files: '\.svg$'
    fix:
      command: yarn run svgo -i
      output: '\n'
      autostage: true

From what I'm seeing, the convention is to add the fix flags to the run command, and then auto_stage if you want it. I could imagine using a lefthook-local.yml for some of it, but it might involve a bunch of copy & paste.

[mrexox]

Hey! There is stage_fixed option for commands that work only for pre-commit hook now. You can enable it for commands where you want to do git add for files that were changed after the command finished. There's no global option for that yet, but it probably makes sense to add one 🤔

Is it the thing you were looking for?

[technicalpickles]

Not exactly. I'm asking to be able to make it user-configurable if fixes are attempted to be made. That may or not be separate from configuring allowing auto-staging per user.

This might be a moot question, since most people I've talked to so far are anti fix and stage anyways.

[mrexox]

I guess I got it. So, you want to control these steps:

1. Run the linter
2. If it fails, run a fixing command
3. Control whether to stage changes or not

If that's correct I can suggest a workaround since this flow is not usual. The idea is to call call lefthook from within itself.

# lefthook.yml

pre-commit:
  commands:
    lint:
      run: yarn lint || ([ -n "${AUTOFIX}" ] && lefthook run lint-fix || exit 1)
      # in case fixing command triggers git hooks (and then lefthook)
      # env:
      #   LEFTHOOK: 0 

lint-fix:
  commands:
    lint-fix:
      run: yarn run lint --fix
      # stage_fixed: true

# Run with no auto fixing
git commit

# Run with auto fixing
AUTOFIX=true git commit

The only notice: this requires lefthook to be available from PATH. Does it look like a solution?

And yes, there's lefthook-local.yml which would be a better option for user-specific configuration.

# lefthook.yml

pre-commit:
  commands:
    lint:
      run: yarn lint
    # some other commands maybe

# lefthook-local.yml

# This hook is "merged" into hook configuration defined in lefthook.yml, so you can overwrite only desired settings (only 'run' option for example)
pre-commit:
  commands:
    lint:
      run: yarn lint --fix

[technicalpickles]

That makes a lot of sense, thanks for putting it together 🙇🏻 That is a really cool idea of making a custom 'hook' and calling it!

I agree it's a really a common workflow. Given that, I don't think I need to worry about it for migrating unless I get more pushback.