clean up cli help setup, allow single string, add command prefix in automatically

Author: hinanaya

cli/ob.php

@@ -81,7 +81,18 @@ public function help()
             require_once(OB_LOCAL . '/core/cli/' . $cliPath);
 
             $cliClass = new $cliClassName();
-            $rows = [...$rows, ...$cliClass->help()];
+            $help = $cliClass->help();
+
+            if (is_array($help)) {
+                foreach ($help as &$helpItem) {
+                    $helpItem[0] = $cliCommand . ' ' . $helpItem[0];
+                }
+                $rows = [...$rows, ...$help];
+            }
+
+            if (is_string($help)) {
+                $rows = [...$rows, [$cliCommand, $help]];
+            }
         }
 
         echo Helpers::table(spacing: 5, rows: $rows);

core/base/CLI.php

@@ -15,7 +15,7 @@ abstract class CLI
     protected $db;
     protected $models;
 
-    protected array $help;
+    protected array|string $help;
 
     final public function __construct()
     {
@@ -27,7 +27,7 @@ final public function __construct()
         }
     }
 
-    final public function help(): array
+    final public function help(): array|string
     {
         return $this->help;
     }

core/cli/CheckInstall.php

@@ -6,9 +6,7 @@
 
 class CheckInstall extends CLI
 {
-    protected array $help = [
-        ['check install', 'check installation for errors']
-    ];
+    protected array|string $help = 'check installation for errors';
 
     public function run(array $args): bool
     {

core/cli/CheckMedia.php

@@ -6,9 +6,7 @@
 
 class CheckMedia extends CLI
 {
-    protected array $help = [
-        ['check media', 'check media for errors'],
-    ];
+    protected array|string $help = 'check media for errors';
 
     public function run(array $args): bool
     {

core/cli/Cron.php

@@ -7,10 +7,10 @@
 class Cron extends CLI
 {
     private string $obCronLog;
-    protected array $help = [
-        ['cron run', 'run scheduled tasks once'],
-        ['cron run <module> <task> [now]', 'run scheduled task for module'],
-        ['cron monitor', 'monitor and run cron tasks as needed'],
+    protected array|string $help = [
+        ['run', 'run scheduled tasks once'],
+        ['run <module> <task> [now]', 'run scheduled task for module'],
+        ['monitor', 'monitor and run cron tasks as needed'],
     ];
 
     public function run(array $args): bool

core/cli/Modules.php

@@ -6,11 +6,11 @@
 
 class Modules extends CLI
 {
-    protected array $help = [
-        ['modules list', 'list all modules and their status'],
-        ['modules install <name>', 'install module'],
-        ['modules uninstall <name>', 'uninstall module'],
-        ['modules purge <name>', 'uninstall module and delete all data'],
+    protected array|string $help = [
+        ['list', 'list all modules and their status'],
+        ['install <name>', 'install module'],
+        ['uninstall <name>', 'uninstall module'],
+        ['purge <name>', 'uninstall module and delete all data'],
     ];
 
     public function run(array $args): bool

core/cli/Passwd.php

@@ -6,8 +6,8 @@
 
 class Passwd extends CLI
 {
-    protected array $help = [
-        ['passwd <username>', 'change password for user'],
+    protected array|string $help = [
+        ['<username>', 'change password for user'],
     ];
 
     public function run(array $args): bool

core/cli/UpdatesList.php

@@ -6,10 +6,10 @@
 
 class UpdatesList extends CLI
 {
-    protected array $help = [
-        ['updates list all', 'list all available updates'],
-        ['updates list core', 'list core ob updates'],
-        ['updates list module <name>', 'list updates for specified module'],
+    protected array|string $help = [
+        ['all', 'list all available updates'],
+        ['core', 'list core ob updates'],
+        ['module <name>', 'list updates for specified module'],
     ];
 
     public function run(array $args): bool

core/cli/UpdatesRun.php

@@ -6,10 +6,10 @@
 
 class UpdatesRun extends CLI
 {
-    protected array $help = [
-        ['updates run all', 'run all available updates'],
-        ['updates run core', 'run core ob updates'],
-        ['updates run module <name>', 'run updates for specified module'],
+    protected array|string $help = [
+        ['all', 'run all available updates'],
+        ['core', 'run core ob updates'],
+        ['module <name>', 'run updates for specified module'],
     ];
 
     public function run(array $args): bool