php-code-style
Code style configuration for friendsofphp/php-cs-fixer based on PSR-12.
Installation
Step 1 of 3
Install gomzyakov/php-code-style via composer:
composer require --dev gomzyakov/php-code-style
The base package friendsofphp/php-cs-fixer will be installed automatically.
Step 2 of 3
Then create file .php-cs-fixer.dist.php at the root of your project with following contents:
<?php
use Gomzyakov\CS\Finder;
use Gomzyakov\CS\Config;
// Routes for analysis with `php-cs-fixer`
$routes = ['./src', './tests'];
return Config::createWithFinder(Finder::createWithRoutes($routes));
Change the value of $routes depending on where your project's source code is.
Step 3 of 3
And that's it! You can now find code style violations with following command:
./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --dry-run
And then completely fix them all with:
./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php
Configuration
You must pass a set of routes to the Finder::createWithRoutes() call. For example, for Laravel projects, this would be:
Finder::createWithRoutes(['./app', './config', './database', './resources', './routes', './tests'])
Also, you can pass a custom set of rules to the Config::createWithFinder() call:
Config::createWithFinder($finder, [
'@PHP81Migration' => true,
'array_indentation' => false
])
Support
If you find any package errors, please, make an issue in current repository.
License
This is open-sourced software licensed under the MIT License.
37 Jan 2, 2023
16 Jun 7, 2022
7 Aug 14, 2022
1.1k Jan 6, 2023
4 Nov 29, 2022
43 Dec 26, 2022
3 Nov 19, 2022
257 Dec 24, 2022
10 May 31, 2023
219 Dec 13, 2022
73 Apr 1, 2022
30 Jul 30, 2020
16 Nov 29, 2022
1 Dec 14, 2021
6 Oct 27, 2020
2.4k Jan 6, 2023
2 Mar 8, 2022