README.md

Config file name

Lefthook supports the following file names for the main config:

• lefthook.yml
• .lefthook.yml
• lefthook.yaml
• .lefthook.yaml
• lefthook.toml
• .lefthook.toml
• lefthook.json
• .lefthook.json

If there are more than 1 file in the project, only one will be used, and you'll never know which one. So, please, use one format in a project.

Filenames without the leading dot will also be looked up from the .config subdirectory.

Lefthook also merges an extra config with the name lefthook-local. All supported formats can be applied to this -local config. If you name your main config with the leading dot, like .lefthook.json, the -local config also must be named with the leading dot: .lefthook-local.json.

Options

• assert_lefthook_installed
• colors
• extends
• lefthook
• min_version
• no_tty
• output
• rc
• remotes
  • git_url
  • ref
  • refetch
  • refetch_frequency
  • configs
• skip_output
• source_dir
• source_dir_local
• skip_lfs
• templates
• {Git hook name} (e.g. pre-commit)
  • files (global)
  • parallel
  • piped
  • follow
  • exclude_tags
  • skip
  • only
  • jobs
    • name
    • run
    • script
    • runner
    • group
      • parallel
      • piped
      • jobs
    • skip
    • only
    • tags
    • glob
    • files
    • file_types
    • env
    • root
    • exclude
    • fail_text
    • stage_fixed
    • interactive
    • use_stdin
  • commands
    • run
    • skip
    • only
    • tags
    • glob
    • files
    • file_types
    • env
    • root
    • exclude
    • fail_text
    • stage_fixed
    • interactive
    • use_stdin
    • priority
  • scripts
    • runner
    • skip
    • only
    • tags
    • env
    • fail_text
    • stage_fixed
    • interactive
    • use_stdin
    • priority