captainhook -Download - captainhook -Quellcode herunterladen

captainhook

Andere Kategorien

5.24.1

Herunterladen

CaptainHook

CaptainHook ist eine einfach zu verwendende und sehr flexible Git-Hook-Bibliothek für PHP-Entwickler. Es ermöglicht Ihnen, Ihre Git-Hook-Aktionen in einer einfachen JSON-Datei zu konfigurieren.

Sie können CaptainHook verwenden, um Ihre Commit-Nachrichten zu validieren oder vorzubereiten, die Codequalität sicherzustellen oder Unit-Tests durchzuführen, bevor Sie Änderungen an Git festschreiben oder übertragen. Sie können lokale Caches automatisch löschen oder die neuesten Composer-Abhängigkeiten installieren, nachdem Sie die neuesten Änderungen übernommen haben.

CaptainHook macht es einfach, Hooks innerhalb Ihres Teams zu teilen und kann sogar sicherstellen, dass jeder in Ihrem Team die Hooks lokal aktiviert.

Sie können CLI-Befehle ausführen, einige integrierte Validatoren verwenden oder Ihre eigenen PHP-Klassen schreiben, die von CaptainHook ausgeführt werden. Weitere Informationen finden Sie in der Dokumentation.

Installation

Die bevorzugte Methode zur Installation von CaptainHook ist die Installation der PHAR-Datei. Sie können dies tun, indem Sie Phive verwenden oder PHAR von der GitHub-Release-Seite herunterladen.

 Phive Captainhook installieren

Oder verwenden Sie Composer, um es zu installieren.

 Composer erfordert --dev Captainhook/Captainhook-phar

Wenn Sie den Quellcode mit all seinen Abhängigkeiten erhalten möchten, können Sie Folgendes verwenden:

 Komponist benötigt --dev Captainhook/Captainhook

Aufstellen

Nach der Installation von CaptainHook können Sie die ausführbare Datei von Captainhook verwenden, um eine Konfiguration zu erstellen.

 Vendor/bin/captainhook configure

Nachdem Sie die Konfigurationsdatei „ captainhook.json“ erstellt haben, müssen Sie die Hooks aktivieren, indem Sie sie in Ihrem lokalen .git-Verzeichnis installieren. Führen Sie dazu einfach den folgenden CaptainHook -Befehl aus.

 Vendor/bin/captainhook install

Schauen Sie sich dieses kurze Installationsvideo an.

Eines der Ziele von CaptainHook ist es, einem Team die Verwendung derselben Git-Hooks zu erleichtern. Wenn Sie sicherstellen möchten, dass jeder die Hooks tatsächlich installiert, können Sie das kleine Composer- Plugin hook-installer verwenden. Der Befehl captainhook install wird jedes Mal ausgeführt, wenn Sie einen Composer -Befehl ausführen.

 Composer erfordert --dev Captainhook/Hook-Installer

Natürlich können Teamkollegen immer noch einen Commit durchführen, ohne die Hooks auszuführen, deshalb sollten Sie auch entsprechende Prüfungen im Backend durchführen. Aber zumindest kann so niemand vergessen, sie „aus Versehen“ zu installieren.

Konfiguration

Hier ist ein Beispiel für eine Captainhook.json -Konfigurationsdatei.

 { "commit-msg": {"enabled": true,"actions": [
      {"action": "CaptainHookAppHookMessageActionBeams" }
    ]
  }, "pre-commit": {"enabled": true,"actions": [
      {"action": "phpunit" },
      {"action": "phpcs --standard=psr2 src" }
    ]
  }, "pre-push": {"enabled": false,"actions": []
  }
}