Por qué hooks pre-commit
El lugar más barato para detectar un error de lint es la máquina del desarrollador, antes de que se forme el commit.
El hook más simple
# .git/hooks/pre-commit
#!/usr/bin/env bash
set -e
npm run lint --silent
npm run format:check --silent
chmod +x .git/hooks/pre-commit
Lintear solo archivos cambiados
#!/usr/bin/env bash
set -e
files=$(git diff --cached --name-only --diff-filter=ACMR | grep -E '\\.(js|ts|tsx)$' || true)
if [ -z "$files" ]; then
exit 0
fi
echo "$files" | xargs npx eslint --max-warnings=0
echo "$files" | xargs npx prettier --check
Husky para proyectos Node
npm install --save-dev husky lint-staged
npx husky init
# .husky/pre-commit
npx lint-staged
# package.json
"lint-staged": {
"*.{js,ts,tsx}": ["eslint --fix", "prettier --write"]
}
El framework pre-commit (ecosistema Python)
# .pre-commit-config.yaml
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-merge-conflict
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.5.0
hooks:
- id: ruff
- id: ruff-format
pip install pre-commit
pre-commit install
Compartir hooks vía core.hooksPath
git config core.hooksPath .githooks
Saltar cuando sea necesario
git commit --no-verify -m "WIP"
Verificaciones pre-commit comunes
- Lint y format.
- Type checks.
- Trailing whitespace, newlines de fin de archivo.
- Marcadores de conflictos de merge.
- Detección de secretos.
- Límites de tamaño de archivo.