refactor: fix phpstan errors in Commands

Author: paulbalandan

system/Commands/ListCommands.php

@@ -15,12 +15,15 @@
 
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
+use CodeIgniter\CLI\Commands;
 
 /**
  * CI Help command for the spark script.
  *
  * Lists the basic usage information for the spark script,
  * and provides a way to list help for other commands.
+ *
+ * @phpstan-import-type commands_list from Commands
  */
 class ListCommands extends BaseCommand
 {
@@ -88,6 +91,8 @@ public function run(array $params)
     /**
      * Lists the commands with accompanying info.
      *
+     * @param commands_list $commands
+     *
      * @return int
      */
     protected function listFull(array $commands)
@@ -133,6 +138,8 @@ protected function listFull(array $commands)
     /**
      * Lists the commands only.
      *
+     * @param commands_list $commands
+     *
      * @return int
      */
     protected function listSimple(array $commands)

system/Commands/Translation/LocalizationFinder.php

@@ -213,7 +213,7 @@ private function findResolvedTranslations(string $langFileName, string $currentL
     /**
      * @param SplFileInfo|string $file
      *
-     * @return array<string, array>
+     * @return array{foundLanguageKeys: array<string, array<string, string>>, badLanguageKeys: array<int, array<int, string>>}
      */
     private function findTranslationsInFile($file): array
     {
@@ -273,6 +273,9 @@ private function isIgnoredFile(SplFileInfo $file): bool
         return $file->getExtension() !== 'php';
     }
 
+    /**
+     * @param array<array-key, mixed> $language
+     */
     private function templateFile(array $language = []): string
     {
         if ($language !== []) {
@@ -337,6 +340,10 @@ private function replaceArraySyntax(string $code): string
 
     /**
      * Create multidimensional array from another keys
+     *
+     * @param list<string> $fromKeys
+     *
+     * @return array<array-key, mixed>
      */
     private function buildMultiArray(array $fromKeys, string $lastArrayValue = ''): array
     {
@@ -356,6 +363,10 @@ private function buildMultiArray(array $fromKeys, string $lastArrayValue = ''):
 
     /**
      * Convert multi arrays to specific CLI table rows (flat array)
+     *
+     * @param array<array-key, mixed> $array
+     *
+     * @return list<array{string, string}>
      */
     private function arrayToTableRows(string $langFileName, array $array): array
     {

system/Commands/Utilities/Namespaces.php

@@ -91,9 +91,14 @@ public function run(array $params)
         CLI::table($tbody, $thead);
     }
 
+    /**
+     * @param array<array-key, int|string|null> $params
+     *
+     * @return list<array{string, string, string}>
+     */
     private function outputAllNamespaces(array $params): array
     {
-        $maxLength = $params['m'];
+        $maxLength = (int) $params['m'];
 
         $autoloader = service('autoloader');
 
@@ -129,9 +134,14 @@ private function truncate(string $string, int $max): string
         return $string;
     }
 
+    /**
+     * @param array<array-key, int|string|null> $params
+     *
+     * @return list<array{string, string, string}>
+     */
     private function outputCINamespaces(array $params): array
     {
-        $maxLength = $params['m'];
+        $maxLength = (int) $params['m'];
 
         $config = new Autoload();
 

system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php

@@ -95,9 +95,9 @@ public function get(): array
     /**
      * Adding Filters
      *
-     * @param list<array<string, array|string>> $routes
+     * @param list<array{method: string, route: string, route_params: string, handler: string, params: array<string, bool>, before?: string, after?: string}> $routes
      *
-     * @return list<array<string, array|string>>
+     * @return list<array{method: string, route: string, route_params: string, handler: string, params: array<string, bool>, before: string, after: string}>
      */
     private function addFilters(array $routes): array
     {
@@ -134,6 +134,9 @@ private function addFilters(array $routes): array
         return $routes;
     }
 
+    /**
+     * @param array{method: string, route: string, route_params: string, handler: string, params: array<string, bool>, before?: string, after?: string} $route
+     */
     private function generateSampleUri(array $route, bool $longest = true): string
     {
         $sampleUri = '';

system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php

@@ -45,7 +45,7 @@ public function __construct(
      *
      * @param class-string $class
      *
-     * @return list<array<string, array|string>>
+     * @return list<array{method: string, route: string, route_params: string, handler: string, params: array<string, bool>}>
      */
     public function read(string $class, string $defaultController = 'Home', string $defaultMethod = 'index'): array
     {
@@ -128,6 +128,9 @@ public function read(string $class, string $defaultController = 'Home', string $
         return $output;
     }
 
+    /**
+     * @return array{array<string, bool>, string}
+     */
     private function getParameters(ReflectionMethod $method): array
     {
         $params      = [];

system/Commands/Utilities/Routes/ControllerMethodReader.php

@@ -147,6 +147,8 @@ private function getUriByClass(string $classname): string
 
     /**
      * Gets a route without default controller.
+     *
+     * @return list<array{route: string, handler: string}>
      */
     private function getRouteWithoutController(
         string $classShortname,

system/Commands/Utilities/Routes/FilterFinder.php

@@ -36,6 +36,9 @@ public function __construct(?Router $router = null, ?Filters $filters = null)
         $this->filters = $filters ?? service('filters');
     }
 
+    /**
+     * @return list<string>
+     */
     private function getRouteFilters(string $uri): array
     {
         $this->router->handle($uri);

tests/system/Commands/Translation/LocalizationFinderTest.php

@@ -166,6 +166,9 @@ public function testWriteSkipsKeysAlreadyTranslatedByFramework(): void
         $this->assertArrayNotHasKey('pageNotFound', $generatedKeys);
     }
 
+    /**
+     * @return array<string, string>
+     */
     private function getActualTranslationOneKeys(): array
     {
         return [
@@ -179,6 +182,9 @@ private function getActualTranslationOneKeys(): array
         ];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     private function getActualTranslationThreeKeys(): array
     {
         return [
@@ -212,6 +218,9 @@ private function getActualTranslationThreeKeys(): array
         ];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     private function getActualTranslationFourKeys(): array
     {
         return [

tests/system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollectorTest.php

@@ -31,6 +31,9 @@ protected function setUp(): void
         $this->resetServices(true);
     }
 
+    /**
+     * @param array<string, array<string, list<string>>> $filterConfigFilters
+     */
     private function createAutoRouteCollector(array $filterConfigFilters): AutoRouteCollector
     {
         $routes = service('routes');

tests/system/Commands/Utilities/Routes/AutoRouterImproved/Controllers/Dash_folder/Dash_controller.php

@@ -17,11 +17,11 @@
 
 class Dash_controller extends Controller
 {
-    public function getSomemethod($p1 = ''): void
+    public function getSomemethod(string $p1 = ''): void
     {
     }
 
-    public function getDash_method($p1, $p2 = ''): void
+    public function getDash_method(string $p1, string $p2 = ''): void
     {
     }
 }