ajout phpcsfixer

Author: xaviermarchegay

.gitignore

@@ -8,4 +8,5 @@
 /phpunit.xml
 .phpunit.result.cache
 .phpunit.cache
+.php-cs-fixer.cache
 coverage-report

.php-cs-fixer.dist.php

@@ -0,0 +1,38 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true)
+    ->exclude(['build', 'vendor'])
+    ->files()
+    ->name('*.php')
+;
+
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setUsingCache(true)
+    ->setRiskyAllowed(true)
+    ->setFinder($finder)
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@PHPUnit48Migration:risky' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'fopen_flags' => false,
+        'ordered_imports' => true,
+        'protected_to_private' => false,
+        // Part of @Symfony:risky in PHP-CS-Fixer 2.13.0. To be removed from the config file once upgrading
+        'native_function_invocation' => ['include' => ['@compiler_optimized'], 'scope' => 'namespaced', 'strict' => true],
+        // Part of future @Symfony ruleset in PHP-CS-Fixer To be removed from the config file once upgrading
+        'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
+        'single_line_throw' => false,
+        // this must be disabled because the output of some tests include NBSP characters
+        'non_printable_character' => false,
+        'blank_line_between_import_groups' => false,
+        'no_trailing_comma_in_singleline' => false,
+        'nullable_type_declaration_for_default_null_value' => true,
+        'phpdoc_to_comment' => false,
+    ])
+;

Makefile

@@ -1,15 +1,11 @@
-# Include .env.dist for the default values
-include .env.dist
-
-# Include .env only if it exists
-ifneq ("",$(wildcard $(.env)))
-include .env
-endif
+.ONESHELL:
+SHELL := /bin/bash
 
 test:
 	php -dxdebug.mode=coverage vendor/bin/phpunit --coverage-html coverage-report
 
-linter:
-	vendor/bin/rector process
-	vendor/bin/ecs check --fix
+linter: #[Linter]
+	vendor/bin/php-cs-fixer fix
+
+phpstan: #[Phpstan]
 	vendor/bin/phpstan

composer.json

@@ -83,14 +83,13 @@
     "symfony/yaml": "^6.3"
   },
   "require-dev": {
-    "roave/security-advisories": "dev-latest",
-    "phpunit/phpunit": "*",
+    "friendsofphp/php-cs-fixer": "*",
+    "phpstan/extension-installer": "*",
     "phpstan/phpstan": "*",
     "phpstan/phpstan-symfony": "*",
-    "phpstan/extension-installer": "*",
+    "phpunit/phpunit": "*",
     "rector/rector": "*",
-    "symplify/easy-coding-standard": "*",
-    "symplify/phpstan-rules": "*",
+    "roave/security-advisories": "dev-latest",
     "symfony/test-pack": "^1.1"
   },
   "suggest": {

ecs.php

@@ -18,7 +18,7 @@
         SetList::DOCTRINE_ANNOTATIONS,
     ]);
 
-    $ecsConfig->paths([__DIR__ . '/src']);
+    $ecsConfig->paths([__DIR__.'/src']);
 
     $ecsConfig->skip([AssignmentInConditionSniff::class]);
 };

rector.php

@@ -13,8 +13,8 @@
     $rectorConfig->importNames();
     $rectorConfig->importShortClasses();
 
