refactor: Use friendsofphp/php-cs-fixer instead of squizlabs/php_code…

…sniffer (#22)
roadiz · Nov 6, 2024 · e53f8c9 · e53f8c9
1 parent 080ef62
commit e53f8c9
Show file tree

Hide file tree

Showing 1,105 changed files with 8,166 additions and 16,396 deletions.
diff --git a/.github/workflows/run-test.yml b/.github/workflows/run-test.yml
@@ -43,7 +43,7 @@ jobs:
                   XDEBUG_MODE=coverage vendor/bin/phpunit -v
             - name: Run PHP Code Sniffer
               run: |
-                  php -d "memory_limit=-1" vendor/bin/phpcs --report=full -p
+                  php -d "memory_limit=-1" vendor/bin/php-cs-fixer check --ansi -vvv
             - name: Run PHP Stan
               run: |
                   php -d "memory_limit=-1" vendor/bin/phpstan analyse -c phpstan.neon

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-
 # Created by https://www.toptal.com/developers/gitignore/api/phpstorm
 # Edit at https://www.toptal.com/developers/gitignore?templates=phpstorm
 
@@ -155,15 +154,15 @@ fabric.properties
 !/.data/db_test/.gitkeep
 !/.data/pgsql_test/.gitkeep
 !/.data/solr/.gitkeep
-
-###> squizlabs/php_codesniffer ###
-/.phpcs-cache
-/phpcs.xml
-###< squizlabs/php_codesniffer ###
 /report.txt
 /composer.lock
 /symfony.lock
 
 ###> lexik/jwt-authentication-bundle ###
 /config/jwt/*.pem
 ###< lexik/jwt-authentication-bundle ###
+
+###> friendsofphp/php-cs-fixer ###
+/.php-cs-fixer.php
+/.php-cs-fixer.cache
+###< friendsofphp/php-cs-fixer ###
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,17 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+    ->exclude(['var', 'vendor', 'docker', 'lib/EntityGenerator/tests/Mocks', 'config'])
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@Symfony' => true,
+        'blank_line_after_opening_tag' => true,
+        'declare_strict_types' => true,
+    ])
+    ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+    ->setRiskyAllowed(true)
+    ->setFinder($finder)
+;
diff --git a/.phpcs.xml b/.phpcs.xml
diff --git a/Makefile b/Makefile
@@ -6,7 +6,7 @@ test:
 	vendor/bin/monorepo-builder validate
 	make phpstan
 	XDEBUG_MODE=coverage vendor/bin/phpunit -v
-	php -d "memory_limit=-1" vendor/bin/phpcs -p
+	php -d "memory_limit=-1" vendor/bin/php-cs-fixer check --ansi -vvv
 	php -d "memory_limit=-1" bin/console lint:twig ./lib/Documents/src/Resources/views
 	php -d "memory_limit=-1" bin/console lint:twig ./lib/RoadizCoreBundle/templates
 	php -d "memory_limit=-1" bin/console lint:twig ./lib/RoadizFontBundle/templates
@@ -19,7 +19,10 @@ phpunit:
 	APP_ENV=test docker compose exec -u www-data app php vendor/bin/phpunit -v
 
 fix:
-	php -d "memory_limit=-1" vendor/bin/phpcbf -p
+	php -d "memory_limit=-1" vendor/bin/php-cs-fixer fix --ansi -vvv
+
+check:
+	php -d "memory_limit=-1" vendor/bin/php-cs-fixer check --ansi -vvv
 
 requirements:
 	vendor/bin/requirements-checker

diff --git a/composer.json b/composer.json
@@ -141,6 +141,7 @@
         "ambroisemaupate/intervention-request": "^4.0",
         "async-aws/simple-s3": "^1.1",
         "doctrine/doctrine-fixtures-bundle": "^3.6",
+        "friendsofphp/php-cs-fixer": "^3.64",
         "league/flysystem-async-aws-s3": "^3.10",
         "league/flysystem-aws-s3-v3": "^3.10",
         "php-coveralls/php-coveralls": "^2.4",
@@ -149,7 +150,6 @@
         "phpstan/phpstan-symfony": "^1.1.8",
         "phpunit/phpunit": "^9.5",
         "rector/rector": "^0.14.5",
-        "squizlabs/php_codesniffer": "^3.5",
         "symfony/browser-kit": "6.4.*",
         "symfony/css-selector": "6.4.*",
         "symfony/debug-bundle": "6.4.*",

diff --git a/config/bundles.php b/config/bundles.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
     Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
     Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle::class => ['all' => true],

diff --git a/config/preload.php b/config/preload.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 if (file_exists(dirname(__DIR__).'/var/cache/prod/App_KernelProdContainer.preload.php')) {
     require dirname(__DIR__).'/var/cache/prod/App_KernelProdContainer.preload.php';
 }
diff --git a/lib/DocGenerator/.github/workflows/run-test.yml b/lib/DocGenerator/.github/workflows/run-test.yml
@@ -35,7 +35,5 @@ jobs:
                       ${{ runner.os }}-php-${{ matrix.php-version }}-
             - name: Install Dependencies
               run: composer install --no-scripts --no-ansi --no-interaction --no-progress
-            - name: Run PHP Code Sniffer
-              run: vendor/bin/phpcs -p ./src
             - name: Run PHPStan
               run: vendor/bin/phpstan analyse --no-progress -c phpstan.neon
diff --git a/lib/DocGenerator/Makefile b/lib/DocGenerator/Makefile
diff --git a/lib/DocGenerator/composer.json b/lib/DocGenerator/composer.json
@@ -23,8 +23,7 @@
         }
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3",
-        "squizlabs/php_codesniffer": "^3.5"
+        "phpstan/phpstan": "^1.5.3"
     },
     "extra": {
         "branch-alias": {

diff --git a/lib/DocGenerator/phpcs.xml.dist b/lib/DocGenerator/phpcs.xml.dist
diff --git a/lib/DocGenerator/src/Generators/AbstractFieldGenerator.php b/lib/DocGenerator/src/Generators/AbstractFieldGenerator.php
@@ -15,17 +15,11 @@ abstract class AbstractFieldGenerator
     protected ParameterBag $nodeTypesBag;
     protected MarkdownGeneratorFactory $markdownGeneratorFactory;
 
-    /**
-     * @param MarkdownGeneratorFactory $fieldGeneratorFactory
-     * @param NodeTypeFieldInterface $field
-     * @param ParameterBag $nodeTypesBag
-     * @param TranslatorInterface $translator
-     */
     public function __construct(
         MarkdownGeneratorFactory $fieldGeneratorFactory,
         NodeTypeFieldInterface $field,
         ParameterBag $nodeTypesBag,
-        TranslatorInterface $translator
+        TranslatorInterface $translator,
     ) {
         $this->field = $field;
         $this->nodeTypesBag = $nodeTypesBag;
@@ -35,13 +29,10 @@ public function __construct(
 
     abstract public function getContents(): string;
 
-    /**
-     * @return string
-     */
     public function getIntroduction(): string
     {
         $lines = [
-            '### ' . $this->field->getLabel(),
+            '### '.$this->field->getLabel(),
         ];
         if (!empty($this->field->getDescription())) {
             $lines[] = $this->field->getDescription();
@@ -50,19 +41,19 @@ public function getIntroduction(): string
             '',
             '|     |     |',
             '| --- | --- |',
-            '| **' . trim($this->translator->trans('docs.type')) . '** | ' . $this->translator->trans($this->field->getTypeName()) . ' |',
-            '| **' . trim($this->translator->trans('docs.technical_name')) . '** | `' . $this->field->getVarName() . '` |',
-            '| **' . trim($this->translator->trans('docs.universal')) . '** | *' . $this->markdownGeneratorFactory->getHumanBool($this->field->isUniversal()) . '* |',
+            '| **'.trim($this->translator->trans('docs.type')).'** | '.$this->translator->trans($this->field->getTypeName()).' |',
+            '| **'.trim($this->translator->trans('docs.technical_name')).'** | `'.$this->field->getVarName().'` |',
+            '| **'.trim($this->translator->trans('docs.universal')).'** | *'.$this->markdownGeneratorFactory->getHumanBool($this->field->isUniversal()).'* |',
         ]);
 
         if (!empty($this->field->getGroupName())) {
-            $lines[] = '| **' . trim($this->translator->trans('docs.group')) . '** | ' . $this->field->getGroupName() . ' |';
+            $lines[] = '| **'.trim($this->translator->trans('docs.group')).'** | '.$this->field->getGroupName().' |';
         }
 
         if (!$this->field->isVisible()) {
-            $lines[] = '| **' . trim($this->translator->trans('docs.visible')) . '** | *' . $this->markdownGeneratorFactory->getHumanBool($this->field->isVisible()) . '* |';
+            $lines[] = '| **'.trim($this->translator->trans('docs.visible')).'** | *'.$this->markdownGeneratorFactory->getHumanBool($this->field->isVisible()).'* |';
         }
 
-        return implode("\n", $lines) . "\n";
+        return implode("\n", $lines)."\n";
     }
 }
diff --git a/lib/DocGenerator/src/Generators/ChildrenNodeFieldGenerator.php b/lib/DocGenerator/src/Generators/ChildrenNodeFieldGenerator.php
@@ -12,8 +12,8 @@ public function getContents(): string
     {
         return implode("\n\n", [
             $this->getIntroduction(),
-            '#### ' . $this->translator->trans('docs.available_children_blocks'),
-            $this->getAvailableChildren()
+            '#### '.$this->translator->trans('docs.available_children_blocks'),
+            $this->getAvailableChildren(),
         ]);
     }
 
@@ -25,20 +25,23 @@ protected function getChildrenNodeTypes(): array
         if (null !== $this->field->getDefaultValues()) {
             return array_filter(array_map(function (string $nodeTypeName) {
                 $nodeType = $this->nodeTypesBag->get(trim($nodeTypeName));
+
                 return $nodeType instanceof NodeTypeInterface ? $nodeType : null;
             }, explode(',', $this->field->getDefaultValues())));
         }
+
         return [];
     }
 
     protected function getAvailableChildren(): string
     {
         return implode("\n", array_map(function (NodeTypeInterface $nodeType) {
             $nodeTypeGenerator = $this->markdownGeneratorFactory->createForNodeType($nodeType);
+
             return implode("\n", [
-                '* **' . trim($nodeTypeGenerator->getMenuEntry()) . '**    ',
+                '* **'.trim($nodeTypeGenerator->getMenuEntry()).'**    ',
                 $nodeType->getDescription(),
             ]);
-        }, $this->getChildrenNodeTypes())) . "\n";
+        }, $this->getChildrenNodeTypes()))."\n";
     }
 }
