GrumPHP

https://github.com/phpro/grumphp
Admin
GrumPHP is a composer plugin that automatically enforces code quality standards by running tests and...
Tokens:158,740
Snippets:1,437
Trust Score:7.2
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Add Composer vendor bin to PATH

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/installation/global.md

Add the `~/.composer/vendor/bin` folder to your system `$PATH` variable, for example in `.zshrc` or `.bashrc`, to make the `grumphp` command available on your CLI.

```sh
# .zshrc or .bashrc
export PATH="$HOME/.composer/vendor/bin:$PATH"
```

--------------------------------

### Install composer-normalize plugin

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/composer_normalize.md

Install the ergebnis/composer-normalize plugin as a dev dependency using Composer.

```bash
composer require --dev ergebnis/composer-normalize
```

--------------------------------

### Install GrumPHP globally with Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/installation/global.md

Use this command to install or update GrumPHP on your system. It installs the `grumphp` executable in the `~/.composer/vendor/bin` folder.

```sh
composer global require phpro/grumphp
```

--------------------------------

### Install GrumPHP as a phar without dependencies

Source: https://github.com/phpro/grumphp/blob/v2.x/README.md

Use this command to install GrumPHP as a phar without dependencies. It is a composer plugin and should be installed as a dev dependency.

```sh
composer require --dev phpro/grumphp-shim
```

--------------------------------

### Install PHPLint via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phplint.md

Install the php-parallel-lint package as a development dependency using Composer.

```bash
composer require --dev php-parallel-lint/php-parallel-lint
```

--------------------------------

### Install EasyCodingStandard via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/ecs.md

Install the symplify/easy-coding-standard package as a development dependency using Composer.

```bash
composer require --dev symplify/easy-coding-standard
```

--------------------------------

### environment.files example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Specifies a list of ini or .env files to load.

```yaml
# grumphp.yml
grumphp:
    environment:
        files:
            - .env
            - .env.local
```

--------------------------------

### additional_info parameter example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Sets additional information to be displayed after running tasks. The example shows a message with a URL.

```yaml
# grumphp.yml
grumphp:
    additional_info: "\nTo get full documentation for the project!\nVisit https://docs.example.com\n"
```

--------------------------------

### Install Codeception via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/codeception.md

Install the Codeception testing framework as a development dependency using Composer.

```bash
composer require --dev codeception/codeception
```

--------------------------------

### Install GrumPHP without dependencies and automated git hooks through phive

Source: https://github.com/phpro/grumphp/blob/v2.x/README.md

Use this command to install GrumPHP without dependencies and automated git hooks using phive.

```sh
phive install grumphp
```

--------------------------------

### Install Mago via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/mago/formatter.md

Install the Mago package as a development dependency using Composer.

```bash
composer require --dev carthage-software/mago
```

--------------------------------

### GrumPHP YAML configuration example

Source: https://github.com/phpro/grumphp/blob/v2.x/README.md

Example configuration file for GrumPHP, typically named grumphp.yml, grumphp.yml.dist, or grumphp.dist.yml. It defines hooks, git hook variables, process timeout, ASCII art, parallel execution, fixer settings, environment, tasks, testsuites, and extensions.

```yaml
# grumphp.yml
grumphp:
    hooks_dir: ~
    hooks_preset: local
    git_hook_variables:
        VAGRANT_HOST_DIR: .
        VAGRANT_PROJECT_DIR: /var/www
        EXEC_GRUMPHP_COMMAND: exec
        ENV: {}
    stop_on_failure: false
    ignore_unstaged_changes: false
    hide_circumvention_tip: false
    process_timeout: 60
    ascii:
        failed: grumphp-grumpy.txt
        succeeded: grumphp-happy.txt
    parallel:
        enabled: true
        max_workers: 32
    fixer:
        enabled: true
        fix_by_default: false
    environment:
        files: []
        variables: {}
        paths: []
    tasks: {}
    testsuites: []
    extensions: []

```

--------------------------------

### Install ESLint globally via npm

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/eslint.md

Installs ESLint globally on the system. Useful when you want to use ESLint from the command line without a project-specific installation.

```bash
npm install -g eslint
```

--------------------------------

### Install GrumPHP with dependencies

Source: https://github.com/phpro/grumphp/blob/v2.x/README.md

Use this command to install GrumPHP with dependencies via Composer. It will attach itself to git hooks and may overwrite existing hooks unless you use --no-plugins or --no-scripts.

```sh
composer require --dev phpro/grumphp
```

--------------------------------

### Install php7cc via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/php7cc.md

Install the php7cc package as a development dependency using Composer.

```bash
composer require --dev sstalle/php7cc
```

--------------------------------

### Re-initialize git hooks

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/installation/exotic.md

Run this command after changing composer.json parameters to re-initialize git hooks.

```sh
php ./vendor/bin/grumphp git:init
```

--------------------------------

### Install Stylelint globally via npm

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/stylelint.md

Install Stylelint globally using npm. Use this if you want Stylelint available system-wide.

```bash
npm install -g stylelint
```

--------------------------------

### Example result of additional_info

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Shows the output when additional_info is set, displaying the custom message after task results.

```text
GrumPHP is sniffing your code!
Running task 1/1: Phpcs... ✔

To get full documentation for the project!
Visit https://docs.example.com

```

--------------------------------

