refactor: fix return.unusedType errors (#9514)

Author: paulbalandan

system/Commands/Utilities/ConfigCheck.php

@@ -73,7 +73,7 @@ final class ConfigCheck extends BaseCommand
     protected $options = [];
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {

system/Commands/Utilities/Environment.php

@@ -80,15 +80,15 @@ final class Environment extends BaseCommand
     ];
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {
         if ($params === []) {
             CLI::write(sprintf('Your environment is currently set as %s.', CLI::color($_SERVER['CI_ENVIRONMENT'] ?? ENVIRONMENT, 'green')));
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         $env = strtolower(array_shift($params));
@@ -98,21 +98,21 @@ public function run(array $params)
             CLI::error('You will not be able to run spark under a "testing" environment.', 'light_gray', 'red');
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         if (! in_array($env, self::$knownTypes, true)) {
             CLI::error(sprintf('Invalid environment type "%s". Expected one of "%s".', $env, implode('" and "', self::$knownTypes)), 'light_gray', 'red');
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         if (! $this->writeNewEnvironmentToEnvFile($env)) {
             CLI::error('Error in writing new environment to .env file.', 'light_gray', 'red');
             CLI::newLine();
 
-            return;
+            return EXIT_ERROR;
         }
 
         // force DotEnv to reload the new environment
@@ -124,6 +124,8 @@ public function run(array $params)
         CLI::write(sprintf('Environment is successfully changed to "%s".', $env), 'green');
         CLI::write('The ENVIRONMENT constant will be changed in the next script execution.');
         CLI::newLine();
+
+        return EXIT_SUCCESS;
     }
 
     /**

system/Commands/Utilities/Optimize.php

@@ -55,21 +55,21 @@ final class Optimize extends BaseCommand
     protected $usage = 'optimize';
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {
         try {
             $this->enableCaching();
             $this->clearCache();
             $this->removeDevPackages();
+
+            return EXIT_SUCCESS;
         } catch (RuntimeException) {
             CLI::error('The "spark optimize" failed.');
 
             return EXIT_ERROR;
         }
-
-        return EXIT_SUCCESS;
     }
 
     private function clearCache(): void

system/Commands/Utilities/PhpIniCheck.php

@@ -68,7 +68,7 @@ final class PhpIniCheck extends BaseCommand
     protected $options = [];
 
     /**
-     * {@inheritDoc}
+     * @return int
      */
     public function run(array $params)
     {

system/Test/PhpStreamWrapper.php

@@ -52,7 +52,7 @@ public function stream_open(): bool
     }
 
     /**
-     * @return false|string
+     * @return string
      */
     public function stream_read(int $count)
     {
@@ -63,7 +63,7 @@ public function stream_read(int $count)
     }
 
     /**
-     * @return array|false
+     * @return array{}
      */
     public function stream_stat()
     {

utils/phpstan-baseline/loader.neon

@@ -1,4 +1,4 @@
-# total 3615 errors
+# total 3608 errors
 includes:
     - argument.type.neon
     - assign.propertyType.neon
@@ -35,7 +35,6 @@ includes:
     - property.readOnlyByPhpDocAssignOutOfClass.neon
     - property.readOnlyByPhpDocDefaultValue.neon
     - property.unusedType.neon
-    - return.unusedType.neon
     - staticMethod.notFound.neon
     - ternary.shortNotAllowed.neon
     - varTag.type.neon

utils/phpstan-baseline/missingType.iterableValue.neon

@@ -1,4 +1,4 @@
-# total 1629 errors
+# total 1628 errors
 
 parameters:
     ignoreErrors:
@@ -5597,11 +5597,6 @@ parameters:
             count: 1
             path: ../../system/Test/Mock/MockResult.php
 
-        -
-            message: '#^Method CodeIgniter\\Test\\PhpStreamWrapper\:\:stream_stat\(\) return type has no value type specified in iterable type array\.$#'
-            count: 1
-            path: ../../system/Test/PhpStreamWrapper.php
-
         -
             message: '#^Method CodeIgniter\\Test\\TestResponse\:\:assertJSONExact\(\) has parameter \$test with no value type specified in iterable type array\.$#'
             count: 1