eduarguz / shift-php-cs
PHP CS Fixer - Laravel Coding Style Ruleset
Installs: 23 537
Dependents: 22
Suggesters: 0
Security: 0
Stars: 11
Watchers: 2
Forks: 7
Open Issues: 0
Requires
- php: >=7.0
- friendsofphp/php-cs-fixer: ^3.0
This package is auto-updated.
Last update: 2024-09-07 20:10:03 UTC
README
This package allows you to use the set of rules for PHP CS Fixer created and recommended by Laravel Shift.
You can find the original and official source of the ruleset in this gist.
Installation
You can install the ruleset via composer using the following command:
composer require --dev eduarguz/shift-php-cs
This package will also require the ^3.0
version of friendsofphp/php-cs-fixer
package .
Usage
This package only gives you easy access to the recommended ruleset. The common and usual PHP-CS-Fixer setup is still required:
In case you don't have one, create your .php-cs-fixer.php
file.
touch .php-cs-fixer.php
Put your Finder
config inside. This will tell PHP-CS-Fixer where to run.
Usually, for a Laravel Project this is the config:
<?php use PhpCsFixer\Finder; $project_path = getcwd(); $finder = Finder::create() ->in([ $project_path . '/app', $project_path . '/config', $project_path . '/database', $project_path . '/resources', $project_path . '/routes', $project_path . '/tests', ]) ->name('*.php') ->notName('*.blade.php') ->ignoreDotFiles(true) ->ignoreVCS(true); return \ShiftCS\styles($finder);
Run your fixer.
./vendor/bin/php-cs-fixer fix
Run on CI
./vendor/bin/php-cs-fixer fix --dry-run
Upgrade from 1.x to 3.x version of this package (to PHP-CS-Fixer 3.x)
composer require --dev eduarguz/shift-php-cs
Rename any of your existing files:
.php_cs
-> .php-cs-fixer.php
.php_cs.dist
-> .php-cs-fixer.dist.php
.php_cs.cache
-> .php-cs-fixer.cache
Resources
- Sharing PHP-CS-Fixer rules across projects and teams. Laravel News Article
- Laravel Shift Recommended Coding Ruleset. Gist - Shift