https://github.com/linkorb/conventions-checker
https://github.com/linkorb/conventions-checker
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/linkorb/conventions-checker
- Owner: linkorb
- Created: 2015-09-01T07:55:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-12-20T06:20:39.000Z (over 5 years ago)
- Last Synced: 2025-03-28T10:47:32.686Z (2 months ago)
- Language: PHP
- Size: 10.7 KB
- Stars: 4
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Goal
Make automatic [conventions](CONVENTIONS.md) 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](CONVENTIONS.md).
## 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?)