ose / magento2-grumphp
GRUMPHP Configuration for Magento 2
1.2.4
2023-09-15 06:27 UTC
Requires
- php: ~7.4.0||~8.1.0
- ose/magento2-phpcs: ^1.2
- php-parallel-lint/php-parallel-lint: ^1.3
- phpmd/phpmd: ^2.13
- phpro/grumphp: ^2.0
README
Installation
composer require --dev ose/magento2-grumphp
DO NOT create a grumphp.yml
file in the root directory when you are be prompted, delete it if created.
Add the following to your composer.json
"extra": {
"grumphp": {
"config-default-path": "vendor/ose/magento2-grumphp/src/grumphp.yml"
}
}
and run composer install
to apply the changes.
Usage
- Make sure that your changes are in GIT staging area.
- When you want to commit your changes, type.
./vendor/bin/grumphp git:pre-commit
to run tasks defined in
grumphp.yml
only on the code from the commit. This command will be also run when you try to do a commit - it uses git pre-commit hook.
Built-in tasks
This package has pre-defined configuration of grumphp.yml
file, thanks for that you can install
and just use it. Currently, the package contains these tasks :
- jsonlint
- xmllint
- phplint
- yamllint
- composer
- phpcs
- phpmd
- phpstan - Currently the level is set to 6
- git_blacklist - This task checks if a developer didn't use one of blacklisted words like
var_dump
orconsole.log
Compatibility
- Magento >= 2.4.2
- PHP version >= 7.2 || >= 8.1