Setup PHP-CS-Fixer config and pipeline

Author: uuf6429

.gitattributes

@@ -1,8 +1,9 @@
-/.github/           export-ignore
-/bin/               export-ignore
-/tests/             export-ignore
-/.editorconfig      export-ignore
-/.gitattributes     export-ignore
-/.gitignore         export-ignore
-/CONTRIBUTING.md    export-ignore
-/phpunit.dist.xml   export-ignore
+/.github/                   export-ignore
+/bin/                       export-ignore
+/tests/                     export-ignore
+/.editorconfig              export-ignore
+/.gitattributes             export-ignore
+/.gitignore                 export-ignore
+/CONTRIBUTING.md            export-ignore
+/phpunit.dist.xml           export-ignore
+/.php-cs-fixer.dist.php     export-ignore

.github/workflows/build.yml

@@ -8,6 +8,22 @@ on:
     types: [ created ]
 
 jobs:
+  check_code_style:
+    name: Check code style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          php-version: '8.3'
+
+      - name: Install dependencies
+        run: composer update
+
+      - run: ./vendor/bin/php-cs-fixer fix --dry-run --diff --show-progress=dots
+
   tests:
     runs-on: ubuntu-latest
     name: Build and test

.gitignore

@@ -4,3 +4,5 @@ composer.lock
 .phpunit.cache
 .phpunit.result.cache
 phpunit.xml
+.php-cs-fixer.php
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,29 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+    ->notPath('i18n.php');
+
+return (new PhpCsFixer\Config())
+    ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+    ->setRules([
+        '@PER-CS' => true,
+        '@Symfony' => true,
+        'header_comment' => [
+            'header' => <<<'TEXT'
+                This file is part of the Behat Gherkin Parser.
+                (c) Konstantin Kudryashov <ever.zet@gmail.com>
+                
+                For the full copyright and license information, please view the LICENSE
+                file that was distributed with this source code.
+                TEXT
+        ],
+        'yoda_style' => [
+            'equal' => false,
+            'identical' => false,
+            'less_and_greater' => false,
+        ],
+        'concat_space' => ['spacing' => 'one'],
+        'phpdoc_align' => ['align' => 'left'],
+    ])
+    ->setFinder($finder);

CONTRIBUTING.md

@@ -27,6 +27,14 @@ We use automated tools to ensure that the code has a consistent style and is of
 composer lint
 ```
 
+## Automated Fixes
+
+Some problems detected by the linting tools can be fixed automatically. Simply run the following:
+
+```shell
+composer fix
+```
+
 ## Contributing to Gherkin Translations
 
 Gherkin supports →40 different languages and you could add more! You might notice `i18n.php` file in the root of

composer.json

@@ -20,7 +20,8 @@
     "require-dev": {
         "symfony/yaml": "^5.4 || ^6.4 || ^7.0",
         "phpunit/phpunit": "^10.5",
-        "cucumber/cucumber": "dev-gherkin-24.1.0"
+        "cucumber/cucumber": "dev-gherkin-24.1.0",
+        "friendsofphp/php-cs-fixer": "^3.65"
     },
 
     "suggest": {
@@ -67,11 +68,21 @@
 
     "scripts": {
         "lint": [
-            "Composer\\Config::disableProcessTimeout"
+            "Composer\\Config::disableProcessTimeout",
+            "vendor/bin/php-cs-fixer fix --dry-run --diff --show-progress=dots"
         ],
         "test": [
             "Composer\\Config::disableProcessTimeout",
             "vendor/bin/phpunit ./tests"
+        ],
+        "fix": [
+            "Composer\\Config::disableProcessTimeout",
+            "vendor/bin/php-cs-fixer fix --diff --show-progress=dots"
         ]
+    },
+    "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": false
+        }
     }
 }