### Full grumphp.yml configuration example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Shows all available parameters with their default values in a single grumphp.yml file. Use as a reference for configuring GrumPHP.

```yaml
# grumphp.yml
grumphp:
    hooks_dir: ~
    hooks_preset: local
    git_hook_variables:
        VAGRANT_HOST_DIR: .
        VAGRANT_PROJECT_DIR: /var/www
        EXEC_GRUMPHP_COMMAND: exec
        ENV: {}
    stop_on_failure: false
    ignore_unstaged_changes: false
    hide_circumvention_tip: false
    process_timeout: 60
    additional_info: ~
    ascii:
        failed: resource/grumphp-grumpy.txt
        succeeded: resource/grumphp-happy.txt
    parallel:
        enabled: true
        max_workers: 32
    fixer:
        enabled: true
        fix_by_default: false
    environment:
        files: []
        variables: {}
        paths: []
```

--------------------------------

### Install Paratest via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/paratest.md

Install the Paratest package as a development dependency using Composer.

```bash
composer require --dev brianium/paratest
```

--------------------------------

### Install Behat via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/behat.md

Install the Behat testing framework as a development dependency using Composer.

```bash
composer require --dev behat/behat
```

--------------------------------

### Whitelist patterns example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpmnd.md

Filters files to validate using regex patterns, used in relation with 'triggered_by'. Example restricts analysis to src/App/ and src/AppBundle/ directories.

```yaml
whitelist_patterns:
    - /^src\/App\/(.*)/
    - /^src\/AppBundle\/(.*)/
```

--------------------------------

### Run GrumPHP with custom config file

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/installation/exotic.md

Use the --config CLI parameter to specify a custom configuration file. This parameter has the highest priority and is always used when provided.

```sh
php ./vendor/bin/grumphp git:init --config='custom/grumphp.yml'
php ./vendor/bin/grumphp run --config='custom/grumphp.yml'
```

--------------------------------

### environment.variables example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Defines environment variables directly in the config file.

```yaml
# grumphp.yml
grumphp:
    environment:
        variables:
            VAR1: "content"
            VAR2: "content"
```

--------------------------------

### Install PHP Parser via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpparser.md

Install the nikic/php-parser package as a development dependency using Composer.

```bash
composer require --dev nikic/php-parser
```

--------------------------------

### Install ESLint as a dev dependency

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/eslint.md

Installs ESLint as a dev dependency for the current project. Recommended for project-specific ESLint usage.

```bash
npm install eslint --save-dev
```

--------------------------------

### environment.paths example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Prepends paths to the system PATH variable while running GrumPHP.

```yaml
# grumphp.yml
grumphp:
    environment:
        paths:
            - tools
```

--------------------------------

### Install Stylelint as dev dependency via npm

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/stylelint.md

Install Stylelint as a dev dependency of your project using npm.

```bash
npm install --save-dev stylelint
```

--------------------------------

### Install Progpilot via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/progpilot.md

Install the Progpilot task using Composer. Requires setting the minimum stability to dev and requiring the dev-master version of designsecurity/progpilot.

```bash
composer config minimum-stability dev
composer require --dev designsecurity/progpilot:dev-master
```

--------------------------------

### Good examples of type scope conventions

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_commit_message.md

Examples of valid subject lines following the type_scope_conventions format.

```text
fix: Security issue with password hashing
fix(Password): Security issue with password hashing  
```

--------------------------------

### Register paths in composer.json

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/installation/exotic.md

Configure GrumPHP paths and plugin behavior via the 'extra' section in composer.json. All parameters are optional; after changing a parameter, re-initialize git hooks with 'php ./vendor/bin/grumphp git:init'.

```json
{
    "extra": {
        "grumphp": {
            "config-default-path": "path/to/grumphp.yml",
            "project-path": "path/to/your/project/folder",
            "disable-plugin": false
        }
    }
}
```

--------------------------------

### Install Kahlan via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/kahlan.md

Adds Kahlan as a development dependency using Composer.

```bash
composer require --dev kahlan/kahlan
```

--------------------------------

### Configure GrumPHP

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/commands.md

Run this command to create a basic configuration file. It is invoked during installation and automatically guesses the best configuration without asking for input.

```sh
php ./vendor/bin/grumphp configure
```

--------------------------------

### Whitelist patterns example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/eslint.md

Example of whitelist_patterns to filter files for ESLint validation, showing how to include Laravel's resources/js and Symfony's assets/js directories.

```yaml
whitelist_patterns:
    - /^resources\/js\/(.*)/
    - /^assets\/js\/(.*)/
```

--------------------------------

### Shell task scripts configuration example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/shell.md

Shows how to specify shell scripts and commands. Use '-c' as first argument to execute a command instead of opening a script. All scripts must succeed for the task to complete.

```yaml
# grumphp.yml
grumphp:
    tasks:
        shell:
            scripts:
                - script.sh
                - ["-c", "./bin/command arg1 arg2"]
```

--------------------------------

### Whitelist patterns example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_blacklist.md

Example of whitelist_patterns to filter files for validation, skipping files like tests. Used in relation with triggered_by.

```yaml
whitelist_patterns:
    - /^src\/FolderA\/(.*)/
    - /^src\/FolderB\/(.*)/
```

--------------------------------

### ENV variable example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Shows how to set environment variables in the git hook file. Values can be strings, escaped strings, or command substitutions.

