Setup symplify/easy-coding-standard (#1305)

Signed-off-by: Nathanael Esayeas <nathanael.esayeas@protonmail.com>

.gitattributes

@@ -6,10 +6,8 @@
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.php_cs export-ignore
-.php-cs-fixer.dist.php export-ignore
-.styleci.yml export-ignore
 codecov.yml export-ignore
+ecs.php export-ignore
 Makefile export-ignore
 phpunit.xml.dist export-ignore
 psalm-baseline.xml export-ignore

.gitignore

@@ -3,7 +3,6 @@
 *~
 .cache/
 .idea/*
-.php_cs.cache
 .phpdoc/
 .phpunit.result.cache
 build/

composer.json

@@ -51,6 +51,7 @@
     "require-dev": {
         "phpunit/phpunit": "^8.5 || ^9.3",
         "psalm/plugin-phpunit": "^0.18.4",
+        "symplify/easy-coding-standard": "^11.5.0",
         "vimeo/psalm": "^5.13.1"
     },
     "conflict": {
@@ -85,9 +86,16 @@
     "scripts": {
         "check": [
             "@composer validate",
+            "@ecs",
             "@test"
         ],
         "docs": "vendor/bin/phpdoc -d src -t docs/api",
+        "ecs": [
+            "@ecs:fix",
+            "@ecs:check"
+        ],
+        "ecs:check": "ecs check --clear-cache || true",
+        "ecs:fix": "ecs check --clear-cache --fix",
         "phpunit": "vendor/bin/phpunit --colors=always --testdox --stop-on-failure",
         "phpunit:coverage": "vendor/bin/phpunit --colors=always --testdox --stop-on-failure --coverage-clover=coverage.xml",
         "psalm": [

ecs.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
+use PhpCsFixer\Fixer\Casing\ConstantCaseFixer;
+use PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer;
+use PhpCsFixer\Fixer\ClassNotation\OrderedInterfacesFixer;
+use PhpCsFixer\Fixer\Import\GlobalNamespaceImportFixer;
+use PhpCsFixer\Fixer\Import\OrderedImportsFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer;
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitTestCaseStaticMethodCallsFixer;
+use PhpCsFixer\Fixer\Semicolon\NoEmptyStatementFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+
+return function (ECSConfig $ecsConfig): void {
+    $ecsConfig->parallel();
+
+    $ecsConfig->sets([
+        SetList::ARRAY,
+        SetList::CLEAN_CODE,
+        SetList::COMMON,
+        SetList::CONTROL_STRUCTURES,
+        SetList::NAMESPACES,
+        SetList::PSR_12,
+        SetList::DOCBLOCK,
+        SetList::PHPUNIT,
+        SetList::SPACES,
+        SetList::STRICT,
+    ]);
+
+    $ecsConfig->rules([
+        NoEmptyStatementFixer::class,
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(GlobalNamespaceImportFixer::class, [
+        'import_classes' => true,
+        'import_constants' => true,
+        'import_functions' => true,
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(OrderedImportsFixer::class, [
+        'imports_order' => ['class', 'const', 'function'],
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(PhpdocAlignFixer::class, [
+        'tags' => ['method', 'param', 'property', 'return', 'throws', 'type', 'var'],
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(PhpUnitTestCaseStaticMethodCallsFixer::class, [
+        'call_type' => 'self',
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(ArraySyntaxFixer::class, [
+        'syntax' => 'short',
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(ConstantCaseFixer::class, [
+        'case' => 'lower',
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(OrderedClassElementsFixer::class, [
+        'sort_algorithm' => 'alpha',
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(OrderedInterfacesFixer::class, [
+        'order' => 'alpha',
+    ]);
+
+    $ecsConfig->paths([
+        __FILE__,
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    $ecsConfig->skip([
+        __DIR__ . '/src/Mockery/Mock.php',
+        __DIR__ . '/tests/Fixture/*',
+        __DIR__ . '/tests/Mockery/*', // skip temporarily, it still has legacy code
+    ]);
+};