lefthook

Ein Git Hooks Manager für Node.js, Ruby, Python und viele andere Arten von Projekten.

• Schnell. Es ist in Go geschrieben. Kann Befehle parallel ausführen.
• Kraftvoll. Es ermöglicht die Steuerung von Ausführungen und Dateien, die Sie an Ihre Befehle übergeben.
• Einfach. Es ist eine einzelne Abhängigkeits-freie Binärdatei, die in jeder Umgebung funktionieren kann.

Dokumentation

Lesen Sie den Einführungsbeitrag

Installieren

Mit Go (> = 1,23):

go install github.com/evilmartians/lefthook@latest

Mit NPM :

npm install lefthook --save-dev

Für Ruby :

gem install lefthook

Für Python :

pip install lefthook

Installationshandbuch mit mehr Möglichkeiten zur Installation von Lfthook: APT, Brew, Winget und andere.

Verwendung

Konfigurieren Sie Ihre Haken, installieren Sie sie einmal und vergessen Sie sie: Verlassen Sie sich auf die Magie darunter.

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

Weitere Details

• Konfiguration für lefthook.yml -Konfigurationsoptionen.
• Nutzung für Lfthook -CLI -Optionen, unterstützte Envs und Nutzungstipps.
• Diskussionen für Fragen, Ideen, Vorschläge.

Warum Lfthook

• Parallele Ausführung

Gibt Ihnen mehr Geschwindigkeit. Dokumente

 pre-push :
  parallel : true

• Flexible Liste von Dateien

Wenn Sie Ihre eigene Liste wollen. Benutzerdefinierte und vorgebaute Beispiele.

 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}

• Glob- und Regexp -Filter

Wenn Sie die Liste von Dateien filtern möchten. Hier finden Sie weitere Beispiele für Glob -Muster.

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

• Im Unterverzeichnis ausführen

Wenn Sie die Befehle auf einem relativen Pfad ausführen möchten

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

• Skripte ausführen

Wenn die Befehle von Oneline nicht ausreichen, können Sie Dateien ausführen. Dokumente

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

• Tags

Wenn Sie eine Gruppe von Befehlen steuern möchten. Dokumente

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

• Support Docker

Wenn Sie sich in der Docker -Umgebung befinden. Dokumente

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

• Lokale Konfiguration

Wenn Sie einen Frontend-/Backend -Entwickler haben und unnötige Befehle überspringen oder etwas in Docker überschreiben möchten. Dokumente

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

• Direkte Kontrolle

Wenn Sie die Hooks -Gruppe direkt ausführen möchten.

$ lefthook run pre-commit

• Ihre eigenen Aufgaben

Wenn Sie eine bestimmte Gruppe von Befehlen direkt ausführen möchten.

 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

• Steuerausgang

Sie können steuern, welche Lfthook -Option mit Ausgangsoption druckt.

 output :
  - execution
  - failure

---

Führer

• Mit node.js installieren
• Mit Ruby einbauen
• Mit Homebrew einbauen
• Mit Winget einbauen
• Installieren Sie für Debian-basierte Linux
• Installieren Sie für RPM-basierte Linux
• Installieren Sie für Arch Linux
• Installieren Sie für Alpine Linux
• Verwendung
• Konfiguration

Beispiele

Beispiele überprüfen

Artikel

• 5 coole (und überraschende) Möglichkeiten, um Lfthook für Automatisierungsfreude zu konfigurieren
• Lfthook: Schlagen Sie den Code Ihres Teams wieder in Form
• Lfthook + Crystalball
• Halten Sie die OSS -Dokumentation mit DocSify, Lfthook und Freunden inkundig
• Automatisch Leinen von Docker -Containern
• Smooth postgresql -Upgrades in Dockerdev -Umgebungen mit Lfthook
• Lfthook für React/React Native Apps