diff --git a/lib/DocGenerator/src/Generators/CommonFieldGenerator.php b/lib/DocGenerator/src/Generators/CommonFieldGenerator.php
@@ -9,7 +9,7 @@ final class CommonFieldGenerator extends AbstractFieldGenerator
     public function getContents(): string
     {
         return implode("\n\n", [
-            $this->getIntroduction()
+            $this->getIntroduction(),
         ]);
     }
 }
diff --git a/lib/DocGenerator/src/Generators/DefaultValuedFieldGenerator.php b/lib/DocGenerator/src/Generators/DefaultValuedFieldGenerator.php
@@ -10,16 +10,16 @@ public function getContents(): string
     {
         return implode("\n\n", [
             $this->getIntroduction(),
-            $this->getDefaultValues()
+            $this->getDefaultValues(),
         ]);
     }
 
     private function getDefaultValues(): string
     {
         return implode("\n", array_map(function (string $value) {
             return implode("\n", [
-                '* **' . trim($this->translator->trans(trim($value))) . '** `' . $value . '`',
+                '* **'.trim($this->translator->trans(trim($value))).'** `'.$value.'`',
             ]);
-        }, explode(',', $this->field->getDefaultValues() ?? ''))) . "\n";
+        }, explode(',', $this->field->getDefaultValues() ?? '')))."\n";
     }
 }
