grumphp
PHP code quality enforcement via git hooks
TLDR
Initialize GrumPHP
$ grumphp configure
Run all tasks$ grumphp run
Run specific task$ grumphp run --tasks=[phpcs]
Check git hooks$ grumphp git:init
Pre-commit check$ grumphp git:pre-commit
SYNOPSIS
grumphp command [options]
DESCRIPTION
GrumPHP is a PHP code quality tool that runs checks on git commits. It enforces coding standards by running tasks like PHPStan, PHP_CodeSniffer, and PHPUnit before allowing commits.
The tool integrates with git hooks to prevent commits that fail quality checks. It is configurable via a grumphp.yml file in the project root.
PARAMETERS
COMMAND
Command to run.configure
Initialize configuration.run
Execute all configured tasks.git:init
Install git hooks.git:pre-commit
Run pre-commit tasks.--tasks TASKS
Specify tasks to run.--help
Display help information.
CONFIGURATION
grumphp.yml
Project-level configuration file defining tasks, parameters, and git hook settings.
CAVEATS
PHP project specific. Requires Composer. May slow down commits with many tasks.
HISTORY
GrumPHP was created by phpro to automate PHP code quality enforcement through git hooks.
