Refactor

Took inspiration from https://github.com/ergebnis/php-cs-fixer-config-template

Author: ruudk

.gitignore

@@ -1,2 +1,2 @@
 /vendor/
-/.php_cs.cache
+/.php-cs-fixer.cache

.php-cs-fixer.php

@@ -3,10 +3,11 @@
 declare(strict_types=1);
 
 use PhpCsFixer\Finder;
-use Ticketswap\PhpCsFixerConfig\ConfigFactory;
+use Ticketswap\PhpCsFixerConfig\PhpCsFixerConfigFactory;
+use Ticketswap\PhpCsFixerConfig\RuleSet\TicketSwapRuleSet;
 
 $finder = Finder::create()
     ->in(__DIR__ . '/src')
     ->append([__DIR__ . '/.php-cs-fixer.php']);
 
-return ConfigFactory::create()->setFinder($finder);
+return PhpCsFixerConfigFactory::create(TicketSwapRuleSet::create())->setFinder($finder);

README.md

@@ -14,20 +14,21 @@ composer require --dev ticketswap/php-cs-fixer-config
 
 Create a [`.php-cs-fixer.php`](.php-cs-fixer.php) file in the root of your project:
 
+<!-- source: .php-cs-fixer.php -->
 ```php
 <?php
 
 declare(strict_types=1);
 
 use PhpCsFixer\Finder;
-use Ticketswap\PhpCsFixerConfig\ConfigFactory;
+use Ticketswap\PhpCsFixerConfig\PhpCsFixerConfigFactory;
+use Ticketswap\PhpCsFixerConfig\RuleSet\TicketSwapRuleSet;
 
 $finder = Finder::create()
     ->in(__DIR__ . '/src')
-    ->in(__DIR__ . '/tests')
     ->append([__DIR__ . '/.php-cs-fixer.php']);
 
-return ConfigFactory::create()->setFinder($finder);
+return PhpCsFixerConfigFactory::create(TicketSwapRuleSet::create())->setFinder($finder);
 ```
 
 Adjust the paths in the `Finder` to match your project structure.
