justijndepover / php-check
Helper package to fix coding styles and run unit testing
Requires
- friendsofphp/php-cs-fixer: ^3.0
- symfony/console: ^5.2
- symfony/filesystem: ^5.2
README
Installation
You can install the package with composer
composer require justijndepover/php-check --dev
First usage
After installing the package, you should add a php-cs-fixer config file to your project.
The script will automatically detect the presence of the file. If none exists, you will be prompted to install one.
./vendor/bin/php-check
Usage
The gist of the package is to have a global script that checks your code for possible syntax errors and bugs. Run this script before you push your changes.
This package provides:
- a global set of php-cs-fixer rules
- an option to check your code for possible syntax errors
- an option to fix your syntax errors
- an option to run phpunit
- an option to run all checks
The script is interactive, so you only have to run it.
./vendor/bin/php-check
Related repositories
- timacdonald/php-style: inspiration for this package
Security
If you find any security related issues, please open an issue or contact me directly at justijndepover@gmail.com.
Contribution
If you wish to make any changes or improvements to the package, feel free to make a pull request.
License
The MIT License (MIT). Please see License File for more information.