How can I create a custom rule set for php-cs-fixer?

Question

How to create custom ruleset to be run by fix command with option --rules=@custom?

Like @PSR1, @PSR2, @Symfony, @PHP56Migration, @PHP70Migration, @PHP71Migration are made.

Php-cs-fixer version: 2.2.3

Only by inserting into vendor code -vendor/friendsofphp/php-cs-fixer/src/RuleSet.php:

private $setDefinitions = array(
        '@custom' => [
        'some_custom_fixer` => true,
        ]
)

Works as I expect, but RuleSet is final class. Is there a way to override or extend the setDefinitions when using custom config .php_cs?

Why not simplify list specific fixers? What exactly is your goal? — Tomas Votruba, Jun 27 '17 at 22:32
Like that: https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/2884 — J. Doe, Jun 29 '17 at 07:26

score 6 · Answer 1 · answered Jun 25 '17 at 07:14

Currently, there is no way to register custom ruleset how you register custom fixer. Although that, we were already thinking that it would be nice to introduce it, yet it is not a prio on our todo list. Feel free to write proposal how it shall be handled, and PR after initial discussion. https://github.com/FriendsOfPHP/PHP-CS-Fixer/

score 3 · Answer 2 · edited Aug 12 '22 at 10:08

3

In the meanwhile, create your own configuration instead and share it across projects.

For example:

edited Aug 12 '22 at 10:08

simhumileco

31,877
16
137
115

answered Jun 25 '17 at 08:19

localheinz

9,179
2
33
44

How can I create a custom rule set for php-cs-fixer?

2 Answers2