feat: add cs-fixer (#230)

* feat: add cs-fixer * ci: add php-cs-fixer job
FriendsOfShopware · Nov 10, 2023 · 628f8bb · 628f8bb
1 parent cc69fcd
commit 628f8bb
Show file tree

Hide file tree

Showing 65 changed files with 169 additions and 108 deletions.
diff --git a/.github/workflows/code-style.yml b/.github/workflows/code-style.yml
@@ -0,0 +1,10 @@
+name: Code Style
+on:
+    pull_request:
+    push:
+        branches:
+            - main
+
+jobs:
+    php-cs-fixer:
+        uses: FriendsOfShopware/actions/.github/workflows/php-cs-fixer.yml@main
diff --git a/composer.json b/composer.json
@@ -41,5 +41,8 @@
     "allow-plugins": {
       "symfony/runtime": true
     }
+  },
+  "scripts": {
+    "cs-fix": "docker run --rm -v $(pwd):$(pwd) -w $(pwd) oskarstark/php-cs-fixer-ga --rules @PER-CS2.0,@PER-CS2.0:risky --allow-risky=yes ."
   }
 }
diff --git a/src/Command/ChangeUserPasswordCommand.php b/src/Command/ChangeUserPasswordCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;

diff --git a/src/Command/DevRobotsTxtCommand.php b/src/Command/DevRobotsTxtCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;
@@ -15,7 +16,8 @@
 class DevRobotsTxtCommand extends Command
 {
     public function __construct(
-        #[Autowire('%kernel.project_dir%/public')] private readonly string $envPath
+        #[Autowire('%kernel.project_dir%/public')]
+        private readonly string $envPath
     ) {
         parent::__construct();
     }

diff --git a/src/Command/EnvDelCommand.php b/src/Command/EnvDelCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;
@@ -16,7 +17,8 @@
 class EnvDelCommand extends Command
 {
     public function __construct(
-        #[Autowire('%kernel.project_dir%/.env')] private readonly string $envPath
+        #[Autowire('%kernel.project_dir%/.env')]
+        private readonly string $envPath
     ) {
         parent::__construct();
     }

diff --git a/src/Command/EnvGetCommand.php b/src/Command/EnvGetCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;
@@ -17,7 +18,8 @@
 class EnvGetCommand extends Command
 {
     public function __construct(
-        #[Autowire('%kernel.project_dir%/.env')] private readonly string $envPath
+        #[Autowire('%kernel.project_dir%/.env')]
+        private readonly string $envPath
     ) {
         parent::__construct();
     }

diff --git a/src/Command/EnvListCommand.php b/src/Command/EnvListCommand.php
@@ -1,11 +1,10 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;
 
 use Symfony\Component\Console\Attribute\AsCommand;
 
 #[AsCommand('frosh:env:list')]
-class EnvListCommand extends EnvGetCommand
-{
-}
+class EnvListCommand extends EnvGetCommand {}
diff --git a/src/Command/EnvSetCommand.php b/src/Command/EnvSetCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;
@@ -16,7 +17,8 @@
 class EnvSetCommand extends Command
 {
     public function __construct(
-        #[Autowire('%kernel.project_dir%/.env')] private readonly string $envPath
+        #[Autowire('%kernel.project_dir%/.env')]
+        private readonly string $envPath
     ) {
         parent::__construct();
     }

diff --git a/src/Command/MonitorCommand.php b/src/Command/MonitorCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;
@@ -30,7 +31,8 @@ class MonitorCommand extends Command
     private const MONITOR_SALESCHANNEL_ARG = 'sales-channel';
 
     public function __construct(
-        #[Autowire(service: MailService::class)] private readonly AbstractMailService $mailService,
+        #[Autowire(service: MailService::class)]
+        private readonly AbstractMailService $mailService,
         private readonly SystemConfigService $configService,
         private readonly Connection $connection,
         private readonly EntityRepository $scheduledTaskRepository

diff --git a/src/Command/UpdateComposerPluginsCommand.php b/src/Command/UpdateComposerPluginsCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;
@@ -20,7 +21,8 @@ class UpdateComposerPluginsCommand extends Command
     private readonly Application $application;
 
     public function __construct(
-        #[Autowire('%kernel.project_dir%')] private readonly string $projectDir,
+        #[Autowire('%kernel.project_dir%')]
+        private readonly string $projectDir,
         private readonly KernelPluginLoader $pluginLoader
     ) {
         parent::__construct();

diff --git a/src/Command/UpdatePluginsCommand.php b/src/Command/UpdatePluginsCommand.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Command;

diff --git a/src/Components/CacheAdapter.php b/src/Components/CacheAdapter.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components;
@@ -105,14 +106,14 @@ private function getCacheAdapter(AdapterInterface $adapter): AdapterInterface
     {
         if ($adapter instanceof CacheDecorator) {
             // Do not declare function as static
-            $func = \Closure::bind(fn () => $adapter->decorated, $adapter, $adapter::class);
+            $func = \Closure::bind(fn() => $adapter->decorated, $adapter, $adapter::class);
 
             return $this->getCacheAdapter($func());
         }
 
         if ($adapter instanceof TagAwareAdapter || $adapter instanceof TraceableAdapter) {
             // Do not declare function as static
-            $func = \Closure::bind(fn () => $adapter->pool, $adapter, $adapter::class);
+            $func = \Closure::bind(fn() => $adapter->pool, $adapter, $adapter::class);
 
             return $this->getCacheAdapter($func());
         }
@@ -123,24 +124,24 @@ private function getCacheAdapter(AdapterInterface $adapter): AdapterInterface
     private function getRedis(AdapterInterface $adapter): ?\Redis
     {
         if ($adapter instanceof RedisTagAwareAdapter) {
-            $redisProxyGetter = \Closure::bind(fn () => $adapter->redis, $adapter, RedisTagAwareAdapter::class);
+            $redisProxyGetter = \Closure::bind(fn() => $adapter->redis, $adapter, RedisTagAwareAdapter::class);
         } else {
-            $redisProxyGetter = \Closure::bind(fn () => $adapter->redis, $adapter, RedisAdapter::class);
+            $redisProxyGetter = \Closure::bind(fn() => $adapter->redis, $adapter, RedisAdapter::class);
         }
 
         return $redisProxyGetter();
     }
 
     private function getPathFromFilesystemAdapter(FilesystemAdapter $adapter): string
     {
-        $getter = \Closure::bind(fn () => $adapter->directory, $adapter, $adapter::class);
+        $getter = \Closure::bind(fn() => $adapter->directory, $adapter, $adapter::class);
 
         return $getter();
     }
 
     private function getPathOfFilesAdapter(PhpFilesAdapter $adapter): string
     {
-        $getter = \Closure::bind(fn () => $adapter->directory, $adapter, $adapter::class);
+        $getter = \Closure::bind(fn() => $adapter->directory, $adapter, $adapter::class);
 
         return $getter();
     }

diff --git a/src/Components/CacheHelper.php b/src/Components/CacheHelper.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components;

diff --git a/src/Components/CacheRegistry.php b/src/Components/CacheRegistry.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components;

diff --git a/src/Components/Elasticsearch/AdminInfoSubscriberEventListener.php b/src/Components/Elasticsearch/AdminInfoSubscriberEventListener.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Elasticsearch;
@@ -11,9 +12,9 @@
 final class AdminInfoSubscriberEventListener
 {
     public function __construct(
-        #[Autowire('%frosh_tools.elasticsearch.enabled%')] private readonly bool $elasticsearchEnabled
-    ) {
-    }
+        #[Autowire('%frosh_tools.elasticsearch.enabled%')]
+        private readonly bool $elasticsearchEnabled
+    ) {}
 
     public function __invoke(ResponseEvent $event): void
     {

diff --git a/src/Components/Elasticsearch/DisabledElasticsearchManager.php b/src/Components/Elasticsearch/DisabledElasticsearchManager.php
@@ -1,13 +1,12 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Elasticsearch;
 
 class DisabledElasticsearchManager extends ElasticsearchManager
 {
-    public function __construct()
-    {
-    }
+    public function __construct() {}
 
     public function isEnabled(): bool
     {

diff --git a/src/Components/Elasticsearch/ElasticsearchManager.php b/src/Components/Elasticsearch/ElasticsearchManager.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Elasticsearch;
@@ -18,15 +19,16 @@ class ElasticsearchManager
 {
     public function __construct(
         private readonly Client $client,
-        #[Autowire('%frosh_tools.elasticsearch.enabled%')] private readonly bool $enabled,
+        #[Autowire('%frosh_tools.elasticsearch.enabled%')]
+        private readonly bool $enabled,
         private readonly ElasticsearchIndexer $indexer,
         private readonly MessageBusInterface $messageBus,
         private readonly CreateAliasTaskHandler $createAliasTaskHandler,
         private readonly ElasticsearchOutdatedIndexDetector $outdatedIndexDetector,
         private readonly Connection $connection,
-        #[Autowire(service: 'shopware.increment.gateway.registry')] private readonly IncrementGatewayRegistry $gatewayRegistry
-    ) {
-    }
+        #[Autowire(service: 'shopware.increment.gateway.registry')]
+        private readonly IncrementGatewayRegistry $gatewayRegistry
+    ) {}
 
     public function isEnabled(): bool
     {

diff --git a/src/Components/Environment/EnvironmentCommentLine.php b/src/Components/Environment/EnvironmentCommentLine.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Environment;

diff --git a/src/Components/Environment/EnvironmentFile.php b/src/Components/Environment/EnvironmentFile.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Environment;
@@ -8,9 +9,7 @@ class EnvironmentFile implements \Stringable
     /**
      * @param array<string, EnvironmentLine> $items
      */
-    public function __construct(private array $items)
-    {
-    }
+    public function __construct(private array $items) {}
 
     public function __toString(): string
     {

diff --git a/src/Components/Environment/EnvironmentKeyValue.php b/src/Components/Environment/EnvironmentKeyValue.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Environment;

diff --git a/src/Components/Environment/EnvironmentLine.php b/src/Components/Environment/EnvironmentLine.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Environment;

diff --git a/src/Components/Environment/EnvironmentManager.php b/src/Components/Environment/EnvironmentManager.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Environment;

diff --git a/src/Components/Exception/CannotClearCacheException.php b/src/Components/Exception/CannotClearCacheException.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Exception;

diff --git a/src/Components/Health/Checker/CheckerInterface.php b/src/Components/Health/Checker/CheckerInterface.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Health\Checker;

diff --git a/src/Components/Health/Checker/HealthChecker/HealthCheckerInterface.php b/src/Components/Health/Checker/HealthChecker/HealthCheckerInterface.php
@@ -7,6 +7,4 @@
 use Symfony\Component\DependencyInjection\Attribute\AutoconfigureTag;
 
 #[AutoconfigureTag('frosh_tools.health_checker')]
-interface HealthCheckerInterface
-{
-}
+interface HealthCheckerInterface {}
diff --git a/src/Components/Health/Checker/HealthChecker/MysqlChecker.php b/src/Components/Health/Checker/HealthChecker/MysqlChecker.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Health\Checker\HealthChecker;
@@ -10,9 +11,7 @@
 
 class MysqlChecker implements HealthCheckerInterface, CheckerInterface
 {
-    public function __construct(private readonly Connection $connection)
-    {
-    }
+    public function __construct(private readonly Connection $connection) {}
 
     public function collect(HealthCollection $collection): void
     {

diff --git a/src/Components/Health/Checker/HealthChecker/PhpChecker.php b/src/Components/Health/Checker/HealthChecker/PhpChecker.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Health\Checker\HealthChecker;

diff --git a/src/Components/Health/Checker/HealthChecker/ProductionChecker.php b/src/Components/Health/Checker/HealthChecker/ProductionChecker.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Health\Checker\HealthChecker;
@@ -11,9 +12,9 @@
 class ProductionChecker implements HealthCheckerInterface, CheckerInterface
 {
     public function __construct(
-        #[Autowire('%kernel.environment%')] private readonly string $environment
-    ) {
-    }
+        #[Autowire('%kernel.environment%')]
+        private readonly string $environment
+    ) {}
 
     public function collect(HealthCollection $collection): void
     {

diff --git a/src/Components/Health/Checker/HealthChecker/QueueChecker.php b/src/Components/Health/Checker/HealthChecker/QueueChecker.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Frosh\Tools\Components\Health\Checker\HealthChecker;
@@ -10,9 +11,7 @@
 
 class QueueChecker implements HealthCheckerInterface, CheckerInterface
 {
-    public function __construct(private readonly Connection $connection)
-    {
-    }
+    public function __construct(private readonly Connection $connection) {}
 
     public function collect(HealthCollection $collection): void
     {