Replace StyleCI to PHP CS Fixer (#356)

Author: vjik

.github/workflows/cs.yml

@@ -0,0 +1,48 @@
+name: Code Style
+
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'psalm.xml'
+
+jobs:
+  cs-fix:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.YIISOFT_GITHUB_TOKEN }}
+          ref: ${{ github.head_ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          tools: composer:v2
+          coverage: none
+
+      - name: Install Composer dependencies
+        uses: "ramsey/composer-install@v3"
+
+      - name: Run PHP CS Fixer
+        run: ./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php
+
+      - name: Run Rector
+        run: ./vendor/bin/rector --output-format=github
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Apply PHP CS Fixer and Rector changes (CI)"
+          file_pattern: '*.php'
+          disable_globbing: true

.github/workflows/rector.yml

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+ini_set('memory_limit', '512M');
+
+$root = __DIR__;
+$finder = (new Finder())
+    ->in([
+        $root . '/src',
+        $root . '/tests',
+    ])
+    ->append([
+        $root . '/public/index.php',
+    ]);
+
+return (new Config())
+    ->setCacheFile(__DIR__ . '/runtime/.php-cs-fixer.cache')
+    ->setParallelConfig(ParallelConfigFactory::detect())
+    ->setRules([
+        '@PER-CS2.0' => true,
+        'no_unused_imports' => true,
+    ])
+    ->setFinder($finder);

.php-cs-fixer.php

@@ -50,6 +50,9 @@ psalm: run
 rector: CMD="./vendor/bin/rector" ## Run Rector.
 rector: run
 
+cs-fix:
+	docker compose -f docker/compose.yml -f docker/compose.dev.yml run --rm --entrypoint ./vendor/bin/php-cs-fixer app fix --config=.php-cs-fixer.php --diff
+
 build-prod: ## Build an image.
 	docker build --file docker/Dockerfile --target prod --pull -t ${IMAGE}:${IMAGE_TAG} .
 

.styleci.yml

@@ -84,6 +84,7 @@
         "codeception/module-asserts": "^3.2",
         "codeception/module-cli": "^2.0.1",
         "codeception/module-phpbrowser": "^3.0.1",
+        "friendsofphp/php-cs-fixer": "^3.75",
         "maglnet/composer-require-checker": "^4.16.1",
         "rector/rector": "^2.1.0",
         "roave/infection-static-analysis-plugin": "^1.38",

Makefile

@@ -65,7 +65,7 @@ private static function setEnvironment(): void
         $environment = self::getRawValue('APP_ENV');
         if (!in_array($environment, [self::DEV, self::TEST, self::PROD], true)) {
             throw new RuntimeException(
-                sprintf('"%s" is invalid environment.', $environment ?? '')
+                sprintf('"%s" is invalid environment.', $environment ?? ''),
             );
         }
         self::$values['APP_ENV'] = $environment;

composer.json

@@ -17,7 +17,7 @@ final class NotFoundHandler implements RequestHandlerInterface
     public function __construct(
         private readonly UrlGeneratorInterface $urlGenerator,
         private readonly CurrentRoute $currentRoute,
-        private ViewRenderer $viewRenderer
+        private ViewRenderer $viewRenderer,
     ) {
         $this->viewRenderer = $viewRenderer->withControllerName('site');
     }

src/Environment.php

@@ -26,7 +26,7 @@ private static function chmodRecursive(string $path, int $mode): void
         /** @psalm-var iterable<array-key, string> $iterator */
         $iterator = new RIterator(
             new DirIterator($path, FSIterator::SKIP_DOTS | FSIterator::CURRENT_AS_PATHNAME),
-            RIterator::SELF_FIRST
+            RIterator::SELF_FIRST,
         );
 
         foreach ($iterator as $item) {

src/Handler/NotFoundHandler.php

@@ -13,8 +13,7 @@
     public function __construct(
         private ApplicationParameters $applicationParameters,
         private UrlGeneratorInterface $urlGenerator,
-    ) {
-    }
+    ) {}
 
     public function getCommonParameters(): array
     {