Add ECS

Author: BenMorel

.github/workflows/coding-standard.yml

@@ -0,0 +1,12 @@
+name: Coding Standard
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  coding-standard:
+    name: Coding Standard
+    uses: brick/coding-standard/.github/workflows/coding-standard.yml@main
+    with:
+        php-version: "8.2"

.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": "dev-main"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
+}

tools/ecs/ecs.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+use PHP_CodeSniffer\Standards\Squiz\Sniffs\Commenting\FunctionCommentSniff;
+use PhpCsFixer\Fixer\ClassNotation\OrderedTypesFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocTypesOrderFixer;
+use SlevomatCodingStandard\Sniffs\Commenting\DocCommentSpacingSniff;
+use SlevomatCodingStandard\Sniffs\Namespaces\UseSpacingSniff;
+use SlevomatCodingStandard\Sniffs\Whitespaces\DuplicateSpacesSniff;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->import(__DIR__ . '/vendor/brick/coding-standard/ecs.php');
+
+    $libRootPath = __DIR__ . '/../../';
+
+    $ecsConfig->paths(
+        [
+            $libRootPath . '/src',
+            $libRootPath . '/tests',
+            __FILE__,
+        ],
+    );
+
+    $ecsConfig->indentation('spaces');
+
+    $ecsConfig->skip([
+        // Only interested in FunctionCommentSniff.ParamCommentFullStop, excludes the rest
+        FunctionCommentSniff::class . '.Missing' => null,
+        FunctionCommentSniff::class . '.MissingReturn' => null,
+        FunctionCommentSniff::class . '.MissingParamTag' => null,
+        FunctionCommentSniff::class . '.EmptyThrows' => null,
+        FunctionCommentSniff::class . '.IncorrectParamVarName' => null,
+        FunctionCommentSniff::class . '.IncorrectTypeHint' => null,
+        FunctionCommentSniff::class . '.MissingParamComment' => null,
+        FunctionCommentSniff::class . '.ParamNameNoMatch' => null,
+        FunctionCommentSniff::class . '.InvalidReturn' => null,
+
+        // Allows alignment in test providers
+        DuplicateSpacesSniff::class => [$libRootPath . '/tests'],
+
+        // Keep a line between same use types, spacing around uses is done in other fixers
+        UseSpacingSniff::class . '.IncorrectLinesCountBeforeFirstUse' => null,
+        UseSpacingSniff::class . '.IncorrectLinesCountAfterLastUse' => null,
+
+        // We want to keep BigNumber|int|float|string order
+        OrderedTypesFixer::class => null,
+        PhpdocTypesOrderFixer::class => null,
+
+        // Fails with @ pure @ codeCoverageIgnore on successive lines
+        DocCommentSpacingSniff::class . '.IncorrectAnnotationsGroup' => null,
+    ]);
+};