```yaml
# grumphp.yml
grumphp:
    git_hook_variables:
        ENV:
            VAR1: STRING
            VAR2: "'escaped'"
            VAR3: "$(pwd)"
```

--------------------------------

### Install PHP_CodeSniffer via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcs.md

Required installation step before using the Phpcs task. Adds squizlabs/php_codesniffer as a development dependency.

```bash
composer require --dev squizlabs/php_codesniffer
```

--------------------------------

### List installed PHPCS standards

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcs.md

Command to display all installed PHP_CodeSniffer standards, useful for setting the 'standard' parameter.

```sh
phpcs -i
```

--------------------------------

### Composer require conflict example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/faq.md

Example of a Composer require conflict between a project and GrumPHP for symfony/console. The project requires ~2.3, !=2.7.0 while GrumPHP requires ~2.7|~3.0.

```json
"symfony/console": "~2.3, !=2.7.0"
```

```json
"symfony/console": "~2.7|~3.0"
```

```text
Your requirements could not be resolved to an installable set of packages.
```

```json
"symfony/console": "v2.8.20 as v2.6.13"
```

--------------------------------

### Configure PHPLint task in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phplint.md

Example configuration for the PHPLint task in grumphp.yml, showing all available options with their defaults.

```yaml
# grumphp.yml
grumphp:
    tasks:
        phplint:
            php_executable: null
            exclude: []
            jobs: ~
            short_open_tag: false
            ignore_patterns: []
            triggered_by: ['php', 'phtml', 'php3', 'php4', 'php5']
```

--------------------------------

### Install Phan via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phan.md

Adds the Phan static analyzer as a development dependency using Composer.

```bash
composer require --dev phan/phan
```

--------------------------------

### Install convention package with Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/conventions.md

Use this command to require your convention package as a dev dependency.

```sh
composer require --dev [your-project]/[your-convention-package]
```

--------------------------------

### Install Phing via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phing.md

Adds Phing as a development dependency using Composer.

```bash
composer require --dev phing/phing
```

--------------------------------

### Install Robo via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/robo.md

Adds the Robo task runner as a development dependency using Composer.

```bash
composer require --dev consolidation/robo
```

--------------------------------

### Example allow_list configuration

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/securitychecker/enlightn.md

Shows how to specify a list of CVE identifiers to ignore during the security check. The allow_list option accepts an array of strings.

```yaml
allow_list:
    - CVE-2018-15133
    - CVE-2024-51755
    - CVE-2024-45411
```

--------------------------------

### Install Nette Tester via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/tester.md

Adds the Nette Tester testing framework as a development dependency.

```bash
composer require nette/tester --dev
```

--------------------------------

### PhpMnd extensions examples

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpmnd.md

Shows the code analysis extensions that can be enabled via the 'extensions' parameter. Each extension targets a specific code pattern: argument, array, assign, default_parameter, operation, property, return, condition, and switch_case.

```php
round($number, 4);
```

```php
$array = [200, 201];
```

```php
$var = 10;
```

```php
function foo($default = 3);
```

```php
$bar = $foo * 20;
```

```php
private $bar = 10;
```

```php
return 5;
```

```php
$var < 7;
```

```php
case 3;
```

--------------------------------

### Set environment variables in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/installation/exotic.md

Define environment variables directly in grumphp.yml. These are loaded after an initial guess of paths, then a second guess uses these variables.

```yaml
grumphp:
    environment:
    variables:
        GRUMPHP_PROJECT_DIR: "..."
        GRUMPHP_GIT_WORKING_DIR: "..."
        GRUMPHP_GIT_REPOSITORY_DIR: "..."
        GRUMPHP_BIN_DIR: "..."
    paths:
        - 'tools'
```

--------------------------------

### Install Symfony PHPUnit Bridge via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpunitbridge.md

Run this command to install the Symfony PHPUnit Bridge as a development dependency, which is required for the Phpunit Bridge task.

```bash
composer require --dev symfony/phpunit-bridge
```

--------------------------------

### Install PHPStan via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpstan.md

Adds PHPStan as a development dependency using Composer.

```bash
composer require --dev phpstan/phpstan
```

--------------------------------

### Install Pest via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/pest.md

Adds the Pest testing framework as a development dependency using Composer.

```bash
composer require --dev pestphp/pest
```

--------------------------------

### Pass Files to Run Command via STDIN

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/commands.md

These examples show how to pipe git diffs or file lists into the run command to select which files to check. If no STDIN is provided, all files known to git are loaded. Interactive questions cannot be answered when using STDIN.

```sh
git diff --raw --patch | php ./vendor/bin/grumphp run
```

```sh
git diff --raw --patch --staged | php ./vendor/bin/grumphp run
```

```sh
git ls-files src | php ./vendor/bin/grumphp run
```

--------------------------------

### Install Psalm via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/psalm.md

Adds Psalm as a development dependency using Composer. Use the first command for the standard package, or the second if you prefer the Phar version.

```bash
composer require --dev vimeo/psalm
```

```bash
composer require --dev psalm/phar
```

--------------------------------

### Install TwigCs via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/twigcs.md

Install the TwigCs package with Composer as a development dependency. Requires the package 'friendsoftwig/twigcs' version 4 or higher.

```bash
composer require --dev "friendsoftwig/twigcs:>=4"
```

