Initial commit

Author: erikaheidi

.github/workflows/php.yml

@@ -0,0 +1,27 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run test suite
+      run: composer test
+
+    - name: Run php-cs-fixer
+      run: composer csfix .

.gitignore

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

Command/Help/DefaultController.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace librarianphp\Help;
+
+use Minicli\App;
+use Minicli\Command\CommandController;
+use Minicli\Command\CommandRegistry;
+
+class DefaultController extends CommandController
+{
+    /** @var  array */
+    protected array $commandMap = [];
+
+    public function boot(App $app): void
+    {
+        parent::boot($app);
+        $this->commandMap = $app->commandRegistry->getCommandMap();
+    }
+
+    public function handle(): void
+    {
+        $this->getPrinter()->info($this->app->getSignature());
+
+        $print_table[] = [ 'Namespace', 'Command' ];
+
+        foreach ($this->commandMap as $command => $sub) {
+            if ($command == 'web') {
+                continue;
+            }
+            $print_table[] = [ $command, ''];
+            if (is_array($sub)) {
+                foreach ($sub as $subcommand) {
+                    if ($subcommand == 'default') {
+                        $row = "./librarian $command\n";
+                    } else {
+                        $row = "./librarian $command $subcommand\n";
+                    }
+
+                    $print_table[] = [ '', $row ];
+                }
+            }
+        }
+
+        $this->getPrinter()->printTable($print_table);
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 minicli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,7 @@
+# command-help
+
+Librarian's built-in help command.
+
+```shell
+./librarian help
+```

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "librarianphp/command-help",
+    "type": "library",
+    "description": "Librarian's built-in help command",
+    "license": "MIT",
+    "homepage": "https://github.com/librarianphp/command-demo",
+    "keywords": ["cli","command-line", "markdown"],
+    "autoload": {
+        "psr-4": {
+            "librarianphp\\": "Command/"
+        }
+    },
+    "require": {
+        "minicli/minicli": "^3.2"
+    },
+    "require-dev": {
+        "pestphp/pest": "^2.4",
+        "friendsofphp/php-cs-fixer": "^3.16"
+    },
+    "scripts": {
+        "test" : ["pest"],
+        "csfix": ["php-cs-fixer fix"]
+    },
+
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    }
+}