refactor: migrate config:check as a modern command

Author: paulbalandan

system/Commands/Utilities/ConfigCheck.php

@@ -14,108 +14,64 @@
 namespace CodeIgniter\Commands\Utilities;
 
 use CodeIgniter\Cache\FactoriesCache;
-use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\AbstractCommand;
+use CodeIgniter\CLI\Attributes\Command;
 use CodeIgniter\CLI\CLI;
+use CodeIgniter\CLI\Input\Argument;
 use CodeIgniter\Config\BaseConfig;
 use Config\Optimize;
 use Kint\Kint;
 
 /**
  * Check the Config values.
- *
- * @see \CodeIgniter\Commands\Utilities\ConfigCheckTest
  */
-final class ConfigCheck extends BaseCommand
+#[Command(name: 'config:check', description: 'Check your config values.', group: 'CodeIgniter')]
+class ConfigCheck extends AbstractCommand
 {
-    /**
-     * The group the command is lumped under
-     * when listing commands.
-     *
-     * @var string
-     */
-    protected $group = 'CodeIgniter';
-
-    /**
-     * The Command's name
-     *
-     * @var string
-     */
-    protected $name = 'config:check';
-
-    /**
-     * The Command's short description
-     *
-     * @var string
-     */
-    protected $description = 'Check your Config values.';
-
-    /**
-     * The Command's usage
-     *
-     * @var string
-     */
-    protected $usage = 'config:check <classname>';
-
-    /**
-     * The Command's arguments
-     *
-     * @var array<string, string>
-     */
-    protected $arguments = [
-        'classname' => 'The config classname to check. Short classname or FQCN.',
-    ];
-
-    /**
-     * The Command's options
-     *
-     * @var array<string, string>
-     */
-    protected $options = [];
-
-    /**
-     * @return int
-     */
-    public function run(array $params)
+    protected function configure(): void
     {
-        if (! isset($params[0])) {
-            CLI::error('You must specify a Config classname.');
-            CLI::write('  Usage: ' . $this->usage);
-            CLI::write('Example: config:check App');
-            CLI::write('         config:check \'CodeIgniter\Shield\Config\Auth\'');
+        $this->addArgument(new Argument(
+            name: 'class_name',
+            description: 'The config class to check. Short name or FQCN.',
+            required: true,
+        ));
+    }
 
-            return EXIT_ERROR;
+    protected function interact(array &$arguments, array &$options): void
+    {
+        if ($arguments === []) {
+            $arguments[] = CLI::prompt('Config class name', null, 'required');
         }
+    }
 
+    protected function execute(array $arguments, array $options): int
+    {
         /** @var class-string<BaseConfig> $class */
-        $class = $params[0];
+        $class = $arguments['class_name'];
+
+        $configCacheEnabled = class_exists(Optimize::class) && (new Optimize())->configCacheEnabled;
 
-        // Load Config cache if it is enabled.
-        $configCacheEnabled = class_exists(Optimize::class)
-            && (new Optimize())->configCacheEnabled;
         if ($configCacheEnabled) {
-            $factoriesCache = new FactoriesCache();
-            $factoriesCache->load('config');
+            (new FactoriesCache())->load('config');
         }
 
         $config = config($class);
 
         if ($config === null) {
-            CLI::error('No such Config class: ' . $class);
+            CLI::error(sprintf('Config class "%s" not found.', $class));
 
             return EXIT_ERROR;
         }
 
         if (defined('KINT_DIR') && Kint::$enabled_mode !== false) {
             CLI::write($this->getKintD($config));
         } else {
-            CLI::write(
-                CLI::color($this->getVarDump($config), 'cyan'),
-            );
+            CLI::write(CLI::color($this->getVarDump($config), 'cyan'));
         }
 
         CLI::newLine();
-        $state = CLI::color($configCacheEnabled ? 'Enabled' : 'Disabled', 'green');
-        CLI::write('Config Caching: ' . $state);
+        $state = CLI::color($configCacheEnabled ? 'enabled' : 'disabled', 'green');
+        CLI::write(sprintf('Config caching: %s', $state));
 
         return EXIT_SUCCESS;
     }

tests/system/Commands/Utilities/ConfigCheckTest.php

@@ -13,9 +13,9 @@
 
 namespace CodeIgniter\Commands\Utilities;
 
-use Closure;
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\Test\CIUnitTestCase;
+use CodeIgniter\Test\Mock\MockInputOutput;
 use CodeIgniter\Test\StreamFilterTrait;
 use Config\App;
 use Kint\Kint;
@@ -66,54 +66,50 @@ protected function tearDown(): void
         CLI::reset();
     }
 
-    public function testCommandConfigCheckWithNoArgumentPassed(): void
+    public function testCommandConfigCheckPromptsForClassNameWhenMissing(): void
     {
-        command('config:check');
+        $io = new MockInputOutput();
+        $io->setInputs(['App']);
+        CLI::setInputOutput($io);
 
-        $this->assertSame(
-            <<<'EOF'
+        command('config:check');
 
-                You must specify a Config classname.
-                  Usage: config:check <classname>
-                Example: config:check App
-                         config:check 'CodeIgniter\Shield\Config\Auth'
+        CLI::resetInputOutput();
 
-                EOF,
-            $this->getStreamFilterBuffer(),
-        );
+        $output = $io->getOutput();
+        $this->assertStringContainsString('Config class name', $output);
+        $this->assertStringContainsString('Config caching:', $output);
     }
 
     public function testCommandConfigCheckNonexistentClass(): void
     {
         command('config:check Nonexistent');
 
         $this->assertSame(
-            "\nNo such Config class: Nonexistent\n",
+            "\nConfig class \"Nonexistent\" not found.\n",
             $this->getStreamFilterBuffer(),
         );
     }
 
     public function testConfigCheckWithKintEnabledUsesKintD(): void
     {
-        /** @var Closure(mixed...): string */
         $command = self::getPrivateMethodInvoker(
-            new ConfigCheck(service('logger'), service('commands')),
+            new ConfigCheck(service('commands')),
             'getKintD',
         );
 
         command('config:check App');
 
         $this->assertSame(
             "\n" . $command(config('App')) . "\n",
-            preg_replace('/\s+Config Caching: \S+/', '', $this->getStreamFilterBuffer()),
+            preg_replace('/\s+Config caching: \S+/', '', $this->getStreamFilterBuffer()),
         );
     }
 
     public function testConfigCheckWithKintDisabledUsesVarDump(): void
     {
-        /** @var Closure(mixed...): string */
         $command = self::getPrivateMethodInvoker(
-            new ConfigCheck(service('logger'), service('commands')),
+            new ConfigCheck(service('commands')),
             'getVarDump',
         );
 
@@ -123,7 +119,7 @@ public function testConfigCheckWithKintDisabledUsesVarDump(): void
 
             $this->assertSame(
                 "\n" . $command(config('App')),
-                preg_replace('/\s+Config Caching: \S+/', '', $this->getStreamFilterBuffer()),
+                preg_replace('/\s+Config caching: \S+/', '', $this->getStreamFilterBuffer()),
             );
         } finally {
             Kint::$enabled_mode = true;

user_guide_src/source/general/configuration.rst

@@ -422,9 +422,9 @@ The output is like the following:
         public 'CSPEnabled' -> boolean false
     )
 
-    Config Caching: Disabled
+    Config caching: disabled
 
 You can see if Config Caching is enabled or not.
 
-.. note:: If Config Caching is enabled, the cached values are used permanently.
+.. note:: If config caching is enabled, the cached values are used permanently.
     See :ref:`factories-config-caching` for details.