Merge pull request #1 from minicli/dx-improvements

DX Improvements
minicli · May 19, 2023 · 7bd18ff · 7bd18ff
2 parents cae8e48 + ba47dcc
commit 7bd18ff
Show file tree

Hide file tree

Showing 20 changed files with 155 additions and 78 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml,json}]
+indent_size = 2
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -29,8 +29,8 @@ jobs:
     - name: Install dependencies
       run: composer install --prefer-dist --no-progress
 
-    - name: Run Pint
-      run: composer lint
+    - name: Check code style
+      run: composer test:lint
 
     - name: Run test suite
-      run: composer run-script test
+      run: composer test:unit
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
 <div align="center">
     <p>
-        <img src="https://github.com/WendellAdriel/miniterm/raw/main/art/minicli.png" alt="Minicli" width="150"/>
-        <img src="https://github.com/WendellAdriel/miniterm/raw/main/art/termwind.png" alt="Termwind" width="150"/>
-        <img src="https://github.com/WendellAdriel/miniterm/raw/main/art/plates.png" alt="Plates" width="150"/>
+        <img src="https://github.com/minicli/miniterm/raw/main/art/minicli.png" alt="Minicli" width="150"/>
+        <img src="https://github.com/minicli/miniterm/raw/main/art/termwind.png" alt="Termwind" width="150"/>
+        <img src="https://github.com/minicli/miniterm/raw/main/art/plates.png" alt="Plates" width="150"/>
         <h1>MiniTerm</h1>
-        Minicli Application Template powered with Termwind and Plates
+        <h4>Minicli Application Template powered with Termwind and Plates</h4>
     </p>
 </div>
