Merge pull request #3 from minicli/update-minicli3

Updating to support Minicli 3

Author: erikaheidi

.gitignore

@@ -1,2 +1,4 @@
 .idea
+.phpunit.result.cache
+.composer/
 vendor/

README.md

@@ -1,123 +1,5 @@
-# minicli
+# Minicli Application Template
 
-[Minicli](https://github.com/minicli/minicli) is an experimental dependency-free toolkit for building CLI-only applications in PHP created by @erikaheidi.
-This repository is a template you can use to create a new application that has a single dependency: `minicli/minicli`.
+This repository is an application template for building command-line applications in PHP with [Minicli](https://github.com/minicli/minicli). 
 
-### Why minicli
-
-The current trend in software development is basing your project on a big pile of unknowns. There is nothing wrong in using third party software, but if more than 80% of your application is out of your control, things can get messy.
-What usually happens is that you don't even know what packages you're depending on, when using the most popular frameworks.
-
-Minicli was created as [an educational experiment](https://dev.to/erikaheidi/bootstrapping-a-cli-php-application-in-vanilla-php-4ee) and a way to go dependency-free when building simple command-line applications in PHP. It can be used for microservices, personal dev tools, bots and little fun things.
-
-
-## Getting Started
-
-You'll need `php-cli` and [Composer](https://getcomposer.org/) to get started.
-
-Create a new project with:
-
-```bash
-composer create-project --prefer-dist minicli/application myapp
-```
-
-Once the installation is finished, you can run `minicli` it with:
-
-```bash
-cd myapp
-./minicli
-```
-If that doesn't work for you, you may have to use instead:
-
-```bash
-php minicli
-```
-This will show you the default app signature:
-
-```bash
-usage: ./minicli help
-```
-
-The default `help` command that comes with minicli (`app/Command/Help/DefaultController.php`) auto-generates a tree of available commands:
-
-```bash
-./minicli help
-```
-
-```bash
-Available Commands
-
-help
-└──test
-
-```
-
-The `help test` command, defined in `app/Command/Help/TestController.php`, shows an echo test of parameters:
-
-```bash
-./minicli help test user=erika name=value
-```
-
-```bash
-Hello, erika!
-
-Array
-(
-    [user] => erika
-    [name] => value
-)
-```
-
-### The simplest app
-
-The simplest minicli script doesn't require using Command Controllers at all. You can delete the `app` folder and use `registerCommand` with an anonymous function, like this:
-
-```php
-#!/usr/bin/php
-<?php
-
-if (php_sapi_name() !== 'cli') {
-    exit;
-}
-
-require __DIR__ . '/vendor/autoload.php';
-
-use Minicli\App;
-use Minicli\Command\CommandCall;
-
-$app = new App();
-$app->setSignature('./minicli mycommand');
-
-$app->registerCommand('mycommand', function(CommandCall $input) {
-    echo "My Command!";
-
-    var_dump($input);
-});
-
-$app->runCommand($argv);
-```
-
-## Tests
-To keep dependencies to a minimum, the `minicli/application` template repository doesn't require any specific testing framework, but we highly recommend using [PestPHP](https://pestphp.com), which is the testing framework used by [minicli/minicli](https://github.com/minicli/minicli).
-
-### Bootstrapping Tests with PestPHP
-
-To get started with PestPHP to test your Minicli application, first include the required dependencies with:
-
-```bash
-composer require pestphp/pest --dev --with-all-dependencies
-```
-
-Then, run the following command to create a tests folder and a couple example tests:
-
-```bash
-./vendor/bin/pest --init
-```
-
-Then you can use the following command to run the test suite:
-
-```bash
-./vendor/bin/pest
-```
-
-For more details on how to test your application with PestPHP, please refer to the [official documentation](https://pestphp.com/docs/writing-tests).
+Please check [the official documentation](https://docs.minicli.dev) for more information on how to use this application template.

app/Command/Help/DefaultController.php

@@ -10,13 +10,13 @@ class DefaultController extends CommandController
     /** @var  array */
     protected $command_map = [];
 
-    public function boot(App $app)
+    public function boot(App $app): void
     {
         parent::boot($app);
-        $this->command_map = $app->command_registry->getCommandMap();
+        $this->command_map = $app->commandRegistry->getCommandMap();
     }
 
-    public function handle()
+    public function handle(): void
     {
         $this->getPrinter()->info('Available Commands');
 

app/Command/Help/TableController.php

@@ -8,15 +8,15 @@
 
 class TableController extends CommandController
 {
-    public function handle()
+    public function handle(): void
     {
         $this->getPrinter()->display('Testing Tables');
 
         $table = new TableHelper();
         $table->addHeader(['Header 1', 'Header 2', 'Header 3']);
 
         for($i = 1; $i <= 10; $i++) {
-            $table->addRow([$i, rand(0, 10), "other string $i"]);
+            $table->addRow([(string)$i, (string)rand(0, 10), "other string $i"]);
         }
 
         $this->getPrinter()->newline();

app/Command/Help/TestController.php

@@ -6,7 +6,7 @@
 
 class TestController extends CommandController
 {
-    public function handle()
+    public function handle(): void
     {
         $name = $this->hasParam('user') ? $this->getParam('user') : 'World';
         $this->getPrinter()->display(sprintf("Hello, %s!", $name));

composer.json

@@ -10,6 +10,12 @@
     }
   },
   "require": {
-    "minicli/minicli": "^2.0"
+    "minicli/minicli": "^3.0"
+  },
+  "require-dev": {
+    "pestphp/pest": "^1.21"
+  },
+  "scripts": {
+    "test" : ["pest"]
   }
 }