--------------------------------

### Git commit message task configuration example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_commit_message.md

Example configuration for the git_commit_message task in grumphp.yml, showing all available options with their default values.

```yaml
# grumphp.yml
grumphp:
    tasks:
        git_commit_message:
            allow_empty_message: false
            enforce_capitalized_subject: true
            enforce_no_subject_punctuations: false
            enforce_no_subject_trailing_period: true
            enforce_single_lined_subject: true
            type_scope_conventions: []
            skip_on_merge_commit: true
            max_body_width: 72
            max_subject_width: 60
            matchers:
                Must contain JIRA issue number: /JIRA-\d+/
            case_insensitive: true
            multiline: true
            additional_modifiers: ''
```

--------------------------------

### Install PHPArkitect via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phparkitect.md

Adds PHPArkitect as a development dependency using Composer.

```bash
composer require --dev phparkitect/phparkitect
```

--------------------------------

### Install Infection via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/infection.md

Adds the Infection mutation testing framework as a development dependency using Composer.

```bash
composer require --dev infection/infection
```

--------------------------------

### Install Phpspec via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpspec.md

Adds the Phpspec dependency to the project for running specs.

```bash
composer require --dev phpspec/phpspec
```

--------------------------------

### Whitelist patterns for CSS directories

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/stylelint.md

Example of whitelist_patterns to filter files for Stylelint, whitelisting resources/css/ and assets/css/ directories.

```yaml
whitelist_patterns:
    - /^resources\/css\/(.*)/
    - /^assets\/css\/(.*)/
```

--------------------------------

### Pass Changes to Git Hooks via STDIN

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/commands.md

These examples show how to pipe git diffs or file lists into the pre-commit command. Note that interactive questions cannot be answered when using STDIN.

```sh
git diff --raw --patch | php ./vendor/bin/grumphp git:pre-commit
```

```sh
git diff --staged --raw --patch | php ./vendor/bin/grumphp git:pre-commit
```

```sh
git ls-files src | php ./vendor/bin/grumphp git:pre-commit
```

--------------------------------

### Install Rector via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/rector.md

Adds Rector as a development dependency using Composer.

```bash
composer require --dev rector/rector
```

--------------------------------

### Install PhpCpd via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcpd.md

Adds sebastian/phpcpd as a development dependency using Composer.

```bash
composer require --dev sebastian/phpcpd
```

--------------------------------

### EXEC_GRUMPHP_COMMAND examples

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Shows various ways to set the EXEC_GRUMPHP_COMMAND variable. It can be a string or an array; strings are used as-is, arrays are escaped by symfony/process.

```yaml
# grumphp.yml
grumphp:
    git_hook_variables:
        EXEC_GRUMPHP_COMMAND: '/usr/local/bin/php72'
        EXEC_GRUMPHP_COMMAND: 'lando php'
        EXEC_GRUMPHP_COMMAND: 'fin exec php'
        EXEC_GRUMPHP_COMMAND: ['php', '-c /custom/config.ini']
        EXEC_GRUMPHP_COMMAND: ['docker-compose', 'run', '-T', '--rm', '--no-deps', 'php']
        EXEC_GRUMPHP_COMMAND: 'docker run --rm -it -v $(pwd):/grumphp -w /grumphp webdevops/php:alpine'
        EXEC_GRUMPHP_COMMAND: 'ddev exec php'
```

--------------------------------

### Install PHPUnit via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpunit.md

Adds PHPUnit as a development dependency using Composer. Required before using the Phpunit task.

```bash
composer require --dev phpunit/phpunit
```

--------------------------------

### Install roave/security-advisories via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/securitychecker/roave.md

Adds the Roave Security Advisories package as a development dependency to check composer.lock for known security vulnerabilities.

```bash
composer require --dev roave/security-advisories:dev-latest
```

--------------------------------

### Sample project grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/conventions.md

Imports the convention file and overrides the parameter for project-specific settings.

```yaml
# Project grumphp.yml
imports:
    - { resource: vendor/[your-project]/[your-convention-package]/grumphp.yml }
parameters:
    convention.git_commit_message_matchers: ['/^JIRA-\d+: [A-Z].+\./']
```

--------------------------------

### Enable or Disable GrumPHP Git Hooks

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/commands.md

Use `git:init` to enable GrumPHP and `git:deinit` to disable it. The `git:init` command is triggered by the composer plugin during installation.

```sh
php ./vendor/bin/grumphp git:init
```

```sh
php ./vendor/bin/grumphp git:deinit
```

--------------------------------

### PHP-CS-Fixer Rules Map-Style Example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcsfixer.md

Configures rules using a map, enabling PSR-2, disabling line_ending, and setting array_syntax to short syntax.

```yaml
rules:
    '@PSR2': true
    line_ending: false
    array_syntax:
        syntax: short
```

--------------------------------

### Install PhpMnd via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpmnd.md

Adds the povils/phpmnd package as a development dependency for detecting magic numbers in PHP code.

```bash
composer require --dev povils/phpmnd
```

--------------------------------

### Set environment variables

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/installation/exotic.md

Set one or more environment variables to override auto-detected paths. Paths can be absolute or relative to the current working directory. These variables have the highest priority and are always used when available.

