Lefthook

TL;DR
Configuration
1. Extend other files
2. Use files from other repositories
Further readings
Sources

TL;DR

# Installation.
go install 'github.com/evilmartians/lefthook@latest'
npm install 'lefthook' --save-dev
gem install 'lefthook'
brew install 'lefthook'

# Get help about any command.
lefthook help
lefthook help 'dump'

# Generate autocompletion scripts for the specified shells.
lefthook completion 'zsh'
lefthook completion -v 'fish' > "$HOME/.config/fish/completions/lefthook.fish"
source <(lefthook completion 'bash')

# Add configured hooks to the current git repository.
# Creates a basic configuration file in the repository if missing.
lefthook install

# Print the merged configuration from all files.
lefthook dump

# Add hook directories to the current repository.
lefthook add 'pre-commit'
lefthook add -dv 'commit-msg'

# Execute groups of hooks.
lefthook run 'pre-push'
lefthook run -v 'lint' --all-files
lefthook run 'pre-commit' -n --commands 'hadolint' --files 'lefthook.yml'

# Remove configured hooks from the current git repository.
lefthook uninstall
lefthook uninstall -cv

# Reset lefthook-managed git hooks and start from the beginning.
lefthook uninstall && lefthook install

Uses the glob library for glob patterns.

Configuration

Configuration files can be written in JSON, TOML or YAML.
Only one of them will be used, even if there are more than one in the repository. The chosen one will be the first one found during initialization, hence it is suggested to use a single configuration file in any of the above formats.

The main configuration file must exist and go by the name lefthook.<formatExtension> or .lefthook.<formatExtension>.

An extra configuration file named lefthook-local is merged with the main file if found upon initialization. All supported formats can be applied to this -local file.
If the main configuration file starts with the leading dot, the -local file must also start with the leading dot.

$ ls -A1 *lefthook*
.lefthook-local.json
.lefthook.yml

Configuration file example

Configuration files can extend other files recursively.

Extend other files

extends:
  - .lefthook/commitlint.yml
  - .lefthook/docker.yml
  - .lefthook/json.yml

Use files from other repositories

Refer the configuration page.

Use the remotes key to include configuration files from this repository.
The configuration from remotes will be merged to the local config using the following priority:

Local main config (lefthook.yml).
Remote configs (remotes).
Local overrides (lefthook-local.yml).

# lefthook.yml
lint:
  parallel: true
  commands:
    yaml:
      glob: "*.{yaml,yml}"
      run: >-
        docker run --rm -v "$PWD:/code" 'registry.gitlab.com/pipeline-components/yamllint:latest'
        yamllint {all_files}
remotes:
  - git_url: https://gitlab.com/mine/oam.git
    ref: main
    configs:
      - quality-assurance/lefthook/commitlint.yml
      - quality-assurance/lefthook/docker.yml
      - quality-assurance/lefthook/json.yml

# lefthook-local.yml
no_tty: false
lint:
  commands:
    yaml:
      run: .venv/bin/yamllint {all_files}

$ lefthook dump
…
lint:
  commands:
    docker:
      run: hadolint {all_files}
      glob: "*[Dd]ockerfile*"
    yaml:
      run: .venv/bin/yamllint {all_files}
      glob: "*.{yaml,yml}"
  parallel: true

Sources

All the references in the further readings section, plus the following:

Lefthook: knock your team's code back into shape

4.3 KiB Raw Blame History