.github/changelog.yml

@@ -1,27 +1,36 @@
-options:
-  title: '## Change Log'
-  style: gh-release
+title: '## Change Log'
+# style allow: simple, markdown(mkdown), ghr(gh-release)
+style: gh-release
+# group names
+names: [Refactor, Fixed, Feature, Update, Other]
+#repo_url: https://github.com/gookit/gcli
+
 filters:
-  # message length >= 12
-  - name: msgLen
-    minLen: 12
-  # message words >= 3
-  - name: wordsLen
-    minLen: 3
+  # message length should >= 12
+  - name: msg_len
+    min_len: 12
+  # message words should >= 3
+  - name: words_len
+    min_len: 3
+  - name: keyword
+    keyword: format code
+    exclude: true
   - name: keywords
-    keywords: ['format code']
+    keywords: format code, action test
     exclude: true
 
+# group match rules
 # not matched will use 'Other' group.
-groups:
-  - name: New
-    keywords: [add, new]
+rules:
+  - name: Refactor
+    start_withs: [refactor, break]
+    contains: ['refactor:', 'break:']
   - name: Fixed
-    startWiths: [add, new]
-    keywords: [add, new]
-  - name: Feat
-    startWiths: [feat]
-    keywords: [feature]
+    start_withs: [fix]
+    contains: ['fix:']
+  - name: Feature
+    start_withs: [feat, new]
+    contains: ['feat:', 'new:']
   - name: Update
-    startWiths: [update, 'up:']
-    keywords: [update]
+    start_withs: [up]
+    contains: ['update:', 'up:']

.github/workflows/php.yml

@@ -16,23 +16,15 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.3, 7.4, '8.0'] # 7.2,
+        php: [8.3, 8.1, 8.2]
 #        os: [ubuntu-latest] # , macOS-latest, windows-latest,
         coverage: ['none']
-        include:
-          - description: 'Log Code Coverage'
-            php: '8.0'
-            coverage: 'xdebug'
-#        include: # will not testing on php 7.2
-#          - os: 'ubuntu-latest'
-#            php: '7.2'
-#            phpunit: '8.5.13'
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: ~/.composer/cache/files
           key: ${{ matrix.php }}
@@ -59,21 +51,14 @@ jobs:
       - name: Install dependencies
         run: composer update --no-progress
 
-      - name: Generate changelog file
-        id: changelog
-        if: ${{ matrix.php == '7.4' }}
-        run: |
-          wget -c -q https://github.com/inhere/kite/releases/latest/download/kite.phar
-          php kite.phar git cl last head --style gh-release --no-merges --fetch-tags --unshallow --file example/changelog.md
-          cat example/changelog.md
-
       # phpunit -v --debug
+      # phpunit --coverage-clover ./test/clover.info
       # phpdbg -dauto_globals_jit=Off-qrr $(which phpunit) --coverage-clover ./test/clover.info
       - name: Run test suite
         run: |
           php example/flags-demo.php -h
           php example/sflags-demo.php --help
-          phpunit --coverage-clover ./test/clover.info
+          phpunit
 
 #      - name: Coveralls parallel
 #        uses: coverallsapp/github-action@master

.github/workflows/release.yml

@@ -7,59 +7,34 @@ on:
 
 jobs:
   release:
-    name: Test on php ${{ matrix.php}}
+    name: Tag release
     runs-on: ubuntu-latest
     timeout-minutes: 10
-    strategy:
-      fail-fast: true
-      matrix:
-        php: [7.4]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Set ENV for github-release
         # https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
         run: |
           echo "RELEASE_TAG=${GITHUB_REF:10}" >> $GITHUB_ENV
           echo "RELEASE_NAME=$GITHUB_WORKFLOW" >> $GITHUB_ENV
 
-      # usage refer https://github.com/shivammathur/setup-php
-      - name: Setup PHP
-        timeout-minutes: 5
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php}}
-          tools: pecl, php-cs-fixer, phpunit
-          extensions: mbstring, fileinfo, openssl # , swoole-4.4.19 #optional, setup extensions
-          ini-values: post_max_size=56M, short_open_tag=On #optional, setup php.ini configuration
-          coverage: none #optional, setup coverage driver: xdebug, none
-
-      - name: Install dependencies # eg: v1.0.3
-        run: |
-          echo $RELEASE_TAG
-          echo $RELEASE_NAME
-          tag1=${GITHUB_REF#refs/*/}
-          echo "release tag: ${tag1}"
-          composer update --no-progress
-
-      - name: Generate changelog file
-        id: changelog
+      - name: Generate changelog
         run: |
-          wget -c -q https://github.com/inhere/kite/releases/latest/download/kite.phar
-          php kite.phar git cl prev last --style gh-release --no-merges --fetch-tags --unshallow --file changelog.md
-          cat changelog.md
+          curl https://github.com/gookit/gitw/releases/latest/download/chlog-linux-amd64 -L -o /usr/local/bin/chlog
+          chmod a+x /usr/local/bin/chlog
+          chlog -c .github/changelog.yml -o changelog.md prev last 
 
       # https://github.com/softprops/action-gh-release
       - name: Create release and upload assets
-        uses: softprops/action-gh-release@v1
-#        if: startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v2
         with:
           name: ${{ env.RELEASE_TAG }}
           tag_name: ${{ env.RELEASE_TAG }}
           body_path: changelog.md
-          # files: kite-${{ env.RELEASE_TAG }}.phar
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-#         GITHUB_REPOSITORY: my_gh_org/my_gh_repo
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -12,6 +12,7 @@ vendor/
 *.tgz
 *.txt
 *.cache
+*.bak
 .phpintel/
 .env
 .phpstorm.meta.php

.php-cs-fixer.php

@@ -38,6 +38,7 @@
         PhpCsFixer\Finder::create()
             ->exclude('test')
             ->exclude('runtime')
+            ->exclude('.github')
             ->exclude('vendor')
             ->in(__DIR__)
     )