```sh
GRUMPHP_PROJECT_DIR=...
GRUMPHP_GIT_WORKING_DIR=....
GRUMPHP_GIT_REPOSITORY_DIR=...
GRUMPHP_COMPOSER_DIR=...
GRUMPHP_BIN_DIR=...
PATH=/additional/bin/dirs:$PATH
```

--------------------------------

### Install PHP-CS-Fixer via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcsfixer.md

Adds the PHP-CS-Fixer tool as a development dependency using Composer.

```bash
composer require --dev friendsofphp/php-cs-fixer
```

--------------------------------

### Install Symfony2 PHPCS standard

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcs.md

Requires the leaphub phpcs repo for Symfony2 projects.

```sh
composer require --dev leaphub/phpcs-symfony2-standard
```

--------------------------------

### PHP-CS-Fixer Rules List-Style Example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcsfixer.md

Enables PSR-2 rules, removes the line_ending rule, and adds the array_syntax rule using a list format.

```yaml
rules:
    - '@@PSR2'
    - -line_ending
    - array_syntax
```

--------------------------------

### Type scope conventions with types

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_commit_message.md

Configuration example for type_scope_conventions specifying a list of acceptable types.

```yaml
type_scope_conventions:
    types:
        - build
        - ci
        - chore
        - docs
        - feat
        - fix
        - perf
        - refactor
        - revert
        - style
        - test
    scopes: []
```

--------------------------------

### Install Composer Require Checker via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/composer_require_checker.md

Adds the maglnet/composer-require-checker package as a development dependency.

```bash
composer require --dev maglnet/composer-require-checker
```

--------------------------------

### Type scope conventions with scopes

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_commit_message.md

Configuration example for type_scope_conventions specifying a list of acceptable scopes.

```yaml
type_scope_conventions:
    types: []
    scopes:
        - api
        - index
        - user
        - language
        - browser
        - environment
```

--------------------------------

### Install PHPMD 3 via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpmd3.md

Adds PHPMD 3 as a development dependency using Composer.

```bash
composer require --dev phpmd/phpmd:^3.0
```

--------------------------------

### Install enlightn/security-checker via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/securitychecker/enlightn.md

Adds the Enlightn security checker as a development dependency to check composer.lock for known security vulnerabilities.

```bash
composer require --dev enlightn/security-checker
```

--------------------------------

### Configure PHPStan task in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpstan.md

Example configuration for the PHPStan task in grumphp.yml. All parameters are optional with defaults shown. The 'level' parameter must be set either here or in the phpstan.neon file. 'use_grumphp_paths' controls whether GrumPHP-detected paths or PhpStan configuration paths are used.

```yaml
# grumphp.yml
grumphp:
    tasks:
        phpstan:
            autoload_file: ~
            configuration: ~
            level: null
            force_patterns: []
            ignore_patterns: []
            triggered_by: ['php']
            memory_limit: "-1"
            use_grumphp_paths: true
```

--------------------------------

### Additional modifiers example

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_commit_message.md

Shows how to add one or multiple additional modifiers to the matchers, such as 'u' or 'xu'.

```yaml
additional_modifiers: 'u'

# or

additional_modifiers: 'xu'
```

--------------------------------

### Install PhpMd via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpmd.md

Adds the PhpMd dependency to the project. Requires Composer and PHP.

```bash
composer require --dev phpmd/phpmd:^2.0
```

--------------------------------

### Install Magento ECG coding standard

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcs.md

Requires the magento-ecg repo for Magento 1 and Magento 2 projects.

```sh
composer require --dev magento-ecg/coding-standard
```

--------------------------------

### Install Magento Coding Standard for Magento 2

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcs.md

Requires the Magento Coding Standard repo for Magento 2 projects.

```sh
composer require --dev magento/magento-coding-standard
```

--------------------------------

### Configure PHPArkitect in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phparkitect.md

Example configuration for the PHPArkitect task in grumphp.yml. The config parameter specifies the path to the project's configuration file; by default, PHPArkitect searches for phparkitect.php in the project root. target_php_version sets the PHP version for the parser, and stop_on_failure ends the process immediately after the first violation.

```yaml
# grumphp.yml
grumphp:
    tasks:
        phparkitect:
            config: ~
            target_php_version: ~
            stop_on_failure: ~
```

--------------------------------

### Register custom task service in my-extension.yaml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/extensions.md

Example configuration file that registers a custom task service with the `grumphp.task` tag, enabling it as a task named `myCustomTask`.

```yaml
# my-extension.yaml
services:
  My\CustomTask:
    arguments: []
    tags:
      - {name: grumphp.task, task: myCustomTask}
```

--------------------------------

### Configure Infection task in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/infection.md

Example configuration for the Infection task under the `infection` namespace. All parameters are optional with defaults shown. Adjust `threads`, `test_framework`, `min_msi`, and other options as needed.

```yaml
# grumphp.yml
grumphp:
    tasks:
        infection:
            threads: ~
            test_framework: ~
            only_covered: false
            show_mutations: false
            verbose: false
            configuration: ~
            min_msi: ~
            min_covered_msi: ~
            mutators: []
            ignore_patterns: []
            triggered_by: [php]
            skip_initial_tests: false
            coverage: ~
```

--------------------------------

### Additional modifiers examples

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_branch_name.md

Shows two ways to set the additional_modifiers option: with a single modifier 'u' or with multiple modifiers 'xu'. These modifiers are added to the pattern matching.

