Replace Psalm by PHPStan

Author: hlecorche

.github/workflows/tests.yml

@@ -103,14 +103,6 @@ jobs:
                 if: matrix.symfony-version && contains(matrix.symfony-version, '@dev')
                 run: composer config minimum-stability dev
 
-            -   name: Remove friendsofphp/php-cs-fixer
-                if: matrix.coding-standards != true
-                run: composer remove friendsofphp/php-cs-fixer --dev --no-update
-
-            -   name: Remove vimeo/psalm
-                if: matrix.static-analysis != true
-                run: composer remove vimeo/psalm --dev --no-update
-
             -   name: Configure Symfony Flex
                 if: matrix.symfony-version
                 run: composer config extra.symfony.require ${{ matrix.symfony-version }}
@@ -136,6 +128,6 @@ jobs:
                 if: matrix.coding-standards
                 run: cat LICENSE |grep -E "\(c\) ([0-9]+\-)*`date +%G`"
 
-            -   name: Run Psalm
+            -   name: Run PHPStan
                 if: matrix.static-analysis
-                run: php vendor/bin/psalm --stats --output-format=github
+                run: php vendor/bin/phpstan --no-progress --error-format=github

composer.json

@@ -34,10 +34,15 @@
     "require-dev": {
         "dg/bypass-finals": "^1.3",
         "friendsofphp/php-cs-fixer": "^3.0",
-        "phpunit/phpunit": "^9",
-        "vimeo/psalm": "^5"
+        "phpstan/extension-installer": "^1.3",
+        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan-symfony": "^1.3",
+        "phpunit/phpunit": "^9"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     }
 }

phpstan-baseline.neon

@@ -0,0 +1,5 @@
+parameters:
+    ignoreErrors:
+        -
+            message: '#no value type specified in iterable type array#'
+            path: tests/

phpstan.neon.dist

@@ -0,0 +1,9 @@
+includes:
+    - phpstan-baseline.neon
+    - vendor/phpstan/phpstan/conf/bleedingEdge.neon
+
+parameters:
+    level: max
+    paths:
+        - src
+        - tests

psalm.xml

@@ -16,6 +16,7 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\RuntimeException;
+use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -30,33 +31,14 @@ final class DeployRsyncCommand extends Command
     public const TARGET_SSH_REGEX = '/^ssh:\/\/(?<username>.+)@(?<hostname>[^:]+)(:(?<port>\d+)){0,1}:(?<path>.+)$/';
 
     /**
-     * @var array
+     * @param array<string, array{target: string, rsync_options?: string[], ignore_file?: string}> $environments
+     * @param array{rsync_path: string, rsync_options: string[], ignore_file: ?string}             $rsyncConfig
      */
-    protected $environments;
-
-    /**
-     * @var array
-     */
-    protected $rsyncConfig;
-
-    /**
-     * @var string
-     */
-    protected $projetDir;
-
-    public function __construct(array $environments, array $rsyncConfig, string $projetDir)
+    public function __construct(protected array $environments, protected array $rsyncConfig, protected string $projetDir)
     {
-        $this->environments = $environments;
-        $this->rsyncConfig = $rsyncConfig;
-        $this->projetDir = $projetDir;
-
         parent::__construct();
     }
 
-    protected static $defaultName = 'ecommit:deploy-rsync'; // PHP < 8
-
-    protected static $defaultDescription = 'Deploy the application with RSYNC and SSH'; // PHP < 8
-
     protected function configure(): void
     {
         $this
@@ -67,13 +49,16 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        if (!\array_key_exists($input->getArgument('environment'), $this->environments)) {
-            throw new RuntimeException('Environment not found: '.$input->getArgument('environment'));
+        /** @var string $environmentName */
+        $environmentName = $input->getArgument('environment');
+        if (!\array_key_exists($environmentName, $this->environments)) {
+            throw new RuntimeException('Environment not found: '.$environmentName);
         }
-        $environment = $this->environments[$input->getArgument('environment')];
+        $environment = $this->environments[$environmentName];
 
         $ignoreFile = $environment['ignore_file'] ?? $this->rsyncConfig['ignore_file'];
         if (!$ignoreFile) {
+            /** @var QuestionHelper $helper */
             $helper = $this->getHelper('question');
             $question = new ConfirmationQuestion('Continue without ignore file? [y/N]', false);
 
@@ -123,12 +108,18 @@ protected function getDirPath(string $dir): string
         return $dir;
     }
 
-    protected function executeProcess(array $command): \Iterator
+    /**
+     * @param string[] $command
+     *
+     * @return \Generator<array-key, string>
+     */
+    protected function executeProcess(array $command): \Generator
     {
         $process = $this->createProcess($command);
         $process->start();
 
-        foreach ($process as $type => $data) {
+        /** @var string $data */
+        foreach ($process as $data) {
             yield $data;
         }
 
@@ -137,6 +128,9 @@ protected function executeProcess(array $command): \Iterator
         }
     }
 
+    /**
+     * @param string[] $command
+     */
     protected function createProcess(array $command): Process
     {
         return new Process($command);

src/Command/DeployRsyncCommand.php

@@ -19,9 +19,6 @@
 
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * @psalm-suppress UndefinedMethod
-     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('ecommit_deploy_rsync');

src/DependencyInjection/Configuration.php

@@ -413,7 +413,7 @@ public function testGetDirPath(string $dir, string $expected): void
         $class = new \ReflectionClass(DeployRsyncCommand::class);
         $method = $class->getMethod('getDirPath');
         $method->setAccessible(true);
-        $command = new DeployRsyncCommand([], [], '');
+        $command = new DeployRsyncCommand([], [], ''); // @phpstan-ignore-line
 
         $this->assertSame($expected, $method->invokeArgs($command, [$dir]));
     }
@@ -430,9 +430,9 @@ public function getTestGetDirPathProvider(): array
         ];
     }
 
-    protected function createCommandTester(array $config, array $expectedCommand, $isSuccessful): CommandTester
+    protected function createCommandTester(array $config, array $expectedCommand, bool $isSuccessful): CommandTester
     {
-        $command = $this->getMockBuilder(DeployRsyncCommand::class)
+        $command = $this->getMockBuilder(DeployRsyncCommand::class) // @phpstan-ignore-line
             ->setConstructorArgs([$config['environments'], $config['rsync'], '/local/path'])
             ->onlyMethods(['createProcess'])
             ->getMock();