Add coding standard (#28)

.github/workflows/ci.yaml

@@ -58,6 +58,9 @@ jobs:
             -   name: "Check for security vulnerabilities"
                 run: symfony security:check
 
+            -   name: "Validate coding standard"
+                run: vendor/bin/ecs check
+
             -   name: "Validate Container"
                 run: bin/console lint:container
 

composer.json

@@ -38,6 +38,7 @@
         "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-symfony": "^1.3",
         "phpunit/phpunit": "^9.6",
+        "sylius-labs/coding-standard": "^4.0",
         "symfony/console": "^6.4 || ^7.0",
         "symfony/debug-bundle": "^6.4 || ^7.0",
         "symfony/dom-crawler": "^6.4 || ^7.0",
@@ -72,7 +73,8 @@
     "config": {
         "allow-plugins": {
             "symfony/flex": true,
-            "symfony/runtime": true
+            "symfony/runtime": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
         },
         "sort-packages": true
     },

ecs.php

@@ -0,0 +1,32 @@
+<?php
+
+use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
+use PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer;
+use SlevomatCodingStandard\Sniffs\Commenting\InlineDocCommentDeclarationSniff;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
+        __DIR__ . '/src',
+    ]);
+
+    $ecsConfig->import('vendor/sylius-labs/coding-standard/ecs.php');
+
+    $ecsConfig->ruleWithConfiguration(HeaderCommentFixer::class, [
+            'location' => 'after_open',
+            'header' =>
+'This file is part of the Sylius package.
+
+(c) Sylius Sp. z o.o.
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.',
+        ])
+    ;
+    $ecsConfig->ruleWithConfiguration(NoSuperfluousPhpdocTagsFixer::class, ['allow_mixed' => true]);
+
+    $ecsConfig->skip([
+        InlineDocCommentDeclarationSniff::class . '.MissingVariable',
+        '**/var/*',
+    ]);
+};

src/TwigExtra/config/services.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;

src/TwigExtra/src/Symfony/DependencyInjection/Configuration.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\TwigExtra\Symfony\DependencyInjection;

src/TwigExtra/src/Symfony/DependencyInjection/TwigExtraExtension.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\TwigExtra\Symfony\DependencyInjection;

src/TwigExtra/src/Symfony/TwigExtraBundle.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\TwigExtra\Symfony;

src/TwigExtra/src/Twig/Extension/SortByExtension.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\TwigExtra\Twig\Extension;

src/TwigExtra/src/Twig/Extension/TestFormAttributeExtension.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\TwigExtra\Twig\Extension;

src/TwigExtra/src/Twig/Extension/TestHtmlAttributeExtension.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\TwigExtra\Twig\Extension;

src/TwigExtra/src/Twig/Ux/ComponentTemplateFinder.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Sylius\TwigExtra\Twig\Ux;
@@ -42,6 +51,6 @@ private function getTemplatePath(string $name, string $prefixName, string $prefi
 
     private function normalizeName(string $name, string $prefixName): string
     {
-        return str_replace(':', '/',  str_replace($prefixName, '', $name));
+        return str_replace(':', '/', str_replace($prefixName, '', $name));
     }
 }

src/TwigExtra/tests/Functional/Twig/Extension/SortByExtensionTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Functional\Twig\Extension;

src/TwigExtra/tests/Functional/Twig/Extension/TestFormAttributeExtensionTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Functional\Twig\Extension;

src/TwigExtra/tests/Functional/Twig/Extension/TestHtmlAttributeExtensionTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Functional\Twig\Extension;

src/TwigExtra/tests/Integration/DependencyInjection/TwigExtraExtensionTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Integration\DependencyInjection;
@@ -48,7 +57,7 @@ public function testItThrowsAnErrorWhenTryingToRegisterNonStringPath(): void
                     ],
                 ],
             ],
-            'Invalid configuration for path "sylius_twig_extra.twig_ux.anonymous_component_template_prefixes": Path must be a string. "bool" given.'
+            'Invalid configuration for path "sylius_twig_extra.twig_ux.anonymous_component_template_prefixes": Path must be a string. "bool" given.',
         );
     }
 

src/TwigExtra/tests/Unit/Twig/Extension/SortByExtensionTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Unit\Twig\Extension;
@@ -122,8 +131,8 @@ public function testItSortsAnArrayOfObjectsInDescendingOrderByAProperty(): void
     public function testItSortsAnArrayOfObjectsByANestedProperty(): void
     {
         $firstData = (object) ['data' => (object) ['number' => 3]];
-        $secondData = (object) ['data' =>  (object) ['number' => 5]];
-        $thirdData = (object) ['data' =>  (object) ['number' => 1]];
+        $secondData = (object) ['data' => (object) ['number' => 5]];
+        $thirdData = (object) ['data' => (object) ['number' => 1]];
 
         $arrayBeforeSorting = [
             $firstData,
@@ -141,8 +150,8 @@ public function testItSortsAnArrayOfObjectsByANestedProperty(): void
     public function testItSortsAnArrayOfArraysByANestedProperty(): void
     {
         $firstData = ['data' => ['number' => 3]];
-        $secondData = ['data' =>  ['number' => 5]];
-        $thirdData = ['data' =>  ['number' => 1]];
+        $secondData = ['data' => ['number' => 5]];
+        $thirdData = ['data' => ['number' => 1]];
 
         $arrayBeforeSorting = [
             $firstData,

src/TwigExtra/tests/Unit/Twig/Extension/TestFormAttributeExtensionTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Unit\Twig\Extension;

src/TwigExtra/tests/Unit/Twig/Extension/TestHtmlAttributeExtensionTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Unit\Twig\Extension;

src/TwigExtra/tests/Unit/Twig/Ux/ComponentTemplateFinderTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 namespace Tests\Sylius\TwigExtra\Unit\Twig\Ux;

src/TwigHooks/config/services.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Sylius\TwigHooks\Hook\Normalizer\Name\CompositeNameNormalizer;

src/TwigHooks/config/services/debug/twig_events.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Sylius\TwigHooks\Hook\Renderer\Debug\HookDebugCommentRenderer;

src/TwigHooks/config/services/hook_renderer.php

@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Sylius\TwigHooks\Hook\Renderer\HookRenderer;