linkorb / conventions-checker

v1.2.0 2019-12-20 06:20 UTC

Requires

• phpro/grumphp: ~0.3.5
• phpunit/phpunit: ~4.6|^8.0

MIT

• LinkORB Engineering Team
• Igor Mukhin

Published on Packagist.org on 2019-12-20 06:20 UTC

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's type ("application" or default "library") and update composer.json's extra
• Branded ASCII
• Distribute it as separate linkorb-checker.phar (Maybe?)