add global verbosity, stderr support and update documentation

Author: phpdevcommunity

README.md

@@ -15,7 +15,7 @@
     "ext-ctype": "*"
   },
   "require-dev": {
-    "phpdevcommunity/unitester": "^0.1.0@alpha"
+    "depo/unitester": "^1.0.0"
   },
   "license": "MIT",
   "authors": [
@@ -24,4 +24,4 @@
       "homepage": "https://www.phpdevcommunity.com"
     }
   ]
-}
+}

composer.json

@@ -47,6 +47,10 @@ public function __construct(array $commands)
 
     public function run(CommandParser $commandParser, OutputInterface $output): int
     {
+        if ($commandParser->hasOption('verbose') || $commandParser->hasOption('v')) {
+            $output->setVerbose(true);
+        }
+
         try {
 
             if ($commandParser->getCommandName() === null || $commandParser->getCommandName() === '--help') {
@@ -162,7 +166,7 @@ private function execute(CommandInterface $command, CommandParser $commandParser
         $peakMemoryBytes            = memory_get_peak_usage(true);
         $peakMemoryMB               = round($peakMemoryBytes / 1024 / 1024, 2);
         $duration                   = round($endTime - $startTime, 2);
-        if ($input->getOptionValue('verbose')) {
+        if ($output->isVerbose()) {
             $output->writeln(sprintf(
                 'Execution time: %.2fs; Peak memory usage: %.2f MB',
                 $duration,

src/CommandRunner.php

@@ -60,6 +60,7 @@ public function isFlag(): bool
     public static function flag(string $name, ?string $shortcut = null, ?string $description = null): self {
         return new self($name, $shortcut, $description, true);
     }
+    
     public static function withValue(string $name, ?string $shortcut = null, ?string $description = null): self {
         return new self($name, $shortcut, $description, false);
     }

src/Option/CommandOption.php

@@ -22,6 +22,11 @@ public function __construct(callable $output = null)
         $this->output = $output;
     }
 
+    /**
+     * @var bool
+     */
+    private bool $verbose = false;
+
     public function write(string $message): void
     {
         $output = $this->output;
@@ -33,4 +38,14 @@ public function writeln(string $message): void
         $this->write($message);
         $this->write(PHP_EOL);
     }
+
+    public function setVerbose(bool $verbose): void
+    {
+        $this->verbose = $verbose;
+    }
+
+    public function isVerbose(): bool
+    {
+        return $this->verbose;
+    }
 }

src/Output.php

@@ -61,7 +61,7 @@ public function success(string $message): void
     public function error(string $message): void
     {
         [$formattedMessage, $lineLength, $color] = $this->formatMessage('ERROR', $message, 'red');
-        $this->outputMessage($formattedMessage, $lineLength, $color);
+        $this->outputMessage($formattedMessage, $lineLength, $color, true);
     }
 
     public function warning(string $message): void
@@ -76,6 +76,16 @@ public function info(string $message): void
         $this->outputMessage($formattedMessage, $lineLength, $color);
     }
 
+    public function debug(string $message): void
+    {
+        if (!$this->output->isVerbose()) {
+            return;
+        }
+        [$formattedMessage, $lineLength, $color] = $this->formatMessage('DEBUG', $message, 'cyan');
+        $this->outputMessage($formattedMessage, $lineLength, $color);
+    }
+
+
     public function title(string $message): void
     {
         $consoleWidth = $this->geTerminalWidth();
@@ -92,6 +102,7 @@ public function title(string $message): void
     public function list(array $items): void
     {
         foreach ($items as $item) {
+            $item = $this->variableToString($item);
             $this->write('- ' . $item);
             $this->write(PHP_EOL);
         }
@@ -298,7 +309,7 @@ public function boxed(string $message, string $borderChar = '*', int $padding =
         $this->write(PHP_EOL);
     }
 
-    public function writeColor(string $message, ?string $color = null, ?string $background = null): void
+    public function writeColor(string $message, ?string $color = null, ?string $background = null, bool $isError = false): void
     {
 
         $formattedMessage = '';
@@ -312,11 +323,15 @@ public function writeColor(string $message, ?string $color = null, ?string $back
 
         $formattedMessage .= $message . "\033[0m";
 
-        $this->write($formattedMessage);
+        $this->write($formattedMessage, $isError);
     }
 
-    public function write(string $message): void
+    public function write(string $message, bool $isError = false): void
     {
+        if ($isError) {
+            fwrite(STDERR, $message);
+            return;
+        }
         $this->output->write($message);
     }
 
@@ -325,24 +340,24 @@ public function writeln(string $message): void
         $this->output->writeln($message);
     }
 
-    private function outputMessage($formattedMessage, int $lineLength, string $color): void
+    private function outputMessage($formattedMessage, int $lineLength, string $color, bool $isError = false): void
     {
-        $this->write(PHP_EOL);
-        $this->writeColor(str_repeat(' ', $lineLength), 'white', $color);
-        $this->write(PHP_EOL);
+        $this->write(PHP_EOL, $isError);
+        $this->writeColor(str_repeat(' ', $lineLength), 'white', $color, $isError);
+        $this->write(PHP_EOL, $isError);
 
         if (is_string($formattedMessage)) {
             $formattedMessage = [$formattedMessage];
         }
 
         foreach ($formattedMessage as $line) {
-            $this->writeColor($line, 'white', $color);
+            $this->writeColor($line, 'white', $color, $isError);
         }
 
-        $this->write(PHP_EOL);
-        $this->writeColor(str_repeat(' ', $lineLength), 'white', $color);
-        $this->write(PHP_EOL);
-        $this->write(PHP_EOL);
+        $this->write(PHP_EOL, $isError);
+        $this->writeColor(str_repeat(' ', $lineLength), 'white', $color, $isError);
+        $this->write(PHP_EOL, $isError);
+        $this->write(PHP_EOL, $isError);
     }
 
     private function formatMessage(string $prefix, string $message, string $color): array
@@ -390,4 +405,14 @@ private function variableToString($variable): string
 
         return var_export($variable, true);
     }
+
+    public function setVerbose(bool $verbose): void
+    {
+        $this->output->setVerbose($verbose);
+    }
+
+    public function isVerbose(): bool
+    {
+        return  $this->output->isVerbose();
+    }
 }

src/Output/ConsoleOutput.php

@@ -6,4 +6,6 @@ interface OutputInterface
 {
     public function write(string $message): void;
     public function writeln(string $message): void;
+    public function setVerbose(bool $verbose): void;
+    public function isVerbose(): bool;
 }

src/OutputInterface.php

@@ -4,7 +4,7 @@
 
 use PhpDevCommunity\Console\Argument\CommandArgument;
 use PhpDevCommunity\Console\Output;
-use PhpDevCommunity\UniTester\TestCase;
+use Depo\UniTester\TestCase;
 
 class CommandArgumentTest extends TestCase
 {
@@ -90,4 +90,4 @@ public function testGetDescriptionReturnsCorrectValue()
         $this->assertEquals('description', $arg->getDescription());
     }
 
-}
+}

tests/CommandArgumentTest.php

@@ -4,7 +4,7 @@
 
 use PhpDevCommunity\Console\Option\CommandOption;
 use PhpDevCommunity\Console\Output;
-use PhpDevCommunity\UniTester\TestCase;
+use Depo\UniTester\TestCase;
 
 class CommandOptionTest extends TestCase
 {
@@ -62,4 +62,4 @@ public function testIsFlag(): void
         $this->assertTrue($option->isFlag());
     }
 
-}
+}

tests/CommandOptionTest.php

@@ -3,7 +3,7 @@
 namespace Test\PhpDevCommunity\Console;
 
 use PhpDevCommunity\Console\CommandParser;
-use PhpDevCommunity\UniTester\TestCase;
+use Depo\UniTester\TestCase;
 
 class CommandParserTest extends TestCase
 {
@@ -78,4 +78,4 @@ private static function createArgv(array $argv): array
     {
         return array_merge(['bin/console'], $argv);
     }
-}
+}