```yaml
additional_modifiers: 'u'

# or

additional_modifiers: 'xu'

```

--------------------------------

### Scaffold Mago configuration with mago init

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/mago.md

Generate a default `mago.toml` configuration file in the project root.

```bash
vendor/bin/mago init
```

--------------------------------

### getConfigurableOptions with ConfigOptionsResolver::fromClosure

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks.md

Shows how to return configurable options using ConfigOptionsResolver::fromClosure. Required for compatibility with the grumphp-shim (phar) distribution because Symfony's OptionsResolver is scoped inside the phar.

```php
public static function getConfigurableOptions(): ConfigOptionsResolver
{
    $resolver = new OptionsResolver();

    // ..... your config

    return ConfigOptionsResolver::fromClosure(
        static fn (array $options): array => $resolver->resolve($options)
    );
}
```

--------------------------------

### environment configuration

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Configures environment loading with files, variables, and paths.

```yaml
# grumphp.yml
grumphp:
    environment:
        files: []
        variables: {}
        paths: []
```

--------------------------------

### Install Drupal Coder

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpcs.md

Requires the Drupal Code Sniffer (Coder) for Drupal projects.

```sh
composer require --dev drupal/coder
```

--------------------------------

### AbstractVisitor blueprint

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpparser.md

Base class for built-in visitors. Extends NodeVisitorAbstract, implements ContextAwareVisitorInterface, and provides an addError method for logging errors. Only implement the methods you need.

```php
// GrumPHP\Parser\Php\Visitor\AbstractVisitor;
class AbstractVisitor extends NodeVisitorAbstract implements ContextAwareVisitorInterface
{
    protected $context;

    public function setContext(ParserContext $context);

    protected function addError($message, $line = -1, $type = ParseError::TYPE_ERROR);
}
```

--------------------------------

### Install Twig-CS-Fixer via Composer

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/twigcsfixer.md

Adds the Twig-CS-Fixer package as a development dependency. Requires Composer.

```bash
composer require --dev "vincentlanglet/twig-cs-fixer:>=2"
```

--------------------------------

### Sample conventions grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/conventions.md

Defines common rules with parameters that can be overridden by the project.

```yaml
# Convention grumphp.yml
parameters:
    convention.git_commit_message_matchers: ['/.*/']
grumphp:
    tasks:
        phpunit: ~
        git_commit_message:
            matchers: "%convention.git_commit_message_matchers%"
            case_insensitive: false
            multiline: false
```

--------------------------------

### Add node_modules/.bin to grumphp paths

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/stylelint.md

Add node_modules/.bin to grumphp environment paths so that the stylelint binary is automatically discovered.

```yaml
# grumphp.yml
grumphp:
    environment:
        paths:
            - node_modules/.bin
```

--------------------------------

### Generate ESLint config file

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/eslint.md

Runs the ESLint initialization wizard to create a .eslintrc.* configuration file.

```bash
npx eslint --init
```

--------------------------------

### Set testsuite option

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpunitbridge.md

Use this configuration to run only tests from a specific suite, for example 'unit'.

```yaml
testsuite: unit
```

--------------------------------

### Run GrumPHP on Full Codebase

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/commands.md

Run all configured tasks on the full codebase. The `--testsuite` option allows selecting a specific testsuite; this is useful for continuous integration.

```sh
php ./vendor/bin/grumphp run
```

```sh
php ./vendor/bin/grumphp run --testsuite=mytestsuite
```

--------------------------------

### Set group option

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpunitbridge.md

Use this configuration to run only tests from specific groups, for example 'fast', 'quick', and 'small'.

```yaml
group: ['fast','quick','small']
```

--------------------------------

### Make task configuration in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/make.md

Configuration for the Make task under the 'make' namespace. Parameters include make_file, task, and triggered_by. Defaults: make_file null (auto-loads Makefile), task null (runs default task), triggered_by [php].

```yaml
# grumphp.yml
grumphp:
    tasks:
        make:
            make_file: ~
            task: ~
            triggered_by: [php]
```

--------------------------------

### Type scope conventions with subject pattern

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/git_commit_message.md

Configuration example for type_scope_conventions specifying a custom subject pattern.

```yaml
type_scope_conventions:
    types: []
    scopes: ~
    subject_pattern: >-
        ([a-zA-Zа-яА-Я0-9-_ #@'\/\"]+)
```

--------------------------------

### Environment variables with integer value

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Shows how to set an environment variable that requires an integer value. Wrap the value in quotes because symfony/process only passes strings.

```yaml
# grumphp.yml
grumphp:
    environment:
        variables:
            PHP_CS_FIXER_IGNORE_ENV: "1"
```

--------------------------------

### TaskInterface definition

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks.md

Defines the required methods for a custom GrumPHP task: getConfigurableOptions, canRunInContext, run, getConfig, and withConfig. Implement this interface to create a task.

```php
<?php

interface TaskInterface
{
    public static function getConfigurableOptions(): ConfigOptionsResolver;
    public function canRunInContext(ContextInterface $context): bool;
    public function run(ContextInterface $context): TaskResultInterface;
    public function getConfig(): TaskConfigInterface;
    public function withConfig(TaskConfigInterface $config): TaskInterface;
}
```

--------------------------------

### Run GrumPHP scan on all files

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/faq.md

