library conventions-checker

linkorb/conventions-checker

Pilot project to automatically check LinkORB conventions

Goal

Make automatic conventions checking on each commit., _(*1)

Installaion

1. Add path to grumphp configuration file to your composer.json's extra:

For application project:, _(*2)

    "extra": {
        "grumphp": {
            "config-default-path": "vendor/linkorb/conventions-checker/config/app/grumphp.yml"
        }
    }

For library project:, _(*3)

    "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., _(*4)

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?)