CaptainHook es una biblioteca git hook fácil de usar y muy flexible para desarrolladores de php. Le permite configurar sus acciones de git hook en un archivo json simple.
Puede utilizar CaptainHook para validar o preparar sus mensajes de confirmación, garantizar la calidad del código o ejecutar pruebas unitarias antes de confirmar o enviar cambios a git. Puede borrar automáticamente los cachés locales o instalar las últimas dependencias del compositor después de realizar los últimos cambios.
CaptainHook facilita compartir ganchos dentro de su equipo e incluso puede asegurarse de que todos en su equipo activen los ganchos localmente.
Puede ejecutar comandos cli, usar algunos validadores integrados o escribir sus propias clases PHP que CaptainHook ejecuta. Para obtener más información, consulte la documentación.
El método preferido para instalar CaptainHook es instalar el archivo PHAR. Puede hacerlo utilizando Phive o descargar PHAR desde la página de lanzamiento de GitHub.
Phive instala Captainhook
O use Composer para instalarlo.
el compositor requiere --dev Captainhook/captainhook-phar
Si deseas obtener el código fuente con todas sus dependencias puedes usar:
el compositor requiere --dev Captainhook/captainhook
Después de instalar CaptainHook, puede utilizar el ejecutable de Captainhook para crear una configuración.
proveedor/bin/captainhook configurar
Después de crear el archivo de configuración Captainhook.json , debe activar los ganchos instalándolos en su directorio .git local. Para hacerlo, simplemente ejecute el siguiente comando CaptainHook .
instalación de proveedor/bin/captainhook
Eche un vistazo a este breve vídeo de instalación.
Uno de los objetivos de CaptainHook es facilitar que un equipo utilice los mismos ganchos de git. Si desea asegurarse de que todos instalen los ganchos, puede utilizar el pequeño hook-installer
del complemento Composer . Ejecuta el comando captainhook install
cada vez que ejecuta un comando de Composer .
El compositor requiere --dev Captainhook/hook-installer
Por supuesto, los compañeros de equipo aún pueden comprometerse sin ejecutar los ganchos, es por eso que también debes ejecutar las comprobaciones apropiadas en el backend. Pero al menos así nadie podrá olvidarse de instalarlos "por accidente".
A continuación se muestra un ejemplo del archivo de configuración Captainhook.json .
{ "commit-msg": {"enabled": verdadero, "acciones": [ {"acción": "CaptainHookAppHookMessageActionBeams" } ] }, "pre-commit": {"enabled": true,"acciones": [ {"acción": "phpunit" }, {"acción": "phpcs --standard=psr2 src" } ] }, "pre-push": {"enabled": false,"acciones": [] } }
¿Entonces te gustaría contribuir a la biblioteca CaptainHook
? ¡Excelente! Muchas gracias. Me vendría muy bien tu ayuda.
Eche un vistazo a las pautas de contribución.