linkorb / conventions-checker
Pilot project to automatically check LinkORB conventions
v1.2.0
2019-12-20 06:20 UTC
Requires
- phpro/grumphp: ~0.3.5
- phpunit/phpunit: ~4.6|^8.0
README
Make automatic conventions checking on each commit.
Installaion
1. Add path to grumphp configuration file to your composer.json
's extra:
For application project:
"extra": {
"grumphp": {
"config-default-path": "vendor/linkorb/conventions-checker/config/app/grumphp.yml"
}
}
For library project:
"extra": {
"grumphp": {
"config-default-path": "vendor/linkorb/conventions-checker/config/lib/grumphp.yml"
}
}
2. Add checker to your composer.json
:
composer require --dev linkorb/conventions-checker
Usage
Just commit some changes and you see warnings if you don't follow conventions.
TODO
- Automatic project type definition by
composer.json
'stype
("application" or default "library") and updatecomposer.json
's extra - Branded ASCII
- Distribute it as separate
linkorb-checker.phar
(Maybe?)