Run ./vendor/bin/grumphp run to scan all files in the repository. On pre-commit and commit-msg, only changed files are scanned.

```bash
./vendor/bin/grumphp run
```

--------------------------------

### ascii parameter with lists of images

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/parameters.md

Configures custom ascii images for failed and succeeded banners. Lists allow random selection.

```yaml
# grumphp.yml
grumphp:
    ascii:
        failed:
            - resource/grumphp-grumpy.txt
            - resource/nopecat.txt
            - resource/failed.txt
        succeeded:
            - resource/grumphp-happy.txt
            - resource/me-gusta.txt
            - resource/succeeded.txt
```

--------------------------------

### ConfigurableVisitorInterface definition

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpparser.md

Optional interface to make a visitor configurable in grumphp.yml. It extends NodeVisitor and adds a configure method. Recommended to use OptionsResolver for option validation.

```php
// GrumPHP\Parser\Php\Visitor\ConfigurableVisitorInterface;
interface ConfigurableVisitorInterface extends NodeVisitor
{
    public function configure(array $options);
}
```

--------------------------------

### Implement TaskHandlerMiddlewareInterface in PHP

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/runner.md

A task handler middleware adjusts how to run one single task, e.g., event dispatching, caching, logging. It works asynchronously and must return an amp promise object.

```php
use GrumPHP\Runner\TaskHandler\Middleware\TaskHandlerMiddlewareInterface;
use GrumPHP\Runner\TaskResultInterface;
use GrumPHP\Runner\TaskRunnerContext;
use GrumPHP\Task\TaskInterface;

class PassThroughTaskHandlerMiddleware implements TaskHandlerMiddlewareInterface
{
    /**
     * @param callable(TaskInterface, TaskRunnerContext): Promise<TaskResultInterface> $next
     * @return Promise<TaskResultInterface>
     */
    public function handle(TaskInterface $task, TaskRunnerContext $runnercontext,callable $next): Promise
    {
        return $next($task, $runnercontext);
    }
}
```

--------------------------------

### never_use_else visitor configuration

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpparser.md

Searches for `else` and `elseif` keywords and adds an error if found. This visitor is not configurable.

```yaml
# grumphp.yml
grumphp:
    tasks:
        phpparser:
            visitors:
                never_use_else: ~
```

--------------------------------

### Configure Psalm Task in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/psalm.md

Defines the Psalm task configuration in grumphp.yml. The config parameter sets the path to the project's configuration file. ignore_patterns lists patterns to skip, no_cache disables the cache, report specifies the report file path, output_format changes the output format (compact, console, emacs, json, pylint, xml, checkstyle, junit, sonarqube), threads sets the number of analysis threads, triggered_by lists file extensions to sniff, and show_info displays non-exception parser findings.

```yaml
# grumphp.yml
grumphp:
    tasks:
        psalm:
            config: psalm.xml
            ignore_patterns: []
            no_cache: false
            report: ~
            output_format: null
            threads: 1
            triggered_by: ['php']
            show_info: false

```

--------------------------------

### Set exclude_group option

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phpunitbridge.md

Use this configuration to run tests excluding specific groups, for example 'big' and 'risky'. Note the source shows 'group:' but the option is 'exclude_group'.

```yaml
group: ['big','risky']
```

--------------------------------

### Kahlan Task Configuration in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/kahlan.md

Configures the Kahlan task under the 'kahlan' namespace with all available parameters. Each parameter maps to a Kahlan command-line option, with defaults as documented.

```yaml
# grumphp.yml
grumphp:
    tasks:
        kahlan:
            config: ~
            src: ~
            spec: ~
            pattern: ~
            reporter: ~
            coverage: ~
            clover: ~
            istanbul: ~
            lcov: ~
            ff: ~
            no_colors: ~
            no_header: ~
            include: ~
            exclude: ~
            persistent: ~
            cc: ~
            autoclear: ~
```

--------------------------------

### Run Specific Tasks with --tasks Option

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/commands.md

Run only a subset of configured tasks by providing a comma-separated list of task names that match keys in the `tasks` section of `grumphp.yml`.

```sh
php ./vendor/bin/grumphp run --tasks=task1,task2
```

--------------------------------

### Atoum task configuration in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/atoum.md

Configures the Atoum task with optional parameters for config_file, bootstrap_file, directories, files, namespaces, methods, and tags. All parameters default to null or empty arrays. The config_file is optional if the file is named .atoum.php and located in the current directory.

```yaml
# grumphp.yml
grumphp:
    tasks:
        atoum:
            config_file: .atoum.php
            bootstrap_file: tests/units/bootstrap.php
            directories:
                - tests/units
            files:
                - tests/units/MyTest.php
            namespaces:
                - mageekguy\atoum\tests\units\asserters
            methods:
                - mageekguy\atoum\tests\units\asserters\string::testContains
                - mageekguy\atoum\tests\units\asserters\string::*
            tags:
                - thisIsOneTag
                - thisIsThreeTag
```

--------------------------------

### Activate all GrumPHP tasks with empty configuration

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks.md

Add an empty task configuration under the 'tasks' key to activate any task. Each task uses its own default configuration, which can be overridden per task.

