grumphp
v2.10.0
¿Estás cansado de defender la calidad del código una y otra vez? ¡GrumPHP lo hará por ti! Este complemento de compositor registrará algunos ganchos de git en su repositorio de paquetes. Cuando alguien confirma cambios, GrumPHP ejecutará algunas pruebas en el código confirmado. Si las pruebas fallan, no podrá confirmar los cambios. Esta práctica herramienta no solo mejorará su base de código, sino que también enseñará a sus compañeros de trabajo a escribir mejor código siguiendo las mejores prácticas que haya determinado como equipo.
GrumPHP tiene un conjunto de tareas comunes integradas. Podrás utilizar GrumPHP con un mínimo de configuración.
No queremos aburrirte con todos los detalles, así que rápido: ¡instálalo tú mismo y libera el poder de GrumPHP!
Para que este paquete funcione, debe asegurarse de que las siguientes herramientas sean detectables en la línea de comandos:
PHP
compositor
git
Este paquete es un complemento de Composer y debe instalarse en la dependencia de desarrollo de su proyecto usando Composer:
Instale GrumPHP como phar sin dependencias:
el compositor requiere --dev phpro/grumphp-shim
Instale GrumPHP con dependencias:
composer require --dev phpro/grumphp
Instale GrumPHP sin dependencias y ganchos de Git automatizados a través de Phive
phive install grumphp
Cuando el paquete esté instalado, GrumPHP se adjuntará a los ganchos git de su proyecto. Verá el siguiente mensaje en los registros del compositor:
¡Cuidado! ¡GrumPHP está olfateando tus confirmaciones!
GrumPHP nunca te obligará a realizar una tarea específica. ¡Puedes elegir las tareas que se ajusten a tus necesidades y activar o desactivar cualquier tarea en poco tiempo! Consulte la sección suggest en compositor.json.
Nota: GrumPHP sobrescribirá los enlaces existentes a menos que ejecute composer install con --no-plugins o --no-scripts . Creamos una copia de seguridad de su enlace git, pero es mejor asegurarse de tener también una copia de seguridad de sus enlaces personalizados antes de intentar instalar GrumPHP.
¿Tiene problemas para instalar GrumPHP? Descubra cómo:
Instalar globalmente
Instalar con una estructura de proyecto exótica
Algunas cosas en GrumPHP se pueden configurar en un archivo grumphp.yml o grumphp.yml.dist o grumphp.dist.yml en la raíz de su proyecto (el directorio donde ejecuta el comando grumphp). Puede especificar un nombre de archivo de configuración personalizado y una ubicación en composer.json o en la opción --config de los comandos de la consola.
# grumphp.ymlgrumphp:hooks_dir: ~hooks_preset: localgit_hook_variables:VAGRANT_HOST_DIR: .VAGRANT_PROJECT_DIR: /var/wwwEXEC_GRUMPHP_COMMAND: execENV: {}stop_on_failure: falseignore_unstaged_changes: falsehide_circumvention_tip: falseprocess_timeout: 60ascii: fallido: grumphp-grumpy.txtsucceeded: grumphp-happy.txtparallel: habilitado: truemax_workers: 32fixer: habilitado: truefix_by_default: falseenvironment: archivos: []variables: {}rutas: []tareas: {}testsuites: []extensiones: []Los detalles de la configuración se dividen en las siguientes secciones.
Parámetros: ajustes de configuración para el propio GrumPHP.
Tareas: tareas externas que realizan la validación del código y sus respectivas configuraciones.
Suites de pruebas
Extensiones
Ampliando el TaskRunner
Comprobador de convenciones
Dado que GrumPHP es solo una herramienta CLI, se pueden activar estos comandos:
configurar
git: inicio
git:deinit
git:compromiso previo
git:commit-msg
correr
GrumPHP funciona con PHP 5.6 o superior.
Este paquete ha sido probado con los siguientes clientes de git:
CLI-Unix
CLIMac
Ventanas CLI
PHPStorm Git
Árbol fuente de Atlassian
Syntevo SmartGit
Ya hay muchas tareas disponibles para garantizar que su equipo escriba un código excelente. Siempre estamos buscando apoyar nuevas tareas. No dudes en registrar un problema o crear una solicitud de extracción para una tarea que olvidamos.
¿Te falta una característica o encontraste un error? ¡Inicia sesión en el rastreador de problemas! ¿Quieres ayudar? ¡No dudes en contactarnos!
Preguntas frecuentes
Los errores y las solicitudes de funciones se rastrean en GitHub. Eche un vistazo a nuestras reglas antes de contribuir con su código.
GrumPHP tiene la licencia MIT.
