feat: implement php-cs

Signed-off-by: Vitor Mattos <[email protected]>

Author: vitormattos

.github/workflows/lint-php-cs.yml

@@ -0,0 +1,53 @@
+name: Lint php-cs
+
+on: pull_request
+
+permissions:
+  contents: read
+
+concurrency:
+  group: lint-php-cs-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php:
+          - "8.1"
+          - "8.2"
+          - "8.3"
+          - "8.4"
+
+    name: php-cs
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - name: Set up php${{ matrix.php }}
+        uses: shivammathur/setup-php@ec406be512d7077f68eed36e63f4d91bc006edc4 # v2.35.4
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+          ini-file: development
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache composer cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: Lint
+        run: composer cs:check || ( echo 'Please run `composer run cs:fix` to format your code' && exit 1 )

.gitignore

@@ -3,5 +3,6 @@ composer.lock
 /vendor/
 /vendor-bin/**/vendor/
 *.swp
+.php-cs-fixer.cache
 .phpunit.result.cache
 /tests/logs

.php-cs-fixer.dist.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+require_once './vendor-bin/coding-standard/vendor/autoload.php';
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+$config = new Config();
+$config
+	->setParallelConfig(ParallelConfigFactory::detect())
+	->getFinder()
+	->ignoreVCSIgnored(true)
+	->notPath('vendor')
+	->notPath('vendor-bin')
+	->in(__DIR__);
+return $config;

composer.json

@@ -31,6 +31,8 @@
     "scripts": {
         "bin": "echo 'bin not installed'",
         "lint": "find . -name \\*.php -not -path './vendor/*' -not -path './vendor-bin/*' -print0 | xargs -0 -n1 php -l",
+        "cs:check": "php-cs-fixer fix --dry-run --diff",
+        "cs:fix": "php-cs-fixer fix",
         "post-install-cmd": [
             "@composer bin all install --ansi",
             "composer dump-autoload"

vendor-bin/coding-standard/composer.json

@@ -0,0 +1,10 @@
+{
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.86"
+    },
+    "config": {
+        "platform": {
+            "php": "8.1"
+        }
+    }
+}