```yaml
# grumphp.yml
grumphp:
    tasks:
        ant: ~
        atoum: ~
        behat: ~
        brunch: ~
        clover_coverage: ~
        codeception: ~
        composer: ~
        composer_normalize: ~
        composer_require_checker: ~
        composer_script: ~
        composer_validate_autoload: ~
        deptrac: ~
        doctrine_orm: ~
        ecs: ~
        eslint: ~
        file_size: ~
        gherkin: ~
        git_blacklist: ~
        git_branch_name: ~
        git_commit_message: ~
        grunt: ~
        gulp: ~
        infection: ~
        jsonlint: ~
        kahlan: ~
        mago_analyze: ~
        mago_format: ~
        mago_guard: ~
        mago_lint: ~
        make: ~
        npm_script: ~
        paratest: ~
        pest: ~
        phan: ~
        phing: ~
        php7cc: ~
        phpcpd: ~
        phpcs: ~
        phpcsfixer: ~
        phplint: ~
        phpmd: ~
        phpmd3: ~
        phpmnd: ~
        phpparser: ~
        phpspec: ~
        phpstan: ~
        phpunit: ~
        phpunitbridge: ~
        phpversion: ~
        progpilot: ~
        psalm: ~
        rector: ~
        robo: ~
        securitychecker_composeraudit: ~
        securitychecker_enlightn: ~
        securitychecker_local: ~
        securitychecker_roave: ~
        securitychecker_symfony: ~
        shell: ~
        stylelint: ~
        symfony_console: ~
        tester: ~
        twigcs: ~
        twigcsfixer: ~
        xmllint: ~
        yamllint: ~
```

--------------------------------

### Implement ExtensionInterface with imports() method

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/extensions.md

Defines a custom GrumPHP extension class that implements `GrumPHP\Extension\ExtensionInterface`. The `imports()` method yields configuration file paths (YAML, XML, INI, or directory glob) to be loaded by the container. PHP and CLOSURE loaders are not supported for PHAR compatibility.

```php
<?php
namespace My\Project;

use GrumPHP\Extension\ExtensionInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;

class MyAwesomeGrumPHPExtension implements ExtensionInterface
{
    public function imports(): iterable
    {
        $configDir = dirname(__DIR__).'/config';
    
        yield $configDir.'/my-extension.yaml';
        yield $configDir.'/my-extension.xml';
        yield $configDir.'/my-extension.ini';
        yield $configDir.'/my-extension/*';
    }
}
```

--------------------------------

### Configure Phing task in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/phing.md

Defines the Phing task under the 'phing' namespace with configurable parameters: build_file, task, and triggered_by. The build_file defaults to null (auto-loads build.xml), task defaults to null (runs default task), and triggered_by defaults to [php].

```yaml
# grumphp.yml
grumphp:
    tasks:
        phing:
            build_file: ~
            task: ~
            triggered_by: [php]
```

--------------------------------

### Run the same task twice with different configuration

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks.md

Configure an additional task with a custom name, using the metadata section to reference an existing task. This allows running the same task with different settings.

```yaml
# grumphp.yml
grumphp:
    tasks:
        phpcsfixer:
            allow_risky: true
            path_mode: intersection
        phpcsfixer_typo3:
            allow_risky: true
            config: .typo3.php-cs-fixer.php
            path_mode: intersection
            metadata:
                task: phpcsfixer
```

--------------------------------

### Configure event listeners and subscribers in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/runner.md

Configure events just like in Symfony. The listener.some_listener service is tagged with grumphp.event_listener for the grumphp.runner.run event, with an optional method and priority. The listener.some_subscriber service is tagged with grumphp.event_subscriber.

```yaml
# grumphp.yml
services:
    listener.some_listener:
        class: MyNamespace\EventListener\MyListener
        tags:
            - { name: grumphp.event_listener, event: grumphp.runner.run }
            - { name: grumphp.event_listener, event: grumphp.runner.run, method: customMethod, priority: 10 }
    listener.some_subscriber:
        class: MyNamespace\EventSubscriber\MySubscriber
        tags:
            - { name: grumphp.event_subscriber }
```

--------------------------------

### Run Git Hooks Manually

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/commands.md

These commands trigger the pre-commit and commit-msg hooks. Both accept raw git diffs or file lists via STDIN; if no STDIN is provided, they load the currently staged git diff.

```sh
php ./vendor/bin/grumphp git:pre-commit
```

```sh
php ./vendor/bin/grumphp git:commit-msg
```

--------------------------------

### Configure Robo Task in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/robo.md

Defines the Robo task under the 'robo' namespace with configurable parameters: load_from, task, and triggered_by. Defaults are null for load_from and task, and [php] for triggered_by.

```yaml
# grumphp.yml
grumphp:
    tasks:
        robo:
            load_from: ~
            task: ~
            triggered_by: [php]
```

--------------------------------

### Configure xmllint task in grumphp.yml

Source: https://github.com/phpro/grumphp/blob/v2.x/doc/tasks/xmllint.md

Configuration for the XmlLint task under the 'xmllint' namespace. All parameters are optional with defaults: ignore_patterns ([]), load_from_net (false), x_include (false), dtd_validation (false), scheme_validation (false), triggered_by (['xml']).

```yaml
# grumphp.yml
grumphp:
    tasks:
        xmllint:
            ignore_patterns: []
            load_from_net: false
            x_include: false
            dtd_validation: false
            scheme_validation: false
            triggered_by: ['xml']
```
Tokens:
Raw