Merge pull request #6 from minicli/dx-improvements

DX Improvements

Author: erikaheidi

.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

.gitattributes

@@ -0,0 +1 @@
+/art                    export-ignore

.github/workflows/php.yml

@@ -29,5 +29,8 @@ jobs:
     - name: Install dependencies
       run: composer install --prefer-dist --no-progress
 
+    - name: Check code style
+      run: composer test:lint
+
     - name: Run test suite
-      run: composer run-script test
+      run: composer test:unit

README.md

@@ -1,5 +1,11 @@
-# Minicli Application Template
+<div align="center">
+    <p>
+        <img src="https://github.com/minicli/application/raw/main/art/minicli.png" alt="Minicli" width="150"/>
+        <h1>Minicli Application Template</h1>
+    </p>
+</div>
+<hr>
 
 This repository is an application template for building command-line applications in PHP with [Minicli](https://github.com/minicli/minicli). 
 
-Please check [the official documentation](https://docs.minicli.dev) for more information on how to use this application template.
+Please check [the official documentation](https://docs.minicli.dev) for more information on how to use this application template.

app/Command/Demo/DefaultController.php

@@ -1,14 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
-use Minicli\App;
 use Minicli\Command\CommandController;
 
 class DefaultController extends CommandController
 {
     public function handle(): void
     {
-        $this->getPrinter()->info('Run ./minicli help for usage help.');
+        $this->info('Run ./minicli help for usage help.');
     }
-}
+}

app/Command/Demo/TableController.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
 use Minicli\Command\CommandController;
@@ -10,17 +12,17 @@ class TableController extends CommandController
 {
     public function handle(): void
     {
-        $this->getPrinter()->display('Testing Tables');
+        $this->display('Testing Tables');
 
         $table = new TableHelper();
         $table->addHeader(['Header 1', 'Header 2', 'Header 3']);
 
         for($i = 1; $i <= 10; $i++) {
-            $table->addRow([(string)$i, (string)rand(0, 10), "other string $i"]);
+            $table->addRow([(string)$i, (string)rand(0, 10), "other string {$i}"]);
         }
 
-        $this->getPrinter()->newline();
-        $this->getPrinter()->rawOutput($table->getFormattedTable(new ColorOutputFilter()));
-        $this->getPrinter()->newline();
+        $this->newline();
+        $this->rawOutput($table->getFormattedTable(new ColorOutputFilter()));
+        $this->newline();
     }
-}
+}

app/Command/Demo/TestController.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Command\Demo;
 
 use Minicli\Command\CommandController;
@@ -9,8 +11,8 @@ class TestController extends CommandController
     public function handle(): void
     {
         $name = $this->hasParam('user') ? $this->getParam('user') : 'World';
-        $this->getPrinter()->display(sprintf("Hello, %s!", $name));
+        $this->display(sprintf("Hello, %s!", $name));
 
         print_r($this->getParams());
     }
-}
+}

art/minicli.png

@@ -10,14 +10,22 @@
     }
   },
   "require": {
-    "minicli/minicli": "^3.0",
-    "minicli/command-help": "^0.1.0"
+    "php": ">=8.1",
+    "minicli/minicli": "^4.0",
+    "minicli/command-help": "^1.0"
   },
   "require-dev": {
-    "pestphp/pest": "^1.21"
+    "pestphp/pest": "^1.21",
+    "laravel/pint": "^1.10"
   },
   "scripts": {
-    "test" : ["pest"]
+    "lint" : ["pint"],
+    "test:lint" : ["pint --test"],
+    "test:unit" : ["pest"],
+    "test" : [
+      "@test:lint",
+      "@test:unit"
+    ]
   },
   "config": {
     "allow-plugins": {