phpcsfixer-preset
This package allows you to use the same php-cs-fixer formatting rules across all of your projects without copy-and-pasting configuration files. There's also a quick setup script to automatically generate a configuration file for your project structure and preferred formatting preset.
zvive/fixer provides several opinionated php-cs-fixer configuration choices as well as
pre-configured
Finder classes for common project formats and use cases.
Supported PHP versions: 8.1.
The original concept for this package came from this excellent article on sharing php-cs-fixer configurations across projects written by Tim Mcdonald.
composer require zvive/fixer --dev
This example uses the Laravel project finder and the Default Ruleset:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
use Zvive\Fixer\Finders\LaravelProjectFinder;
use Zvive\Fixer\Rulesets\DefaultRuleset;
use Zvive\Fixer\SharedConfig;
$finder = LaravelProjectFinder::create(__DIR__);
return SharedConfig::create($finder, new ZviveRuleset());Standard PhpCsFixer\Finder options can be chained onto the custom Finder class to customize it to your preferences:
// ...
$finder = LaravelProjectFinder::create(__DIR__)
->in([__DIR__ . '/custom-src-dir'])
->notName('*.ignored.php')
->notPath('another-custom-dir/cache/*');
// ...You can also use the standard PhpCsFixer\Finder class along with any of the Rulesets:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
use PhpCsFixer\Finder;
use Zvive\Fixer\Rulesets\SpatieRuleset;
use Zvive\Fixer\SharedConfig;
$finder = Finder::create()
->ignoreVCS(true)
->ignoreDotFiles(true)
->name('*.php')
->in([
__DIR__ . '/src',
__DIR__ . '/tests',
])
->exclude(__DIR__ . '/vendor');
return SharedConfig::create($finder, new SpatieRuleset());When creating a Ruleset class, you may pass an array of php-cs-fixer rules that will add or override the ruleset's default rules.
<?php
require_once(__DIR__.'/vendor/autoload.php');
use Zvive\Fixer\Finders\LaravelProjectFinder;
use Zvive\Fixer\Rulesets\DefaultRuleset;
use Zvive\Fixer\SharedConfig;
$finder = LaravelProjectFinder::create(__DIR__);
return SharedConfig::create($finder, new ZviveRuleset([
// existing rules can be overridden:
'no_break_comment' => true,
'no_closing_tag' => false,
// new rules can be added:
'a_new_option' => [
'some_sub_option' => 12,
],
]));To generate a php-cs-fixer configuration file for your project, run:
vendor/bin/pf-create-cs-config <type> [-o|--outfile=filename] [-r|--ruleset=name] [-f|--force]Parameter: <type>
Required: yes
Default: no default
Possible values:
customprojectpackagelaravel(alias for laravel:project)laravel:projectlaravel:package
Flag: --outfile (or -o)
Required: no
Default: .php-cs-fixer.dist.php
Possible values: any valid filename
Flag: --ruleset (or -r)
Required: no
Default: default
Possible values:
defaultlaravel_shiftphp_unitspatie
Flag: --force (or -f)
Required: no
Default: false
Possible values: none
Effect: overwrites any existing configuration file
Examples:
vendor/bin/pf-create-cs-config laravel:package
vendor/bin/pf-create-cs-config package -f
vendor/bin/pf-create-cs-config laravel -o .php-cs-fixer.php -r spatie
vendor/bin/pf-create-cs-config project --ruleset=laravel_shift
vendor/bin/pf-create-cs-config custom --outfile=.my-configNote on the custom type:
The custom type will prompt you to enter the directory names you'd like php-cs-fixer to include and exclude. The generated configuration file implements the PhpCsFixer\Finder class instead of one of the preconfigured finder classes.
If you would like to automatically apply php-cs-fixer formatting using Github Actions, see the automation with Github Actions documentation.
- ignores VCS files
- ignores dot files
- includes PHP files
- excludes
vendor/directory
- inherits
BasicProjectFinderpresets - excludes
*.blade.phpfiles - excludes all files in
bootstrap/,public/,resources/,storage/ - includes PHP files in
app/,config/,database/,routes/,tests/
- inherits
BasicProjectFinderpresets - excludes
*.blade.phpfiles - excludes all files in
resources/ - includes PHP files in
src/,tests/,config/
- inherits
BasicProjectFinderpresets - includes PHP files in
src/,tests/
-
The default opinionated Ruleset provided by this package.
- Ruleset used by Laravel Shift.
- View Rules
- Ruleset used by PHPUnit.
- View Rules
- Ruleset used by SpatieRuleset.
- View Rules
Select a Finder preset or create an instance of \PhpCsFixer\Finder and return SharedConfig::create($finder) from the .php-cs-fixer.dist.php file.
Update the rules() method in the Zvive\Fixer\Rulesets\DefaultRuleset class.
Create a class that implements the Zvive\Fixer\Rulesets\Ruleset interface, returning your rules from the rules() method.
Sample Ruleset:
<?php
namespace Zvive\Fixer\Rulesets;
class MyCustomRulesRuleset implements RuleSet
{
public function allowRisky(): bool
{
return true; //this tells php-cs-fixer whether or not to permit "risky" rules.
}
public static function name(): string
{
return 'my_custom_rules'; //the name should omit 'ruleset' from the end.
}
/**
* @return array
*/
public function rules(): array
{
return array_merge([
'@PSR2' => true,
// additional php-cs-fixer rules
], $this->additional); //it's important that the additional rules property is merged
}
}If adding a new Ruleset to this package, the Ruleset must be registered in \Zvive\Fixer\Commands\GenerateConfigCommand@rulesets() to allow the quick setup command to use it.
If creating a new Ruleset package for your own use, follow the above example but use a namespace unique to your package.
To format all files specified in the configuration, run:
vendor/bin/php-cs-fixer fix
To see which files will be formatted without making any changes, run:
vendor/bin/php-cs-fixer fix --dry-run
This package uses PHPUnit for unit tests. To run the test suite, run:
./vendor/bin/phpunit
Please see CHANGELOG for more information on what has changed recently.
Contributions of Rulesets, Finders, bugfixes, suggestions, or improvements are welcomed. Please open an appropriately labeled issue or pull request for any of these.
The MIT License (MIT). Please see License File for more information.