-    $rectorConfig->paths([__DIR__ . '/src']);
-    $rectorConfig->skip([__DIR__ . '/src/Resources/tests']);
+    $rectorConfig->paths([__DIR__.'/src']);
+    $rectorConfig->skip([__DIR__.'/src/Resources/tests']);
 
     $rectorConfig->sets([
         SetList::TYPE_DECLARATION,

src/CleverAgeProcessBundle.php

@@ -23,7 +23,7 @@
 class CleverAgeProcessBundle extends Bundle
 {
     /**
-     * Adding compiler passes to inject services into registry
+     * Adding compiler passes to inject services into registry.
      */
     public function build(ContainerBuilder $container): void
     {

src/Command/ExecuteProcessCommand.php

@@ -16,7 +16,6 @@
 use CleverAge\ProcessBundle\Event\ConsoleProcessEvent;
 use CleverAge\ProcessBundle\Filesystem\JsonStreamFile;
 use CleverAge\ProcessBundle\Manager\ProcessManager;
-use InvalidArgumentException;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
@@ -26,13 +25,11 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\VarDumper\VarDumper;
 use Symfony\Component\Yaml\Parser;
-use function count;
-use function is_array;
 
 /**
- * Run a process from the command line interface
+ * Run a process from the command line interface.
  */
-#[AsCommand(name: 'cleverage:process:execute', description: 'Execute a process',)]
+#[AsCommand(name: 'cleverage:process:execute', description: 'Execute a process', )]
 class ExecuteProcessCommand extends Command
 {
     final public const OUTPUT_STDOUT = '-';
@@ -79,8 +76,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $inputData = $input->getOption('input');
         if ($input->getOption('input-from-stdin')) {
             $inputData = '';
-            while (! feof(STDIN)) {
-                $inputData .= fread(STDIN, 8192);
+            while (!feof(\STDIN)) {
+                $inputData .= fread(\STDIN, 8192);
             }
         }
 
@@ -89,15 +86,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $this->eventDispatcher->dispatch(new ConsoleProcessEvent($input, $output, $inputData, $context));
 
         foreach ($input->getArgument('processCodes') as $code) {
-            if (! $output->isQuiet()) {
+            if (!$output->isQuiet()) {
                 $output->writeln("<comment>Starting process '{$code}'...</comment>");
             }
 
             // Execute each process
             $returnValue = $this->processManager->execute($code, $inputData, $context);
             $this->handleOutputData($returnValue, $input, $output);
 
-            if (! $output->isQuiet()) {
+            if (!$output->isQuiet()) {
                 $output->writeln("<info>Process '{$code}' executed successfully</info>");
             }
         }
@@ -117,9 +114,9 @@ protected function parseContextValues(InputInterface $input): array
         $context = [];
         foreach ($contextValues as $contextValue) {
             preg_match($pattern, (string) $contextValue, $parts);
-            if (count($parts) !== 3
+            if (3 !== \count($parts)
                 || $parts[0] !== $contextValue) {
-                throw new InvalidArgumentException(sprintf('Invalid context %s', $contextValue));
+                throw new \InvalidArgumentException(sprintf('Invalid context %s', $contextValue));
             }
             $context[$parts[1]] = $parser->parse($parts[2]);
         }
@@ -130,29 +127,29 @@ protected function parseContextValues(InputInterface $input): array
     protected function handleOutputData(mixed $data, InputInterface $input, OutputInterface $output): void
     {
         // Skip all if undefined
-        if (! $input->getOption('output-format')) {
+        if (!$input->getOption('output-format')) {
             return;
         }
 
         // Handle printing the output
-        if ($input->getOption('output') === self::OUTPUT_STDOUT) {
+        if (self::OUTPUT_STDOUT === $input->getOption('output')) {
             if ($output->isVeryVerbose()) {
-                if (class_exists(VarDumper::class) && ($input->getOption(
+                if (class_exists(VarDumper::class) && (self::OUTPUT_FORMAT_DUMP === $input->getOption(
                     'output-format'
-                ) === self::OUTPUT_FORMAT_DUMP)) {
+                ))) {
                     VarDumper::dump($data);
-                } elseif ($input->getOption('output-format') === self::OUTPUT_FORMAT_JSON) {
-                    $output->writeln(json_encode($data, JSON_THROW_ON_ERROR));
+                } elseif (self::OUTPUT_FORMAT_JSON === $input->getOption('output-format')) {
+                    $output->writeln(json_encode($data, \JSON_THROW_ON_ERROR));
                 } else {
-                    throw new InvalidArgumentException(
+                    throw new \InvalidArgumentException(
                         sprintf("Cannot handle data output with format '%s'", $input->getOption('output-format'))
                     );
                 }
             }
-        } elseif ($input->getOption('output-format') === self::OUTPUT_FORMAT_JSON) {
+        } elseif (self::OUTPUT_FORMAT_JSON === $input->getOption('output-format')) {
             // JsonStreamFile::writeLine only takes an array...
             // TODO how to handle other cases ?
-            if (is_array($data)) {
+            if (\is_array($data)) {
                 $outputFile = new JsonStreamFile($input->getOption('output'), 'wb');
                 $outputFile->writeLine($data);
             }
@@ -161,7 +158,7 @@ protected function handleOutputData(mixed $data, InputInterface $input, OutputIn
                 $output->writeln(sprintf("Output stored in '%s'", $input->getOption('output')));
             }
         } else {
-            throw new InvalidArgumentException(
+            throw new \InvalidArgumentException(
                 sprintf("Cannot handle data output with format '%s'", $input->getOption('output-format'))
             );
         }

src/Command/ListProcessCommand.php

@@ -20,15 +20,11 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
-use function array_reduce;
-use function count;
-use function max;
-use function usort;
 
 /**
- * List all configured processes
+ * List all configured processes.
  */
-#[AsCommand(name: 'cleverage:process:list', description: 'List defined processes',)]
+#[AsCommand(name: 'cleverage:process:list', description: 'List defined processes', )]
 class ListProcessCommand extends Command
 {
     public function __construct(
@@ -54,7 +50,7 @@ public function processSorter(ProcessConfiguration $a, ProcessConfiguration $b):
 
     public function maxMessageLengthFilter(int $max, array $message): int
     {
-        return max($max, strlen($this->filterOutTags($message['output'])));
+        return \max($max, \strlen($this->filterOutTags($message['output'])));
     }
 
     protected function configure(): void
@@ -65,18 +61,18 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $processConfigurations = $this->processConfigRegistry->getProcessConfigurations();
-        usort($processConfigurations, $this->processSorter(...));
+        \usort($processConfigurations, $this->processSorter(...));
 
-        $publicCount = array_reduce($processConfigurations, $this->publicProcessCounter(...), 0);
-        $privateCount = array_reduce($processConfigurations, $this->privateProcessCounter(...), 0);
+        $publicCount = \array_reduce($processConfigurations, $this->publicProcessCounter(...), 0);
+        $privateCount = \array_reduce($processConfigurations, $this->privateProcessCounter(...), 0);
         $output->writeln(
             "<info>There are {$publicCount} process configurations defined (and {$privateCount} private) :</info>"
         );
 
         $messages = [];
         foreach ($processConfigurations as $processConfiguration) {
             if ($processConfiguration->isPublic() || $input->getOption('all')) {
-                $countTasks = count($processConfiguration->getTaskConfigurations());
+                $countTasks = \count($processConfiguration->getTaskConfigurations());
                 $message = "<info> - </info>{$processConfiguration->getCode()}<info> with {$countTasks} tasks</info>";
 
                 if ($processConfiguration->isPrivate()) {
@@ -91,7 +87,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         // Add process descriptions at a fixed position
-        $maxMessageLength = array_reduce($messages, $this->maxMessageLengthFilter(...), 0);
+        $maxMessageLength = \array_reduce($messages, $this->maxMessageLengthFilter(...), 0);
         $outputMessages = [];
         foreach ($messages as $message) {
             /** @var ProcessConfiguration $processConfiguration */
@@ -116,7 +112,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     protected function padMessage(string $message, int $length = 80): string
     {
-        $currentLen = strlen($this->filterOutTags($message));
+        $currentLen = \strlen($this->filterOutTags($message));
         if ($currentLen < $length) {
             $message .= str_repeat(' ', $length - $currentLen);
         }