@@ -44,4 +45,4 @@ To check for violations without fixing:
 
 ```bash
 vendor/bin/php-cs-fixer check --diff
-```
+```

captainhook.json

@@ -12,6 +12,9 @@
             {
                 "action": "\\CaptainHook\\App\\Hook\\PHP\\Action\\Linting"
             },
+            {
+                "action": "\\Ruudk\\ReadmeExamplesSyncHook\\SyncReadmeExamples"
+            },
             {
                 "action": "vendor/bin/php-cs-fixer fix"
             }

composer.json

@@ -14,7 +14,8 @@
     },
     "require-dev": {
         "captainhook/captainhook-phar": "^5.25",
-        "ergebnis/composer-normalize": "^2.47"
+        "ergebnis/composer-normalize": "^2.47",
+        "ruudk/readme-examples-sync-hook": "^1.0"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ticketswap\PhpCsFixerConfig;
+
+use PhpCsFixer\Fixer\FixerInterface;
+
+final readonly class Fixers
+{
+    /**
+     * @var list<FixerInterface>
+     */
+    public array $value;
+
+    public function __construct(
+        FixerInterface ...$value,
+    ) {
+        $this->value = array_values($value);
+    }
+
+    public function merge(self $customFixers) : self
+    {
+        return new self(...$this->value, ...$customFixers->value);
+    }
+}

src/Fixers.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ticketswap\PhpCsFixerConfig;
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+use RuntimeException;
+
+final class PhpCsFixerConfigFactory
+{
+    /**
+     * Creates a configuration based on a rule set.
+     *
+     * @throws RuntimeException
+     */
+    public static function create(RuleSet $ruleSet) : Config
+    {
+        $config = new Config($ruleSet->name);
+
+        $config->setUnsupportedPhpVersionAllowed(true);
+        $config->registerCustomFixers($ruleSet->customFixers->value);
+        $config->setParallelConfig(ParallelConfigFactory::detect());
+        $config->setRiskyAllowed(true);
+        $config->setRules($ruleSet->rules->value);
+
+        return $config;
+    }
+}

src/PhpCsFixerConfigFactory.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ticketswap\PhpCsFixerConfig;
+
+final readonly class RuleSet
+{
+    public function __construct(
+        public Fixers $customFixers,
+        public string $name,
+        public Rules $rules,
+    ) {}
+
+    /**
+     * Returns a new rule set with custom fixers.
+     */
+    public function withCustomFixers(Fixers $customFixers) : self
+    {
+        return new self(
+            $this->customFixers->merge($customFixers),
+            $this->name,
+            $this->rules,
+        );
+    }
+
+    /**
+     * Returns a new rule set with merged rules.
+     */
+    public function withRules(Rules $rules) : self
+    {
+        return new self(
+            $this->customFixers,
+            $this->name,
+            $this->rules->merge($rules),
+        );
+    }
+}

src/RuleSet.php

@@ -2,11 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Ticketswap\PhpCsFixerConfig;
+namespace Ticketswap\PhpCsFixerConfig\RuleSet;
 
 use ErickSkrauch\PhpCsFixer\Fixer\Whitespace\LineBreakAfterStatementsFixer;
-use PhpCsFixer\Config;
-use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 use PhpCsFixer\WhitespacesFixerConfig;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer;
@@ -27,13 +25,14 @@
 use Symplify\CodingStandard\TokenRunner\Traverser\ArrayBlockInfoFinder;
 use Symplify\CodingStandard\TokenRunner\Whitespace\IndentResolver;
 use Symplify\CodingStandard\TokenRunner\Wrapper\FixerWrapper\ArrayWrapperFactory;
+use Ticketswap\PhpCsFixerConfig\Fixers;
+use Ticketswap\PhpCsFixerConfig\NameWrapper;
+use Ticketswap\PhpCsFixerConfig\Rules;
+use Ticketswap\PhpCsFixerConfig\RuleSet;
 
-final readonly class ConfigFactory
+final class TicketSwapRuleSet
 {
-    /**
-     * @param array<string, array<string, mixed>|bool> $rules
-     */
-    public static function create(array $rules = []) : Config
+    public static function create() : RuleSet
     {
         $whitespacesFixerConfig = new WhitespacesFixerConfig('    ', "\n");
         $blockfinder = new BlockFinder();
@@ -52,11 +51,8 @@ public static function create(array $rules = []) : Config
         $paramNewliner = new ParamNewliner($blockfinder, $tokensNewliner);
         $methodNameResolver = new MethodNameResolver();
 
-        return new Config()
-            ->setUnsupportedPhpVersionAllowed(true)
-            ->setCacheFile('.php_cs.cache')
-            ->setRiskyAllowed(true)
-            ->registerCustomFixers([
+        return new RuleSet(
+            new Fixers(
                 new NameWrapper(
                     new LineBreakAfterStatementsFixer(),
                     'ErickSkrauch/line_break_after_statements',
@@ -77,9 +73,9 @@ public static function create(array $rules = []) : Config
                     new StandaloneLineConstructorParamFixer($paramNewliner, $methodNameResolver),
                     'Symplify/standalone_line_constructor_param_fixer',
                 ),
-            ])
-            ->setParallelConfig(ParallelConfigFactory::detect())
-            ->setRules([
+            ),
+            'TicketSwap',
+            new Rules([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'Symplify/array_list_item_newline_fixer' => true,
                 'Symplify/array_opener_and_closer_newline_fixer' => true,
@@ -284,8 +280,7 @@ public static function create(array $rules = []) : Config
                     'identical' => false,
                     'less_and_greater' => null,
                 ],
-
-                ...$rules,
-            ]);
+            ]),
+        );
     }
 }