Creates laravel artisan commands to validate your application's sourcecode with php -l, phpmd and phpcs.
Publishes predefined style rulesets into config/ for customization.
Install via Composer
$ composer require --dev dodger451/laravelcodecheckerThen copy the default config files to /config by running
php artisan vendor:publish --tag=laravelcodecheckerThis will create some rulesets for phpmd and phpcs in config/
config/
laravelcodechecker.php
phpcs/
ruleset.xml
phpmd/
rulesets/
cleancode.xml
codesize.xml
controversial.xml
design.xml
naming.xml
unusedcode.xmlAdopt the rules in phpcs/ruleset.xml and phpmd/rulesets/*.xml to your preferences, the cc: commands will use them per default.
To change the default rulefiles, modify config/laravelcodechecker.php
To validate the application with all checks, run
php artisan cc:allThis will run php -l, phpmd and phpcs on all .php files in tests/ routes/ config/ and app/.
Alternatively, run each separately:
php artisan cc:phplint
php artisan cc:phpcs
php artisan cc:phpmdPer default, each command will target tests routes config app.
You can provide dirs and/or files as arguments to each cc: command,
if you don't want to use the default targets in config/laravelcodechecker.php
E.g. to limit phpmd to the directories tests/ and app/ run
php artisan cc:phpmd tests appTo change the default targets per command, modify laravelcodechecker.php
Example .travis.yml for travis-ci.org
language: php
php:
- '7.1'
- '7.2'
- nightly
install:
- composer install
script:
- php artisan cc:all
Please see the changelog for more information on what has changed recently.
Please see contributing.md for details and a todolist.
If you discover any security related issues, please email author email instead of using the issue tracker.
- [david latotzky][https://www.linkedin.com/in/david-latotzky/]
license. Please see the license file for more information.
[link-styleci]: https://styleci.io/repos/154905196)] [link-author]: https://github.com/dodger451