
Lefthook

Fast and powerfull Git hook manager for Node.js, Ruby or any other type of projects.
- Fast. It is written on Go. Can run commands in parallel.
- Powerful. With a few lines in config you can check only changed files on
pre-push hook.
- Simple. It is single dependency-free binary, which can work in any environment.
# On `git push` lefthook will run spelling and links check for all changed files
pre-push:
parallel: true
commands:
spelling:
files: git diff --name-only HEAD @{push}
glob: "*.md"
run: npx yaspeller {files}
check-links:
files: git diff --name-only HEAD @{push}
glob: "*.md"
run: npx markdown-link-check {files}
Usage
Choose your environment:
Then you can find all Lefhook features in full guide and explore wiki.
Why Lefthook
If you want more speed. Example
pre-push:
parallel: true
If you want your own list. Custom and prebuilded examples.
pre-commit:
commands:
frontend-linter:
run: yarn eslint {staged_files}
backend-linter:
run: bundle exec rubocop {all_files}
frontend-style:
files: git diff --name-only HEAD @{push}
run: yarn stylelint {files}
If you want to filter list of files.
pre-commit:
commands:
backend-linter:
glob: "*.{rb}" # glob filter
exclude: "application.rb|routes.rb" # regexp filter
run: bundle exec rubocop {all_files}
If oneline commands not enought you can execute files. Example.
commit-msg:
scripts:
"template_checker":
runner: bash
If you want to control a group of commands. Example.
pre-push:
commands:
packages-audit:
tags: frontend security
run: yarn audit
gems-audit:
tags: backend security
run: bundle audit
If you develope in Docker. Example.
pre-commit:
scripts:
"good_job.js":
runner: docker exec -it --rm <container_id_or_name> {cmd}
If you a frontender/backender and want to skip unnecessary commands or override something into Docker. Description.
# lefthook-local.yml
pre-push:
exclude_tags:
- frontend
commands:
packages-audit:
skip: true
If you want to run hooks group directly.
$ lefthook run pre-commit
If you want to run specific group of commands directly.
fixer:
commands:
ruby-fixer:
run: bundle exec rubocop --safe-auto-correct {staged_files}
js-fixer:
run: yarn eslint --fix {staged_files}
$ lefthook run fixer
Table of content:
Guides:
Migrations from:
Examples
Benchmarks
Comprasion