[BUGFIX] Fix phpstan annotations and migrate away from Prophecy

Author: simonschaufi

phpstan-baseline.neon

@@ -1,10 +1,15 @@
+includes:
+    - phpstan-baseline.neon
+
 parameters:
-  level: 8
-  editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
-  paths:
-    - src
-    - tests
+    level: 8
+    parallel:
+        # to prevent full thread lagging pc
+        maximumNumberOfProcesses: 7
+    editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
+    paths:
+        - src
+        - tests
 
-  inferPrivatePropertyTypeFromConstructor: true
-  checkMissingIterableValueType: false
-  checkGenericClassInNonGenericObjectType: false
+    inferPrivatePropertyTypeFromConstructor: true
+    treatPhpDocTypesAsCertain: false

phpstan.neon

@@ -39,11 +39,14 @@ class BaseApplication extends Application
      * Symlinks, which should be created for each release.
      *
      * @see \TYPO3\Surf\Task\Generic\CreateSymlinksTask
+     * @var string[]
      */
     protected array $symlinks = [];
 
     /**
      * Directories which should be created on deployment. E.g. shared folders.
+     *
+     * @var string[]
      */
     protected array $directories = [];
 
@@ -125,13 +128,19 @@ public function registerTasks(Workflow $workflow, Deployment $deployment): void
         }
     }
 
+    /**
+     * @param string[] $symlinks
+     */
     public function setSymlinks(array $symlinks): self
     {
         $this->symlinks = $symlinks;
 
         return $this;
     }
 
+    /**
+     * @return string[]
+     */
     public function getSymlinks(): array
     {
         return $this->symlinks;
@@ -144,6 +153,9 @@ public function addSymlink(string $linkPath, string $sourcePath): self
         return $this;
     }
 
+    /**
+     * @param string[] $symlinks
+     */
     public function addSymlinks(array $symlinks): self
     {
         foreach ($symlinks as $linkPath => $sourcePath) {
@@ -153,13 +165,19 @@ public function addSymlinks(array $symlinks): self
         return $this;
     }
 
+    /**
+     * @param string[] $directories
+     */
     public function setDirectories(array $directories): self
     {
         $this->directories = $directories;
 
         return $this;
     }
 
+    /**
+     * @return string[]
+     */
     public function getDirectories(): array
     {
         return $this->directories;
@@ -172,6 +190,9 @@ public function addDirectory(string $path): self
         return $this;
     }
 
+    /**
+     * @param string[] $directories
+     */
     public function addDirectories(array $directories): self
     {
         foreach ($directories as $path) {

src/Application/BaseApplication.php

@@ -130,7 +130,9 @@ public function getCommandPackageKey(string $command = ''): string
     }
 
     /**
-     * Returns a executable flow command including the context
+     * Returns an executable flow command including the context
+     *
+     * @param string[] $arguments
      */
     public function buildCommand(
         string $targetPath,

src/Application/Neos/Flow.php

@@ -13,6 +13,9 @@
 
 class Neos extends Flow
 {
+    /**
+     * @var string[]
+     */
     private array $neosCommands = [
         'domain:add',
         'domain:list',

src/Application/Neos/Neos.php

@@ -33,13 +33,19 @@ class ConsoleHandler extends AbstractProcessingHandler
 {
     private OutputInterface $output;
 
+    /**
+     * @var array<int, mixed>
+     */
     private array $verbosityLevelMap = [
         OutputInterface::VERBOSITY_NORMAL => Logger::INFO,
         OutputInterface::VERBOSITY_VERBOSE => Logger::DEBUG,
         OutputInterface::VERBOSITY_VERY_VERBOSE => Logger::DEBUG,
         OutputInterface::VERBOSITY_DEBUG => Logger::DEBUG,
     ];
 
+    /**
+     * @param array<int, array<int, mixed>> $verbosityLevelMap
+     */
     public function __construct(OutputInterface $output, bool $bubble = true, array $verbosityLevelMap = [])
     {
         parent::__construct(Logger::DEBUG, $bubble);

src/Cli/Symfony/Logger/ConsoleHandler.php

@@ -18,6 +18,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use TYPO3\Surf\Domain\Model\Application;
 use TYPO3\Surf\Domain\Model\FailedDeployment;
+use TYPO3\Surf\Domain\Model\Node;
 use TYPO3\Surf\Domain\Model\SimpleWorkflow;
 use TYPO3\Surf\Domain\Model\Workflow;
 use TYPO3\Surf\Integration\FactoryInterface;
@@ -91,6 +92,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         return Command::SUCCESS;
     }
 
+    /**
+     * @param Node[] $nodes
+     */
     protected function printNodes(array $nodes): void
     {
         $this->output->writeln('Nodes:' . PHP_EOL);
@@ -99,6 +103,9 @@ protected function printNodes(array $nodes): void
         }
     }
 
+    /**
+     * @param Application[] $applications
+     */
     protected function printApplications(array $applications, Workflow $workflow): void
     {
         $this->output->writeln(PHP_EOL . 'Applications:' . PHP_EOL);
@@ -127,6 +134,10 @@ protected function printApplications(array $applications, Workflow $workflow): v
         }
     }
 
+    /**
+     * @param array<string, mixed> $stages
+     * @param array<string, mixed> $tasks
+     */
     protected function printStages(Application $application, array $stages, array $tasks): void
     {
         foreach ($stages as $stage) {
@@ -155,6 +166,7 @@ protected function printStages(Application $application, array $stages, array $t
     /**
      * Print all tasks before or after a task
      *
+     * @param array<string, mixed> $tasks
      * @param string $output
      */
     private function printBeforeAfterTasks(array $tasks, string $applicationName, string $task, string $step, &$output): void

src/Command/DescribeCommand.php

@@ -65,6 +65,9 @@ public function createDirectory(string $directory): bool
         return mkdir($directory, 0777, true);
     }
 
+    /**
+     * @return string[]
+     */
     public function glob(string $pattern): array
     {
         $matches = glob($pattern);

src/Domain/Filesystem/Filesystem.php

@@ -35,5 +35,8 @@ public function fileExists(string $file): bool;
 
     public function createDirectory(string $directory): bool;
 
+    /**
+     * @return string[]
+     */
     public function glob(string $pattern): array;
 }

src/Domain/Filesystem/FilesystemInterface.php

@@ -48,6 +48,9 @@ class Application
      */
     protected string $releasesDirectory = 'releases';
 
+    /**
+     * @var array<string,mixed>
+     */
     protected array $options = [];
 
     public function __construct(string $name)
@@ -219,6 +222,8 @@ public function getReleasesPath(): string
      *
      * The options will include the deploymentPath and sharedPath for
      * unified option handling.
+     *
+     * @return array<string,mixed>
      */
     public function getOptions(): array
     {
@@ -267,6 +272,9 @@ public function provideStringOption(string $key): string
         return (string)$this->getOption($key);
     }
 
+    /**
+     * @param array<string, mixed> $options
+     */
     public function setOptions(array $options): self
     {
         $this->options = $options;