diff --git a/lib/DocGenerator/src/Generators/DocumentationGenerator.php b/lib/DocGenerator/src/Generators/DocumentationGenerator.php
@@ -16,10 +16,6 @@ class DocumentationGenerator
     private ?array $reachableTypeGenerators = null;
     private ?array $nonReachableTypeGenerators = null;
 
-    /**
-     * @param ParameterBag $nodeTypesBag
-     * @param TranslatorInterface $translator
-     */
     public function __construct(ParameterBag $nodeTypesBag, TranslatorInterface $translator)
     {
         $this->nodeTypesBag = $nodeTypesBag;
@@ -65,6 +61,7 @@ public function getReachableTypeGenerators(): array
                 return $this->markdownGeneratorFactory->createForNodeType($nodeType);
             }, $this->getReachableTypes());
         }
+
         return $this->reachableTypeGenerators;
     }
 
@@ -78,6 +75,7 @@ public function getNonReachableTypeGenerators(): array
                 return $this->markdownGeneratorFactory->createForNodeType($nodeType);
             }, $this->getNonReachableTypes());
         }
+
         return $this->nonReachableTypeGenerators;
     }
 
@@ -103,10 +101,10 @@ public function getNavBar(): string
         }
 
         return implode("\n", [
-            '* ' . $this->translator->trans('docs.pages'),
-            "    * " . implode("\n    * ", $pages),
-            '* ' . $this->translator->trans('docs.blocks'),
-            "    * " . implode("\n    * ", $blocks)
+            '* '.$this->translator->trans('docs.pages'),
+            '    * '.implode("\n    * ", $pages),
+            '* '.$this->translator->trans('docs.blocks'),
+            '    * '.implode("\n    * ", $blocks),
         ]);
     }
 }
