mainlycode / code-quality
Project for standardising and enforcing coding standards
This package's canonical repository appears to be gone and the package has been frozen as a result. Email us for help if needed.
Installs: 285
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/mainlycode/code-quality
Requires
- phpro/grumphp: ~0.11
- phpunit/phpunit: ^5.2
- sensiolabs/security-checker: ^3.0||^4.0
- simgroep/coding-standards: ^2.0
This package is auto-updated.
Last update: 2019-11-30 11:25:01 UTC
README
Project for standardising and enforcing coding standards.
Components
- phpro/grumphp: runs all code quality check on a pre commit git hook
- phpunit/phpunit: runs unit tests and functional tests (when available) in your project
- simgroep/coding-standards: defines the coding standards used by SIMgroep
- sensiolabs/security-checker: checks your composer.lock for known security issues
Installation
composer require --dev mainlycode/code-quality
cp vendor/mainlycode/code-quality/grumphp.yml.dist ./grumphp.yml
The commit hook for GrumPHP is automatically installed on composer require.
Usage
- The code quality checks are run every time you commit.
- You can run the checks manually with:
./bin/grumphp run
Usage in Continuous Integration
You can easily use the code quality checkers on your CI (Jenkins/GitLab CI) by added this line:
./bin/grumphp run --no-ansi --no-interaction