lefthook

Un gerente de gits de Git para Node.js, Ruby, Python y muchos otros tipos de proyectos.

• Rápido. Está escrito en Go. Puede ejecutar comandos en paralelo.
• Poderoso. Permite controlar la ejecución y los archivos que pasa a sus comandos.
• Simple. Es un solo binario sin dependencia que puede funcionar en cualquier entorno.

Documentación

Lea la publicación de introducción

Instalar

Con GO (> = 1.23):

go install github.com/evilmartians/lefthook@latest

Con npm :

npm install lefthook --save-dev

Para Ruby :

gem install lefthook

Para Python :

pip install lefthook

Guía de instalación con más formas de instalar Lefthook: Apt, Brew, Winget y otros.

Uso

Configure sus ganchos, instálelos una vez y olvídelo: confíe en la magia debajo.

Tl; Dr

 # Configure your hooks
vim lefthook.yml

# Install them to the git project
lefthook install

# Enjoy your work with git
git add -A && git commit -m ' ... ' 

Más detalles

• Configuración para opciones de configuración de lefthook.yml .
• Uso de opciones de CLI de Lefthook , envss compatibles y consejos de uso.
• Discusiones para preguntas, ideas, sugerencias.

Por que Lefthook

• Ejecución paralela

Te da más velocidad. documento

 pre-push :
  parallel : true

• Lista flexible de archivos

Si quieres tu propia lista. Ejemplos personalizados y preBuidos.

 pre-commit :
  commands :
    frontend-linter :
      run : yarn eslint {staged_files}
    backend-linter :
      run : bundle exec rubocop --force-exclusion {all_files}
    frontend-style :
      files : git diff --name-only HEAD @{push}
      run : yarn stylelint {files}

• Filtros Glob y Regexp

Si desea filtrar la lista de archivos. Puede encontrar más ejemplos de patrones de globos aquí.

 pre-commit :
  commands :
    backend-linter :
      glob : " *.rb " # glob filter
      exclude : ' (^|/)(application|routes).rb$ ' # regexp filter
      run : bundle exec rubocop --force-exclusion {all_files}

• Ejecutar en subdirectorio

Si desea ejecutar los comandos en una ruta relativa

 pre-commit :
  commands :
    backend-linter :
      root : " api/ " # Careful to have only trailing slash
      glob : " *.rb " # glob filter
      run : bundle exec rubocop {all_files}

• Ejecutar guiones

Si los comandos Oneline no son suficientes, puede ejecutar archivos. documento

 commit-msg :
  scripts :
    " template_checker " :
      runner : bash

• Etiquetas

Si desea controlar un grupo de comandos. documento

 pre-push :
  commands :
    packages-audit :
      tags :
        - frontend
        - linters
      run : yarn lint
    gems-audit :
      tags :
        - backend
        - security
      run : bundle audit

• Apoyo a Docker

Si estás en el entorno Docker. documento

 pre-commit :
  scripts :
    " good_job.js " :
      runner : docker run -it --rm <container_id_or_name> {cmd}

• Configuración local

Si es un desarrollador frontend/backend y desea omitir comandos innecesarios o anular algo en Docker. documento

 # lefthook-local.yml
pre-push :
  exclude_tags :
    - frontend
  commands :
    packages-audit :
      skip : true

• Control directo

Si desea ejecutar el grupo de ganchos directamente.

$ lefthook run pre-commit

• Tus propias tareas

Si desea ejecutar un grupo específico de comandos directamente.

 fixer :
  commands :
    ruby-fixer :
      run : bundle exec rubocop --force-exclusion --safe-auto-correct {staged_files}
    js-fixer :
      run : yarn eslint --fix {staged_files} 

$ lefthook run fixer

• Salida de control

Puede controlar lo que imprime Lefthook con la opción de salida.

 output :
  - execution
  - failure

---

Guías

• Instalar con node.js
• Instalar con Ruby
• Instalar con HomeBrew
• Instalar con Winget
• Instalar para Linux con sede en Debian
• Instalar para Linux basado en RPM
• Instalar para Arch Linux
• Instalar para Alpine Linux
• Uso
• Configuración

Ejemplos

Verificar ejemplos

Artículos

• 5 formas geniales (y sorprendentes) de configurar a Lefthook para la alegría de automatización
• Lefthook: vuelva a poner en forma el código de su equipo
• Lefthook + Crystalball
• Mantener la documentación de OSS bajo control con Docsify, Lefthook y sus amigos
• CONTENEADORES DE DOCKER AUTOMÁTICOS
• Actualizaciones suaves de PostgreSQL en entornos DockerDev con Lefthook
• Lefthook para las aplicaciones nativas de React/React