README.md

@@ -37,8 +37,15 @@ Generic PHP command line flags parse library
 - Support binding named arguemnt
 - Support define array argument
 
+### Quick build command
+
+- Use `Toolkit\PFlag\CliCmd` to quickly build a simple command application
+- Use `Toolkit\PFlag\CliApp` to quickly build a command application that supports subcommands
+
 ## Install
 
+- Require PHP 8.0+
+
 **composer**
 
 ```bash
@@ -226,13 +233,136 @@ $arrArg = $fs->getArg('arrArg'); // array{"arr0", "arr1"}
 
 -----------
 
-## Flag Rule
+## Build simple cli app
+
+In the pflag, built in `CliApp` and `CliCmd` for quick create and run an simple console application.
+
+### Create simple alone command
+
+Build and run a simple command handler. see example file [example/clicmd.php](example/clicmd.php)
+
+```php
+use Toolkit\Cli\Cli;
+use Toolkit\PFlag\CliCmd;
+use Toolkit\PFlag\FlagsParser;
+
+CliCmd::new()
+    ->config(function (CliCmd $cmd) {
+        $cmd->name = 'demo';
+        $cmd->desc = 'description for demo command';
+
+        // config flags
+        $cmd->options = [
+            'age, a'  => 'int;the option age, is int',
+            'name, n' => 'the option name, is string and required;true',
+            'tags, t' => 'array;the option tags, is array',
+        ];
+        // or use property
+        // $cmd->arguments = [...];
+    })
+    ->withArguments([
+        'arg1' => 'this is arg1, is string'
+    ])
+    ->setHandler(function (FlagsParser $fs) {
+        Cli::info('options:');
+        vdump($fs->getOpts());
+        Cli::info('arguments:');
+        vdump($fs->getArgs());
+    })
+    ->run();
+```
+
+**Usage:**
+
+```php
+# show help
+php example/clicmd.php -h
+# run command
+php example/clicmd.php --age 23 --name inhere value1
+```
+
+- Display help:
+
+![cmd-demo-help](example/images/cli-cmd-help.png)
+
+- Run command:
+
+![cmd-demo-run](example/images/cli-cmd-run.png)
+
+### Create an multi commands app
+
+Create an multi commands application, run subcommand. see example file [example/cliapp.php](example/cliapp.php)
+
+```php
+use Toolkit\Cli\Cli;
+use Toolkit\PFlag\CliApp;
+use Toolkit\PFlag\FlagsParser;
+use Toolkit\PFlagTest\Cases\DemoCmdHandler;
+
+$app = new CliApp();
+
+$app->add('test1', fn(FlagsParser $fs) => vdump($fs->getOpts()), [
+    'desc'    => 'the test 1 command',
+    'options' => [
+        'opt1' => 'opt1 for command test1',
+        'opt2' => 'int;opt2 for command test1',
+    ],
+]);
+
+$app->add('test2', function (FlagsParser $fs) {
+    Cli::info('options:');
+    vdump($fs->getOpts());
+    Cli::info('arguments:');
+    vdump($fs->getArgs());
+}, [
+    // 'desc'    => 'the test2 command',
+    'options' => [
+        'opt1' => 'a string opt1 for command test2',
+        'opt2' => 'int;a int opt2 for command test2',
+    ],
+    'arguments' => [
+        'arg1' => 'required arg1 for command test2;true',
+    ]
+]);
+
+// fn - required php 7.4+
+$app->add('show-err', fn() => throw new RuntimeException('test show exception'));
+
+$app->addHandler(DemoCmdHandler::class);
+
+$app->run();
+```
+
+**Usage:**
+
+```php
+# show help
+php example/cliapp.php -h
+# run command
+php example/cliapp.php test2 --opt1 val1 --opt2 23 value1
+```
+
+- Display commands:
+
+![cli-app-help](example/images/cli-app-help.png)
+
+- Command help:
+
+![cli-app-cmd-help](example/images/cli-app-cmd-help.png)
+
+- Run command:
+
+![cli-app-cmd-run](example/images/cli-app-cmd-run.png)
+
+-----------
+
+## Flag rule
 
 The options/arguments rules. Use rule can quick define an option or argument.
 
 - string value is rule(`type;desc;required;default;shorts`).
 - array is define item `SFlags::DEFINE_ITEM`
-- supportted type see `FlagType::*`
+- supported type see `FlagType::*`
 
 ```php
 use Toolkit\PFlag\FlagType;
@@ -258,7 +388,7 @@ $rules = [
 
 **For arguments**
 
-- arguemnt no alias/shorts
+- argument no alias/shorts
 - array value only allow defined at last
 
 **Definition item**
@@ -283,7 +413,7 @@ public const DEFINE_ITEM = [
 
 -----------
 
-## Costom settings
+## Custom settings
 
 ### Settings for parse