lefthook

Un gestionnaire de crochets GIT pour Node.js, Ruby, Python et de nombreux autres types de projets.

• Rapide. Il est écrit en Go. Peut exécuter des commandes en parallèle.
• Puissant. Il permet de contrôler l'exécution et les fichiers que vous transmettez à vos commandes.
• Simple. Il s'agit d'un binaire sans dépendance unique qui peut fonctionner dans n'importe quel environnement.

Documentation

Lire le post d'introduction

Installer

Avec go (> = 1,23):

go install github.com/evilmartians/lefthook@latest

Avec NPM :

npm install lefthook --save-dev

Pour Ruby :

gem install lefthook

Pour Python :

pip install lefthook

Guide d'installation avec plus de façons d'installer Lefthook: APT, Brew, Winget et autres.

Usage

Configurez vos crochets, installez-les une fois et oubliez-le: comptez sur la magie en dessous.

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 ' ... ' 

Plus de détails

• Configuration des options de configuration lefthook.yml .
• Utilisation pour les options CLI Lefthook , les envls pris en charge et les conseils d'utilisation.
• Discussions pour les questions, les idées, les suggestions.

Pourquoi Lefthook

• Exécution parallèle

Vous donne plus de vitesse. docs

 pre-push :
  parallel : true

• Liste flexible des fichiers

Si vous voulez votre propre liste. Exemples personnalisés et prédéfinis.

 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}

• Filtres glob et regexp

Si vous souhaitez filtrer la liste des fichiers. Vous pourriez trouver plus d'exemples de modèles glob ici.

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

• Exécuter dans le sous-répertoire

Si vous souhaitez exécuter les commandes dans un chemin relatif

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

• Exécuter les scripts

Si les commandes ONELINE ne suffisent pas, vous pouvez exécuter des fichiers. docs

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

• Balises

Si vous souhaitez contrôler un groupe de commandes. docs

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

• Support Docker

Si vous êtes dans l'environnement Docker. docs

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

• Configuration locale

Si vous vous développez un développeur frontend / backend et souhaitez sauter des commandes inutiles ou remplacer quelque chose dans Docker. docs

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

• Contrôle direct

Si vous souhaitez exécuter directement le groupe Hooks.

$ lefthook run pre-commit

• Vos propres tâches

Si vous souhaitez exécuter directement un groupe de commandes spécifiques.

 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

• Contrôle la sortie

Vous pouvez contrôler ce que Lefthook imprime avec une option de sortie.

 output :
  - execution
  - failure

---

Guides

• Installer avec node.js
• Installer avec Ruby
• Installer avec Homebrew
• Installer avec Winget
• Installer pour Linux basé à Debian
• Installer pour Linux basé sur RPM
• Installer pour Arch Linux
• Installer pour Alpine Linux
• Usage
• Configuration

Exemples

Vérifier les exemples

Articles

• 5 façons cool (et surprenantes) de configurer Lefthook pour l'automatisation Joy
• Lefthook: Retournez le code de votre équipe en forme
• Lefthook + Crystalball
• Garder la documentation OSS en échec avec Docify, Lefthook et ses amis
• Liant automatiquement les conteneurs Docker
• Améliorations postgresql lisses dans les environnements Dockerdev avec lefthook
• Lefthook pour les applications natives React / React