Fix #184: Replace StyleCI with PHP CS Fixer (#216)

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

Author: rustamwin

.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,29 @@
+<?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 . '/config',
+        $root . '/src',
+        $root . '/tests',
+    ])
+    ->append([
+        $root . '/public/index.php',
+    ]);
+
+return (new Config())
+    ->setCacheFile(__DIR__ . '/runtime/cache/.php-cs-fixer.cache')
+    ->setParallelConfig(ParallelConfigFactory::detect())
+    ->setRules([
+        '@PER-CS2.0' => true,
+        'no_unused_imports' => true,
+    ])
+    ->setFinder($finder);

.php-cs-fixer.php

@@ -29,6 +29,9 @@ exec: ## Run a command within the existing container.
 run: ## Run a command within a temporary container.
 	docker compose -f docker/compose.yml -f docker/compose.dev.yml run --rm --entrypoint $(CMD) app $(RUN_ARGS)
 
+cs-fix: ## Run PHP CS Fixer
+	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
+
 shell: CMD="/bin/sh" ## Get into container shell.
 shell: exec
 

.styleci.yml

@@ -83,11 +83,12 @@
         "codeception/module-db": "^3.2.2",
         "codeception/module-phpbrowser": "^3.0.1",
         "codeception/module-rest": "^3.4.1",
+        "friendsofphp/php-cs-fixer": "^3.75",
         "maglnet/composer-require-checker": "^4.16.1",
         "phpunit/phpunit": "^11.5.28",
+        "rector/rector": "^2.1.2",
         "roave/infection-static-analysis-plugin": "^1.38",
         "spatie/phpunit-watcher": "^1.24",
-        "rector/rector": "^2.1.2",
         "vimeo/psalm": "^6.13.0",
         "yiisoft/json": "^1.0",
         "yiisoft/yii-debug-api": "dev-master"

Makefile

@@ -24,7 +24,7 @@
         ->routes(
             Route::get('')
                 ->middleware(FormatDataResponseAsHtml::class)
-                ->action(fn (SwaggerUi $swaggerUi) => $swaggerUi->withJsonUrl('/docs/openapi.json')),
+                ->action(fn(SwaggerUi $swaggerUi) => $swaggerUi->withJsonUrl('/docs/openapi.json')),
             Route::get('/openapi.json')
                 ->middleware(FormatDataResponseAsJson::class)
                 ->middleware(CorsAllowAllMiddleware::class)

composer.json

@@ -8,7 +8,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Yiisoft\DataResponse\DataResponseFactoryInterface;
 
-#[OA\Info(title:'Yii API application', version:'1.0')]
+#[OA\Info(title: 'Yii API application', version: '1.0')]
 final class IndexController
 {
     #[OA\Get(
@@ -17,8 +17,8 @@ final class IndexController
         summary: 'Returns info about the API',
         responses: [
             new OA\Response(
-                response:'200',
-                description:'Success',
+                response: '200',
+                description: 'Success',
                 content: new OA\JsonContent(
                     allOf: [
                         new OA\Schema(ref: '#/components/schemas/Response'),
@@ -28,10 +28,10 @@ final class IndexController
                                 new OA\Property(property: 'author', type: 'string', example: 'yiisoft'),
                             ], type: 'object'),
                         ]),
-                    ]
+                    ],
                 ),
             ),
-        ]
+        ],
     )]
     public function index(DataResponseFactoryInterface $responseFactory): ResponseInterface
     {

config/common/routes.php

@@ -4,6 +4,4 @@
 
 namespace App\Exception;
 
-interface ApplicationException extends \Throwable
-{
-}
+interface ApplicationException extends \Throwable {}

src/Controller/IndexController.php

@@ -7,7 +7,7 @@
 use OpenApi\Attributes as OA;
 
 #[OA\Schema(
-    schema: 'Response'
+    schema: 'Response',
 )]
 #[OA\Schema(
     schema: 'BadResponse',
@@ -19,37 +19,37 @@
             new OA\Property(property: 'error_code', example: '400', nullable: true),
             new OA\Property(property: 'data', example: null),
         ]),
-    ]
+    ],
 )]
 final class ApiResponseData
 {
     #[OA\Property(
         property: 'status',
         format: 'string',
         enum: ['success', 'failed'],
-        example: 'success'
+        example: 'success',
     )]
     private string $status = '';
 
     #[OA\Property(
         property: 'error_message',
         format: 'string',
-        example: ''
+        example: '',
     )]
     private string $errorMessage = '';
 
     #[OA\Property(
         property: 'error_code',
         format: 'integer',
         example: null,
-        nullable: true
+        nullable: true,
     )]
     private ?int $errorCode = null;
 
     #[OA\Property(
         property: 'data',
         type: 'object',
-        nullable: true
+        nullable: true,
     )]
     private ?array $data = null;