Merge pull request #30 from OnitaAndrei/issue-29

Added documentation for v3

Author: alexmerlin

.github/workflows/continuous-integration.yml

@@ -0,0 +1,11 @@
+name: "Continuous Integration"
+
+on:
+  pull_request:
+  push:
+    branches:
+    tags:
+
+jobs:
+  ci:
+    uses: laminas/workflow-continuous-integration/.github/workflows/[email protected]

.github/workflows/cs-tests.yml

@@ -0,0 +1,16 @@
+name: docs-build
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build Docs
+        uses: dotkernel/documentation-theme/github-actions/docs@main
+        env:
+          DEPLOY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs-build.yml

@@ -15,73 +15,79 @@
 
 DotKernel component to build console applications based on [laminas-cli](https://github.com/laminas/laminas-cli).
 
-### Requirements
+## Requirements
+
 - PHP >= 8.2
 - laminas/laminas-servicemanager >= 3.11,
 - laminas/laminas-cli >= 1.4
 
+## Setup
+
+### 1. Install package
 
-### Setup
-#### 1. Install package
 Run the following command in your application's root directory:
 
     composer require dotkernel/dot-cli
 
-#### 2. Register ConfigProvider
+### 2. Register ConfigProvider
+
 Open your application's `config/config.php` and the following line under the _DK packages_ comment:
 
      Dot\Cli\ConfigProvider::class,
 
-#### 3. Copy bootstrap file
+### 3. Copy bootstrap file
+
 Locate file `bin/cli.php` in this package, then copy it to your application's `bin/` directory.
 This is the bootstrap file you will use to execute your commands with.
 
-#### 4. Copy config file
+### 4. Copy config file
+
 Locate in this package the following file `config/autoload/cli.global.php` then copy it to your application's `config/autoload/` directory.
 This is the config file you will add your commands to.
 
+## Testing
 
-### Testing
 Using the command line, go to your application's root directory, then type the following command:
 
     php /bin/cli.php
 
 The output should look similar to this, containing information on how to start using dot-cli:
-```text
-DotKernel CLI 1.0.0
-
-Usage:
-  command [options] [arguments]
-
-Options:
-  -h, --help            Display help for the given command. When no command is given display help for the list command
-  -q, --quiet           Do not output any message
-  -V, --version         Display this application version
-      --ansi            Force ANSI output
-      --no-ansi         Disable ANSI output
-  -n, --no-interaction  Do not ask any interactive question
-  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
-Available commands:
-  help          Display help for a command
-  list          List commands
- demo
-  demo:command  Demo command description.
-```
+
+    DotKernel CLI 1.0.0
+    
+    Usage:
+      command [options] [arguments]
+    
+    Options:
+      -h, --help            Display help for the given command. When no command is given display help for the list command
+      -q, --quiet           Do not output any message
+      -V, --version         Display this application version
+          --ansi            Force ANSI output
+          --no-ansi         Disable ANSI output
+      -n, --no-interaction  Do not ask any interactive question
+      -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+    
+    Available commands:
+      help          Display help for a command
+      list          List commands
+     demo
+      demo:command  Demo command description.
+
 As shown in `config/autoload/cli.global.php`, dot-cli includes a demo command `demo:command` that will help you understand the basics of creating a new command.
 For more information, see [laminas-cli documentation](https://docs.laminas.dev/laminas-cli/).
 
-### Setting up as cronjob
-```text
-*   *   *   *   *   /opt/plesk/php/7.4/bin/php /var/www/vhosts/example.com/httpdocs/bin/cli.php demo:command -q
-```
+## Setting up as cronjob
+
+    *   *   *   *   *   /opt/plesk/php/7.4/bin/php /var/www/vhosts/example.com/httpdocs/bin/cli.php demo:command -q
+
 or
-```text
-*   *   *   *   *   cd /var/www/vhosts/example.com/httpdocs/bin && /opt/plesk/php/7.4/bin/php ./cli.php demo:command -q
-```
+
+    *   *   *   *   *   cd /var/www/vhosts/example.com/httpdocs/bin && /opt/plesk/php/7.4/bin/php ./cli.php demo:command -q
+
 Adapt the command to your specifications by replacing **7.4** with your PHP version and **example.com** with your domain name.
 
 Note the **-q** (or **--quiet**) option at the end of the command - it serves as a flag to inform the Application that no output should be returned (unless it's an error).
 
 ## License
+
 MIT

.github/workflows/static-analysis.yml

@@ -0,0 +1,40 @@
+# Security Policy
+
+## Supported Versions
+
+
+| Version | Supported          | PHP Version                                                                                             |
+|---------|--------------------|---------------------------------------------------------------------------------------------------------|
+| 3.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-cli/3.4.2) |
+| <= 2.x  | :x:                |                                                                                                         |
+
+
+## Reporting Potential Security Issues
+
+If you have encountered a potential security vulnerability in this project,
+please report it to us at <[email protected]>. We will work with you to
+verify the vulnerability and patch it.
+
+When reporting issues, please provide the following information:
+
+- Component(s) affected
+- A description indicating how to reproduce the issue
+- A summary of the security vulnerability and impact
+
+We request that you contact us via the email address above and give the
+project contributors a chance to resolve the vulnerability and issue a new
+release prior to any public exposure; this helps protect the project's
+users, and provides them with a chance to upgrade and/or update in order to
+protect their applications.
+
+
+## Policy
+
+If we verify a reported security vulnerability, our policy is:
+
+- We will patch the current release branch, as well as the immediate prior minor
+  release branch.
+
+- After patching the release branches, we will immediately issue new security
+  fix releases for each patched release branch.
+

.github/workflows/unit-tests.yml

@@ -35,7 +35,7 @@
     },
     "require-dev": {
         "laminas/laminas-coding-standard": "^2.5",
-        "mikey179/vfsstream": "^1.6",
+        "mikey179/vfsstream": "^1.6.7",
         "phpunit/phpunit": "^10.2",
         "vimeo/psalm": "^5.13"
     },

README.md

@@ -0,0 +1 @@
+../../README.md

SECURITY.md

@@ -0,0 +1,22 @@
+# Configuration
+
+## Register ConfigProvider
+
+After installation, register `dot-cli` in your project by adding the below line to your configuration aggregator (usually: `config/config.php`):
+
+      Dot\Cli\ConfigProvider::class,
+
+## Copy bootstrap file
+
+Locate file `bin/cli.php` in this package, then copy it to your application's `bin/` directory.
+This is the bootstrap file you will use to execute your commands with.
+
+## Copy config file
+
+Locate in this package the following file `config/autoload/cli.global.php` then copy it to your application's `config/autoload/` directory.
+This is the config file you will add your commands under the `commands` key, as in the following example:
+
+        'commands' => [
+            DemoCommand::getDefaultName()     => DemoCommand::class,
+            ExampleCommand::getDefaultName()  => ExampleCommand::class,
+        ],