Merge pull request #18 from bwaidelich/task/switch-to-php-cs-fixer

TASK: Switch to PHP CS Fixer

Author: bwaidelich

.php-cs-fixer.dist.php

@@ -0,0 +1,16 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__);
+
+return (new PhpCsFixer\Config())
+    ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+    ->setRules([
+        '@PER-CS' => true,
+        'single_quote' => true,
+        'no_unused_imports' => true,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const']],
+        'nullable_type_declaration' => ['syntax' => 'union'],
+        'no_extra_blank_lines' => true,
+    ])
+    ->setFinder($finder);

composer.json

@@ -27,7 +27,7 @@
   "require-dev": {
     "roave/security-advisories": "dev-latest",
     "phpstan/phpstan": "^2",
-    "squizlabs/php_codesniffer": "^4.0.x-dev",
+    "friendsofphp/php-cs-fixer": "^3.88",
     "phpunit/phpunit": "^11"
   },
   "autoload": {
@@ -42,8 +42,8 @@
   },
   "scripts": {
     "test:phpstan": "phpstan",
-    "test:cs": "phpcs --colors src",
-    "test:cs:fix": "phpcbf --colors src",
+    "test:cs": "vendor/bin/php-cs-fixer check",
+    "test:cs:fix": "vendor/bin/php-cs-fixer fix",
     "test:unit": "phpunit tests/Unit",
     "test:integration": "phpunit tests/Integration --exclude-group=feature_liveStream --exclude-group=feature_appendConditionWithoutMatchingEvent",
     "test": [

phpcs.xml

@@ -22,7 +22,7 @@ interface EventStore
      * @param StreamQuery $query The StreamQuery filter every event has to match
      * @param ReadOptions|null $options optional configuration for this interaction ({@see ReadOptions})
      */
-    public function read(StreamQuery $query, ?ReadOptions $options = null): EventStream;
+    public function read(StreamQuery $query, ReadOptions|null $options = null): EventStream;
 
     /**
      * Commits the specified $events if the specified {@see AppendCondition} is satisfied

src/EventStore.php

@@ -20,5 +20,5 @@ interface EventStream extends IteratorAggregate
      */
     public function getIterator(): Traversable;
 
-    public function first(): ?EventEnvelope;
+    public function first(): EventEnvelope|null;
 }

src/EventStream.php

@@ -4,7 +4,6 @@
 
 namespace Wwwision\DCBEventStore\Helpers;
 
-use DateTimeImmutable;
 use Psr\Clock\ClockInterface;
 use Wwwision\DCBEventStore\EventStore;
 use Wwwision\DCBEventStore\Exceptions\ConditionalAppendFailed;
@@ -45,7 +44,7 @@ public static function create(ClockInterface|null $clock = null): self
         return new self($clock ?? new SystemClock());
     }
 
-    public function read(StreamQuery $query, ?ReadOptions $options = null): InMemoryEventStream
+    public function read(StreamQuery $query, ReadOptions|null $options = null): InMemoryEventStream
     {
         $options ??= ReadOptions::create();
 
@@ -113,7 +112,7 @@ public function append(Events|Event $events, AppendCondition $condition): void
                     $sequenceNumber,
                     $this->clock->now(),
                     $event,
-                )
+                ),
             );
             $sequenceNumber = $sequenceNumber->next();
         }

src/Helpers/InMemoryEventStore.php

@@ -21,8 +21,7 @@ final class InMemoryEventStream implements EventStream
      */
     private function __construct(
         private readonly array $eventEnvelopes,
-    ) {
-    }
+    ) {}
 
     public static function create(EventEnvelope ...$events): self
     {
@@ -41,7 +40,7 @@ public function getIterator(): Traversable
         }
     }
 
-    public function first(): ?EventEnvelope
+    public function first(): EventEnvelope|null
     {
         return $this->eventEnvelopes[array_key_first($this->eventEnvelopes)] ?? null;
     }

src/Helpers/InMemoryEventStream.php

@@ -15,8 +15,7 @@ final class AppendCondition
     public function __construct(
         public readonly StreamQuery $query,
         public readonly ExpectedHighestSequenceNumber $expectedHighestSequenceNumber,
-    ) {
-    }
+    ) {}
 
     public static function noConstraints(): self
     {

src/Types/AppendCondition.php

@@ -17,8 +17,7 @@ private function __construct(
         public readonly EventData $data, // opaque, no size limit?
         public readonly Tags $tags,
         public readonly EventMetadata $metadata,
-    ) {
-    }
+    ) {}
 
     /**
      * @param EventData|array<mixed>|string $data

src/Types/Event.php

@@ -16,8 +16,7 @@ final class EventData implements JsonSerializable
 {
     private function __construct(
         public readonly string $value,
-    ) {
-    }
+    ) {}
 
     public static function fromString(string $value): self
     {