A PHP-CS-Fixer bridge for use via Artisan CLI on Laravel.
The PHP Coding Standards Fixer tool fixes most issues in your code when you want to follow the PHP coding standards as defined in the PSR-1 and PSR-2 documents and many more.
If you are already using a linter to identify coding standards problems in your code, you know that fixing them by hand is tedious, especially on large projects. This tool does not only detect them, but also fixes them for you.
These are introductions from authors who created PHP-CS-Fixer and this package is a PHP-CS-Fixer bridge for use via Artisan CLI on Laravel. From now on, you can easily use PHP-CS-Fixer differently for each Laravel project with your team instead of installing a global fixer.
- Use PHP-CS-Fixer differently for each Laravel project.
- Run PHP-CS-Fixer command via Laravel Artisan CLI.
- Easily export the fixer configuration to set up or share with team.
Look at one of the following topics to learn more about Artisan PHP CS Fixer
- Versions and compatibility
- Exclusion of the cache file
- PHP CS Fixer official documentation
- Thanks from author
Artisan PHP CS Fixer don't support Laravel 4.x. Currently, this package have following branchs compatible with Laravel 5.x:
|1.x||5.0 - 5.2|
|2.x||5.3 and later|
Note: This documentation is use for Laravel 5.3 and later.
You can install this package through Composer.
- First, edit your project's
composer.jsonfile to require
jackiedo/artisan-php-cs-fixer. Add following line to the
- Next step, we run Composer update commend from the Terminal on your project source directory:
$ composer update
Note: Instead of performing the above two steps, you can perform faster with the command line
$ composer require jackiedo/artisan-php-cs-fixer:2.*from Terminal
- Once install/update operation completes, the final step is add the service provider. Open
config/app.php, and add a new item to the
Note: From Laravel 5.1, you should write as
Display PHP-CS-Fixer version installed.
$ php artisan php-cs-fixer:version
Fix your code with PHP Coding Standards.
$ php artisan php-cs-fixer:fix [options] [path/to/dir/or/file]
// Only shows which all files in your project would have been modified, leaving your files unchanged. $ php artisan php-cs-fixer:fix --dry-run // Really fixes all files in your project. $ php artisan php-cs-fixer:fix // Only fixes all files in the `app` directory $ php artisan php-cs-fixer:fix app // Only fixes all files in the `app` directory with specific configuration file $ php artisan php-cs-fixer:fix --config="path/to/config/file" app
Display description of rule or set.
$ php artisan php-cs-fixer:describe name/of/rule/or/set
Display README content of PHP-CS-Fixer.
$ php artisan php-cs-fixer:readme
To change the configuration of the fixer with your own purpose, you need publish the configuration file with the artisan
vendor:publish as follow:
$ php artisan vendor:publish --provider="Jackiedo\ArtisanPhpCsFixer\ArtisanPhpCsFixerServiceProvider"
This will create one file named
.php_cs in the root directory of your project. This file is returned an instance of
PhpCsFixer\ConfigInterface which lets you configure the rules, the files and directories that need to be analyzed. From now and then, you can share this file with all of your developing team members. The rest is you have to think of a way to always sync this file for your team.
Whenever you run the artisan
php-cs-fixer:fix command, one file with named
.php_cs.cache will be created at the root directory of your project. You can exclude this file by append following line into
MIT © Jackie Do
For more documentation about PHP CS Fixer, you can visit here.
Hopefully, this package is useful to you.