refactor: refact the flag rule parse logic

Author: inhere

.github/workflows/php.yml

@@ -54,7 +54,10 @@ jobs:
       # Docs: https://getcomposer.org/doc/articles/scripts.md
 
       - name: Run test suite
-        run: phpunit -v
+        run: |
+          phpunit -v
+          php example flags-demo.php
+          php example sflags-demo.php
 
       # git status && git log -1 && git fetch --tags --force
       # git status && git log -1 && git fetch --prune --unshallow

README.md

@@ -76,11 +76,11 @@ use Toolkit\PFlag\Validator\EnumValidator;
 $fs->addOpt('age', 'a', 'this is a int option', FlagType::INT);
 
 // - use string rule
-$fs->addOptByRule('name,n', 'string;true;;this is a string option');
+$fs->addOptByRule('name,n', 'string;this is a string option;true');
 // -- add multi option at once.
 $fs->addOptsByRules([
-    'tag,t' => 'strings;no;;array option, allow set multi times',
-    'f'     => 'bool;no;;this is an bool option',
+    'tag,t' => 'strings;array option, allow set multi times',
+    'f'     => 'bool;this is an bool option',
 ]);
 // - use array rule
 /** @see Flags::DEFINE_ITEM for array rule */
@@ -108,7 +108,7 @@ use Toolkit\PFlag\FlagType;
 // - quick add
 $fs->addArg('strArg1', 'the is string arg and is required', 'string', true);
 // - use string rule
-$fs->addArgByRule('intArg2', 'int;no;89;this is a int arg and with default value');
+$fs->addArgByRule('intArg2', 'int;this is a int arg and with default value;no;89');
 // - use Argument object
 $arg = Argument::new('arrArg');
 // OR $arg->setType(FlagType::ARRAY);
@@ -201,7 +201,7 @@ $flags = ['--name', 'inhere', '--age', '99', '--tag', 'php', '-t', 'go', '--tag'
 
 $optRules = [
     'name', // string
-    'age'   => 'int;required', // set required
+    'age'   => 'int;;required', // set required
     'tag,t' => FlagType::ARRAY,
     'f'     => FlagType::BOOL,
 ];
@@ -249,7 +249,7 @@ $scriptFile = array_shift($rawFlags);
 $optRules = [
     // some option rules
     'name', // string
-    'age'   => 'int;required', // set required
+    'age'   => 'int;;required', // set required
     'tag,t' => FlagType::ARRAY,
     'f'     => FlagType::BOOL,
 ];
@@ -323,7 +323,7 @@ $arrArg = $fs->getArg('arrArg'); // array{"arr0", "arr1"}
 
 The options/arguments rules
 
-- string value is rule(`type;required;default;desc`).
+- string value is rule(`type;desc;required;default;shorts`).
 - array is define item `SFlags::DEFINE_ITEM`
 - supportted type see `FlagType::*`
 
@@ -337,7 +337,7 @@ $rules = [
      'f'      => 'bool',
      'long'   => FlagType::STRING,
      'tags'   => 'array', // can also: ints, strings
-     'name'   => 'type;required;default;the description message', // with default, desc, required
+     'name'   => 'type;the description message;required;default', // with desc, default, required
 ]
 ```
 

example/flags-demo.php

@@ -37,11 +37,11 @@
 $fs->addOpt('age', 'a', 'this is a int option', FlagType::INT);
 
 // - use string rule
-$fs->addOptByRule('name,n', 'string;true;;this is a string option');
+$fs->addOptByRule('name,n', 'string;this is a string option;true;');
 // -- add multi option at once.
 $fs->addOptsByRules([
-    'tag,t' => 'strings;no;;array option, allow set multi times',
-    'f'     => 'bool;no;;this is an bool option',
+    'tag,t' => 'strings;array option, allow set multi times',
+    'f'     => 'bool;this is an bool option',
 ]);
 // - use array rule
 /** @see Flags::DEFINE_ITEM for array rule */
@@ -63,7 +63,7 @@
 // - quick add
 $fs->addArg('strArg1', 'the is string arg and is required', 'string', true);
 // - use string rule
-$fs->addArgByRule('intArg2', 'int;no;89;this is a int arg and with default value');
+$fs->addArgByRule('intArg2', 'int;this is a int arg and with default value;no;89');
 // - use Argument object
 $arg = Argument::new('arrArg');
 // OR $arg->setType(FlagType::ARRAY);

example/sflags-demo.php

@@ -22,16 +22,16 @@
 
 $optRules = [
     // some option rules
-    'name'  => 'string;;;this is an string option', // string
-    'age'   => 'int;required;;this is an int option', // set required
-    'tag,t' => 'strings;no;;array option, allow set multi times',
-    'f'     => 'bool;no;;this is an bool option',
+    'name'  => 'string;this is an string option', // string
+    'age'   => 'int;this is an int option;required', // set required
+    'tag,t' => 'strings;array option, allow set multi times',
+    'f'     => 'bool;this is an bool option',
 ];
 $argRules = [
     // some argument rules
     'string',
     // set name
-    'arrArg' => 'strings;[a,b];;this is an array arg, allow multi value',
+    'arrArg' => 'strings;this is an array arg, allow multi value;;[a,b]',
 ];
 
 $fs = SFlags::new();