+<hr>
 
 This repository is an application template for building command-line applications in PHP with [Minicli](https://github.com/minicli/minicli), [Termwind](https://github.com/nunomaduro/termwind) and [Plates](https://github.com/thephpleague/plates). 
 

diff --git a/app/Command/BaseController.php b/app/Command/BaseController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command;
 
 use Minicli\Command\CommandController;

diff --git a/app/Command/Demo/AskController.php b/app/Command/Demo/AskController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
 use App\Command\BaseController;

diff --git a/app/Command/Demo/ColorController.php b/app/Command/Demo/ColorController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
 use App\Command\BaseController;
@@ -8,20 +10,20 @@ class ColorController extends BaseController
 {
     public function handle(): void
     {
-        $this->getPrinter()->display("Hello World");
-        $this->getPrinter()->error("Hello World");
-        $this->getPrinter()->info("Hello World");
-        $this->getPrinter()->success("Hello World");
-        $this->getPrinter()->warning("Hello World");
-        $this->getPrinter()->display("Hello World", true);
-        $this->getPrinter()->error("Hello World", true);
-        $this->getPrinter()->info("Hello World", true);
-        $this->getPrinter()->success("Hello World", true);
-        $this->getPrinter()->warning("Hello World", true);
-        $this->getPrinter()->out("Hello World!\r\n", 'underline');
-        $this->getPrinter()->out("Hello World!\r\n", 'dim');
-        $this->getPrinter()->out("Hello World!\r\n", 'bold');
-        $this->getPrinter()->out("Hello World!\r\n", 'invert');
-        $this->getPrinter()->out("Hello World!\r\n", 'italic');
+        $this->display("Hello World");
+        $this->error("Hello World");
+        $this->info("Hello World");
+        $this->success("Hello World");
+        $this->warning("Hello World");
+        $this->display("Hello World", true);
+        $this->error("Hello World", true);
+        $this->info("Hello World", true);
+        $this->success("Hello World", true);
+        $this->warning("Hello World", true);
+        $this->out("Hello World!\r\n", 'underline');
+        $this->out("Hello World!\r\n", 'dim');
+        $this->out("Hello World!\r\n", 'bold');
+        $this->out("Hello World!\r\n", 'invert');
+        $this->out("Hello World!\r\n", 'italic');
     }
 }
diff --git a/app/Command/Demo/DefaultController.php b/app/Command/Demo/DefaultController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
 use App\Command\BaseController;

diff --git a/app/Command/Demo/TableController.php b/app/Command/Demo/TableController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
 use App\Command\BaseController;
@@ -12,7 +14,7 @@ public function handle(): void
         $rows = [];
 
         for ($i = 1; $i <= 10; $i++) {
-            $rows[] = [(string) $i, (string) rand(0, 10), "other string $i"];
+            $rows[] = [(string) $i, (string) rand(0, 10), "other string {$i}"];
         }
 
         $this->view('table', [

diff --git a/app/Command/Demo/TestController.php b/app/Command/Demo/TestController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
 use App\Command\BaseController;

diff --git a/app/Config/TermwindOutputConfig.php b/app/Config/TermwindOutputConfig.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Config;
 
 class TermwindOutputConfig

diff --git a/app/Config/TermwindOutputHandler.php b/app/Config/TermwindOutputHandler.php
@@ -1,19 +1,20 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Config;
 
 use Minicli\Output\OutputHandler;
-use Minicli\Output\PrinterAdapterInterface;
 
 use function Termwind\render;
 
 class TermwindOutputHandler extends OutputHandler
 {
     private TermwindOutputConfig $config;
 
-    public function __construct(?PrinterAdapterInterface $printer = null)
+    public function __construct()
     {
-        parent::__construct($printer);
+        parent::__construct();
         $this->config = new TermwindOutputConfig();
     }
 
@@ -24,9 +25,9 @@ public function out(string $content, string $style = "default"): void
 
         $formatted = <<<HTML
             <div>
-                $label
-                <span class="ml-1 $cssClass">
-                  $content
+                {$label}
+                <span class="ml-1 {$cssClass}">
+                  {$content}
                 </span>
             </div>
         HTML;
@@ -87,8 +88,8 @@ private function getLabel(string $style): string
 
         $cssClass = $this->getCssClass($style);
         $color = str_replace('text-', 'bg-', $cssClass);
-        $label = str_replace('_ALT', '', strtoupper($style));
+        $label = str_replace('_ALT', '', mb_strtoupper($style));
 
-        return "<div class='px-1 $color text-black'>$label</div>";
+        return "<div class='px-1 {$color} text-black'>{$label}</div>";
     }
 }
diff --git a/app/Services/PlatesService.php b/app/Services/PlatesService.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Services;
 
 use League\Plates\Engine;
@@ -12,7 +14,7 @@ class PlatesService implements ServiceInterface
 
     public function __construct()
     {
-        $this->plates = new Engine(__DIR__ . '/../../app/Views');
+        $this->plates = new Engine(__DIR__.'/../../app/Views');
     }
 
     public function view(string $template, array $data = []): string

diff --git a/app/Services/TermwindService.php b/app/Services/TermwindService.php
@@ -1,21 +1,24 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Services;
 
 use Minicli\App;
 use Minicli\ServiceInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+use Termwind\Terminal;
+use Termwind\ValueObjects\Style;
+
 use function Termwind\ask;
+
 use function Termwind\render;
-use function Termwind\style;
 
-use Termwind\Terminal;
+use function Termwind\style;
 
 use function Termwind\terminal;
 
-use Termwind\ValueObjects\Style;
-
 class TermwindService implements ServiceInterface
 {
     public function load(App $app): void

diff --git a/composer.json b/composer.json
@@ -10,9 +10,9 @@
     }
   },
   "require": {
-    "php": ">=8",
-    "minicli/minicli": "^3.0",
-    "minicli/command-help": "^0.1.0",
+    "php": ">=8.1",
+    "minicli/minicli": "^4.0",
+    "minicli/command-help": "^1.0",
     "nunomaduro/termwind": "^1.15",
     "league/plates": "^3.5"
   },
@@ -21,8 +21,13 @@
     "laravel/pint": "^1.10"
   },
   "scripts": {
-    "test" : ["pest"],
-    "lint" : ["pint"]
+    "lint" : ["pint"],
+    "test:lint" : ["pint --test"],
+    "test:unit" : ["pest"],
+    "test": [
+      "@test:lint",
+      "@test:unit"
+    ]
   },
   "config": {
     "allow-plugins": {

diff --git a/composer.lock b/composer.lock
diff --git a/minicli b/minicli
@@ -33,12 +33,12 @@ $app->setOutputHandler(new TermwindOutputHandler());
 try {
     $app->runCommand($argv);
 } catch (CommandNotFoundException $notFoundException) {
-    $app->getPrinter()->error("Command Not Found.");
+    $app->error("Command Not Found.");
     return 1;
 } catch (Exception $exception) {
     if ($app->config->debug) {
-        $app->getPrinter()->error("An error occurred:");
-        $app->getPrinter()->error($exception->getMessage());
+        $app->error("An error occurred:");
+        $app->error($exception->getMessage());
     }
     return 1;
 }