CaptainHook est une bibliothèque git hook facile à utiliser et très flexible pour les développeurs php. Il vous permet de configurer vos actions git hook dans un simple fichier json.
Vous pouvez utiliser CaptainHook pour valider ou préparer vos messages de validation, garantir la qualité du code ou exécuter des tests unitaires avant de valider ou de transmettre des modifications à git. Vous pouvez automatiquement effacer les caches locaux ou installer les dernières dépendances du compositeur après avoir extrait les dernières modifications.
CaptainHook facilite le partage de hooks au sein de votre équipe et peut même garantir que tous les membres de votre équipe activent les hooks localement.
Vous pouvez exécuter des commandes cli, utiliser des validateurs intégrés ou écrire vos propres classes PHP qui seront exécutées par CaptainHook . Pour plus d’informations, consultez la documentation.
La méthode préférée pour installer CaptainHook consiste à installer le fichier PHAR. Vous pouvez le faire en utilisant Phive ou en téléchargeant le PHAR à partir de la page de version de GitHub.
phive installer capitainehook
Ou utilisez Composer pour l’installer.
composer require --dev capitainehook/captainhook-phar
Si vous souhaitez obtenir le code source avec toutes ses dépendances, vous pouvez utiliser :
composer require --dev capitainehook/captainhook
Après avoir installé CaptainHook, vous pouvez utiliser l'exécutable CaptainHook pour créer une configuration.
configuration du vendeur/bin/captainhook
Après avoir créé le fichier de configuration capitainehook.json , vous devez activer les hooks en les installant dans votre répertoire .git local. Pour ce faire, exécutez simplement la commande CaptainHook suivante.
installation du fournisseur/bin/captainhook
Jetez un œil à cette courte vidéo d’installation.
L'un des objectifs de CaptainHook est de permettre à une équipe d'utiliser facilement les mêmes git hooks. Si vous voulez vous assurer que tout le monde installe réellement les hooks, vous pouvez utiliser le petit hook-installer
du plugin Composer . Il exécute la commande captainhook install
chaque fois que vous exécutez une commande Composer .
composer require --dev capitainehook/hook-installer
Bien sûr, les coéquipiers peuvent toujours s'engager sans exécuter les hooks, c'est pourquoi vous devez également effectuer des vérifications appropriées sur le backend. Mais au moins, personne ne pourra oublier de les installer "par accident".
Voici un exemple de fichier de configuration capitainehook.json .
{ "commit-msg": {"enabled": true,"actions": [ {"action": "CaptainHookAppHookMessageActionBeams" } ] }, "pre-commit": {"enabled": true,"actions": [ {"action": "phpunit" }, {"action": "phpcs --standard=psr2 src" } ] }, "pre-push": {"enabled": false,"actions": [] } }
Alors vous aimeriez contribuer à la bibliothèque CaptainHook
? Excellent! Merci beaucoup. Je peux absolument utiliser votre aide.
Jetez un œil aux directives de contribution.