diff --git a/lib/DocGenerator/src/Generators/MarkdownGeneratorFactory.php b/lib/DocGenerator/src/Generators/MarkdownGeneratorFactory.php
@@ -13,7 +13,7 @@ final class MarkdownGeneratorFactory
 {
     public function __construct(
         private readonly ParameterBag $nodeTypesBag,
-        private readonly TranslatorInterface $translator
+        private readonly TranslatorInterface $translator,
     ) {
     }
 
@@ -22,11 +22,6 @@ public function getHumanBool(bool $bool): string
         return $bool ? $this->translator->trans('docs.yes') : $this->translator->trans('docs.no');
     }
 
-    /**
-     * @param NodeTypeInterface $nodeType
-     *
-     * @return NodeTypeGenerator
-     */
     public function createForNodeType(NodeTypeInterface $nodeType): NodeTypeGenerator
     {
         return new NodeTypeGenerator(
@@ -36,11 +31,6 @@ public function createForNodeType(NodeTypeInterface $nodeType): NodeTypeGenerato
         );
     }
 
-    /**
-     * @param NodeTypeFieldInterface $field
-     *
-     * @return AbstractFieldGenerator
-     */
     public function createForNodeTypeField(NodeTypeFieldInterface $field): AbstractFieldGenerator
     {
         return match (true) {

diff --git a/lib/DocGenerator/src/Generators/NodeReferencesFieldGenerator.php b/lib/DocGenerator/src/Generators/NodeReferencesFieldGenerator.php
@@ -10,8 +10,8 @@ public function getContents(): string
     {
         return implode("\n\n", [
             $this->getIntroduction(),
-            '#### ' . $this->translator->trans('docs.available_referenced_nodes'),
-            $this->getAvailableChildren()
+            '#### '.$this->translator->trans('docs.available_referenced_nodes'),
+            $this->getAvailableChildren(),
         ]);
     }
 }