up: AbstractHandler add new prop:desc instead the prop:description

Author: inhere

src/Concern/ApplicationHelpTrait.php

@@ -218,7 +218,7 @@ public function showCommandList(): void
             $options    = $info['options'];
             $controller = $info['handler'];
             /** @var AbstractHandler $controller */
-            $desc    = $controller::getDescription() ?: $placeholder;
+            $desc    = $controller::getDesc() ?: $placeholder;
             $aliases = $options['aliases'];
             $extra   = $aliases ? ColorTag::wrap(' (alias: ' . implode(',', $aliases) . ')', 'info') : '';
 
@@ -237,7 +237,7 @@ public function showCommandList(): void
 
             /** @var AbstractHandler $command */
             if (is_subclass_of($command, CommandInterface::class)) {
-                $desc = $command::getDescription() ?: $placeholder;
+                $desc = $command::getDesc() ?: $placeholder;
             } elseif ($msg = $options['desc'] ?? '') {
                 $desc = $msg;
             } elseif (is_string($command)) {

src/Concern/ControllerHelpTrait.php

@@ -99,7 +99,7 @@ public function showCommandList(): void
         $ref   = new ReflectionClass($this);
         $sName = lcfirst(self::getName() ?: $ref->getShortName());
 
-        if (!($classDes = self::getDescription())) {
+        if (!($classDes = self::getDesc())) {
             $classDes = PhpDoc::description($ref->getDocComment()) ?: 'No description for the command group';
         }
 

src/Controller.php

@@ -556,7 +556,7 @@ protected function getAllCommandMethods(ReflectionClass $ref = null, bool $onlyN
      * @param string $name
      *
      * @return string
-     * @description please use resolveAlias()
+     * @deprecated please use resolveAlias()
      */
     public function getRealCommandName(string $name): string
     {

src/Handler/AbstractHandler.php

@@ -66,6 +66,14 @@ abstract class AbstractHandler implements CommandHandlerInterface
      *
      * @var string
      */
+    protected static $desc = '';
+
+    /**
+     * command/controller description message
+     *
+     * @var string
+     * @deprecated please use {@see $desc}
+     */
     protected static $description = '';
 
     /**
@@ -614,33 +622,33 @@ final public static function getName(): string
      */
     public static function getDesc(): string
     {
-        return static::$description;
+        return static::$desc ?: static::$description;
     }
 
     /**
-     * @return string
+     * @param string $desc
      */
-    public static function getDescription(): string
+    public static function setDesc(string $desc): void
     {
-        return static::$description;
+        if ($desc) {
+            static::$desc = $desc;
+        }
     }
 
     /**
-     * @param string $desc
+     * @return string
      */
-    public static function setDesc(string $desc): void
+    public static function getDescription(): string
     {
-        self::setDescription($desc);
+        return self::getDesc();
     }
 
     /**
-     * @param string $description
+     * @param string $desc
      */
-    public static function setDescription(string $description): void
+    public static function setDescription(string $desc): void
     {
-        if ($description) {
-            static::$description = $description;
-        }
+        self::setDesc($desc);
     }
 
     /**

test/CommandTest.php

@@ -24,6 +24,6 @@ public function testBasic(): void
         $c = new TestCommand(new Input(), new Output());
 
         $this->assertSame('test1', $c::getName());
-        $this->assertStringContainsString('desc', $c::getDescription());
+        $this->assertStringContainsString('desc', $c::getDesc());
     }
 }