Add brick/coding-standard

Author: BenMorel

.github/workflows/ci.yml

@@ -26,6 +26,12 @@ jobs:
       - name: Run Psalm
         run: vendor/bin/psalm --show-info=false --find-unused-psalm-suppress --no-progress
 
+  coding-standard:
+    name: Coding Standard
+    uses: brick/coding-standard/.github/workflows/coding-standard.yml@v2
+    with:
+      working-directory: "tools/ecs"
+
   phpunit:
     name: PHPUnit
     runs-on: ubuntu-latest

.gitignore

@@ -1,3 +1,7 @@
 /vendor
 /composer.lock
 /.phpunit.cache
+
+/tools/*
+!/tools/ecs/composer.json
+!/tools/ecs/ecs.php

tools/ecs/composer.json

@@ -0,0 +1,10 @@
+{
+    "require": {
+        "brick/coding-standard": "v2"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": false
+        }
+    }
+}

tools/ecs/ecs.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\FunctionCommentSniff;
+use PhpCsFixer\Fixer\ClassNotation\OrderedTypesFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocTypesOrderFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->import(__DIR__ . '/vendor/brick/coding-standard/ecs.php');
+
+    $libRootPath = realpath(__DIR__ . '/../../');
+
+    $ecsConfig->paths(
+        [
+            $libRootPath . '/src',
+            $libRootPath . '/tests',
+            __FILE__,
+        ],
+    );
+
+    $ecsConfig->skip([
+        $libRootPath . '/tests/Classes/*.php',
+
+        OrderedTypesFixer::class,
+        PhpdocTypesOrderFixer::class,
+
+        // fails with multiline param phpdocs
+        FunctionCommentSniff::class . '.MissingParamName',
+    ]);
+};