README

Provides a configuration factory and multiple rule sets for friendsofphp/php-cs-fixer.

Installation

Run

$ composer require --dev visual-craft/php-cs-fixer-config

Usage

Configuration

Pick one of the rule sets:

• VisualCraft\PhpCsFixerConfig\RuleSet\Php74
• VisualCraft\PhpCsFixerConfig\RuleSet\Php80
• VisualCraft\PhpCsFixerConfig\RuleSet\Php81
• VisualCraft\PhpCsFixerConfig\RuleSet\Php82
• VisualCraft\PhpCsFixerConfig\RuleSet\Php83
• VisualCraft\PhpCsFixerConfig\RuleSet\Php84
• VisualCraft\PhpCsFixerConfig\RuleSet\Php85

Create a configuration file .php-cs-fixer.dist.php in the root of your project:

<?php declare(strict_types=1); use PhpCsFixer\Finder; use VisualCraft\PhpCsFixerConfig\Factory; use VisualCraft\PhpCsFixerConfig\RuleSet\Php85; $finder = Finder::create() ->in(__DIR__ . '/src') ->append([ __DIR__ . '/.php-cs-fixer.dist.php', ]) ; $config = Factory::fromRuleSet(new Php85()); $config ->setUnsupportedPhpVersionAllowed(true) ->setFinder($finder) ->setCacheFile(__DIR__ . '/.php-cs-fixer.cache') ; return $config; 

Configuration with override rules

Optionally override rules from a rule set by passing in an array of rules to be merged in:

 <?php declare(strict_types=1); use PhpCsFixer\Finder; use VisualCraft\PhpCsFixerConfig\Factory; use VisualCraft\PhpCsFixerConfig\RuleSet\Php85; $finder = Finder::create() ->in(__DIR__ . '/src') ->in(__DIR__ . '/tests') ->in(__DIR__ . '/migrations') ->append([ __DIR__ . '/.twig_cs.dist', __DIR__ . '/.php-cs-fixer.dist.php', ]) ; -$config = Factory::fromRuleSet(new Php85()); +$config = Factory::fromRuleSet(new Php85(), [ + 'strict_comparison' => false, +]); $config ->setUnsupportedPhpVersionAllowed(true) ->setFinder($finder) ->setCacheFile(__DIR__ . '/.php-cs-fixer.cache') ; return $config; 

Composer scripts

If you like composer scripts, add a scripts to composer.json:

 { "name": "foo/bar", "require": { "php": "^8.5", }, "require-dev": { "visual-craft/php-cs-fixer-config": "*" + }, + "scripts": { + "cs-check": "vendor/bin/php-cs-fixer fix --dry-run --diff -v --ansi", + "cs-fix": "vendor/bin/php-cs-fixer fix --diff -v --ansi" } }

Run

$ composer cs-fix 

to automatically fix coding standard violations.

Run

$ composer cs-check 

to automatically show coding standard violations.

Credits

Developed by Visual Craft, inspired by ergebnis/php-cs-fixer-config.

License

This project is under the MIT license.