ci: add lint (#312)

* feat: add php cs fixer

* feat: pass php cs fixer

* ci: add lint step

Author: rgomezcasas

.github/workflows/ci.yml

@@ -22,6 +22,9 @@ jobs:
       - name: 🐳 Start all the environment
         run: make start
 
+      - name: 🔦 Lint
+        run: make lint
+
       - name: 🏁 Static analysis
         run: make static-analysis
 

.gitignore

@@ -10,3 +10,5 @@
 .phpunit.result.cache
 
 /build
+
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,23 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()->in(
+    [
+        __DIR__ . '/apps/backoffice/backend/src',
+        __DIR__ . '/apps/backoffice/frontend/src',
+        __DIR__ . '/apps/mooc/backend/src',
+        __DIR__ . '/apps/mooc/frontend/src',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]
+);
+
+$config = new PhpCsFixer\Config();
+
+return $config->setRules(
+    [
+        '@PSR12' => true,
+        'strict_param' => true,
+        'modernize_strpos' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ]
+)->setFinder($finder);

Makefile

@@ -47,6 +47,10 @@ test: composer-env-file
 static-analysis: composer-env-file
 	docker exec codely-php_ddd_skeleton-mooc_backend-php ./vendor/bin/psalm
 
+.PHONY: lint
+lint:
+	docker exec codely-php_ddd_skeleton-mooc_backend-php ./vendor/bin/php-cs-fixer fix --config .php-cs-fixer.dist.php --allow-risky=yes --dry-run
+
 .PHONY: run-tests
 run-tests: composer-env-file
 	mkdir -p build/test_results/phpunit

apps/backoffice/backend/src/Controller/Courses/CoursesGetController.php

@@ -30,15 +30,15 @@ public function __invoke(Request $request): JsonResponse
             new SearchBackofficeCoursesByCriteriaQuery(
                 (array) $request->query->get('filters'),
                 null === $orderBy ? null : (string) $orderBy,
-                null === $order ? null: (string) $order,
+                null === $order ? null : (string) $order,
                 null === $limit ? null : (int) $limit,
                 null === $offset ? null : (int) $offset
             )
         );
 
         return new JsonResponse(
             map(
-                fn(BackofficeCourseResponse $course) => [
+                fn (BackofficeCourseResponse $course) => [
                     'id'       => $course->id(),
                     'name'     => $course->name(),
                     'duration' => $course->duration(),

apps/mooc/backend/src/Command/DomainEvents/MySql/ConsumeMySqlDomainEventsCommand.php

@@ -37,7 +37,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $quantityEventsToProcess = (int) $input->getArgument('quantity');
 
-        $consumer = pipe($this->consumer(), fn() => $this->connections->clear());
+        $consumer = pipe($this->consumer(), fn () => $this->connections->clear());
 
         $this->consumer->consume($consumer, $quantityEventsToProcess);
 
@@ -46,8 +46,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function consumer(): callable
     {
-        return function (DomainEvent $domainEvent) {
-            $subscribers = $this->subscriberLocator->allSubscribedTo(get_class($domainEvent));
+        return function (DomainEvent $domainEvent): void {
+            $subscribers = $this->subscriberLocator->allSubscribedTo($domainEvent::class);
 
             foreach ($subscribers as $subscriber) {
                 $subscriber($domainEvent);

apps/mooc/backend/src/Command/DomainEvents/RabbitMq/ConsumeRabbitMqDomainEventsCommand.php

@@ -45,7 +45,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function consumer(string $queueName): callable
     {
-        return function () use ($queueName) {
+        return function () use ($queueName): void {
             $subscriber = $this->locator->withRabbitMqQueueNamed($queueName);
 
             $this->consumer->consume($subscriber, $queueName);

apps/mooc/backend/src/Command/DomainEvents/RabbitMq/GenerateSupervisorRabbitMqConsumerFilesCommand.php

@@ -43,7 +43,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function configCreator(string $path): callable
     {
-        return function (DomainEventSubscriber $subscriber) use ($path) {
+        return function (DomainEventSubscriber $subscriber) use ($path): void {
             $queueName      = RabbitMqQueueNameFormatter::format($subscriber);
             $subscriberName = RabbitMqQueueNameFormatter::shortFormat($subscriber);
 
@@ -72,16 +72,16 @@ private function configCreator(string $path): callable
     private function template(): string
     {
         return <<<EOF
-[program:codelytv_{queue_name}]
-command      = {path}/apps/mooc/backend/bin/console codelytv:domain-events:rabbitmq:consume --env=prod {queue_name} {events_to_process}
-process_name = %(program_name)s_%(process_num)02d
-numprocs     = {processes}
-startsecs    = 1
-startretries = 10
-exitcodes    = 2
-stopwaitsecs = 300
-autostart    = true
-EOF;
+            [program:codelytv_{queue_name}]
+            command      = {path}/apps/mooc/backend/bin/console codelytv:domain-events:rabbitmq:consume --env=prod {queue_name} {events_to_process}
+            process_name = %(program_name)s_%(process_num)02d
+            numprocs     = {processes}
+            startsecs    = 1
+            startretries = 10
+            exitcodes    = 2
+            stopwaitsecs = 300
+            autostart    = true
+            EOF;
     }
 
     private function fileName(string $queue): string

composer.json

@@ -51,7 +51,8 @@
     "fakerphp/faker": "^1",
 
     "symfony/error-handler": "^6",
-    "vimeo/psalm": "^4"
+    "vimeo/psalm": "^4",
+    "friendsofphp/php-cs-fixer": "^3.8"
   },
   "autoload": {
     "psr-4": {