chore: run php-cs-fixer for the ./

php-toolkit · Jan 2, 2022 · 24d17d5 · 24d17d5
1 parent 8e36450
commit 24d17d5
Show file tree

Hide file tree

Showing 41 changed files with 292 additions and 55 deletions.
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -38,6 +38,7 @@
         PhpCsFixer\Finder::create()
             ->exclude('test')
             ->exclude('runtime')
+            ->exclude('.github')
             ->exclude('vendor')
             ->in(__DIR__)
     )

diff --git a/example/cliapp.php b/example/cliapp.php
@@ -1,4 +1,11 @@
-<?php
+<?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 use Toolkit\Cli\Cli;
 use Toolkit\PFlag\CliApp;
@@ -10,18 +17,19 @@
 // run demo:
 // php example/cliapp.php
 
-$app = CliApp::newWith(function (CliApp $app) {
+$cli = CliApp::newWith(static function (CliApp $app): void {
     $app->setName('myApp');
+    $app->setDesc('my cli application. v1.0.1');
 })
-    ->add('test1', fn(FlagsParser $fs) => vdump($fs->getOpts()), [
+    ->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->add('test2', function (FlagsParser $fs): void {
     Cli::info('options:');
     vdump($fs->getOpts());
     Cli::info('arguments:');
@@ -37,9 +45,8 @@
     ]
 ]);
 
-$app->add('show-err', fn() => throw new RuntimeException('test show exception'));
+$cli->add('show-err', fn () => throw new RuntimeException('test show exception'));
 
-$app->addHandler(DemoCmdHandler::class);
-
-$app->run();
+$cli->addHandler(DemoCmdHandler::class);
 
+$cli->run();
diff --git a/example/clicmd.php b/example/clicmd.php
@@ -1,4 +1,11 @@
-<?php
+<?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 use Toolkit\Cli\Cli;
 use Toolkit\PFlag\CliCmd;
@@ -11,7 +18,7 @@
 // php example/clicmd.php --name inhere value1
 // php example/clicmd.php --age 23 --name inhere value1
 
-CliCmd::newWith(function (CliCmd $cmd) {
+CliCmd::newWith(static function (CliCmd $cmd): void {
     $cmd->name = 'demo';
     $cmd->desc = 'description for demo command';
 
@@ -28,11 +35,10 @@
     ->withArguments([
         'arg1' => 'this is arg1, is string'
     ])
-    ->setHandler(function (FlagsParser $fs) {
+    ->setHandler(function (FlagsParser $fs): void {
         Cli::info('options:');
         vdump($fs->getOpts());
         Cli::info('arguments:');
         vdump($fs->getArgs());
     })
     ->run();
-
diff --git a/example/not-stop_on_first.php b/example/not-stop_on_first.php
@@ -1,5 +1,11 @@
-<?php
-// run: php example/not-stop_on_first.php
+<?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 use Toolkit\PFlag\Flags;
 

diff --git a/example/refer.php b/example/refer.php
@@ -1,7 +1,14 @@
-<?php
+<?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 $flags = ['--name', 'inhere', '--tags', 'php', '-t', 'go', '--tags', 'java', '-f', 'arg0'];
-echo "count: ", count($flags), "\n";
+echo 'count: ', count($flags), "\n";
 
 $cur = current($flags);
 $key = key($flags);

diff --git a/example/sflags-demo.php b/example/sflags-demo.php
@@ -73,4 +73,4 @@
     $fs->getArgs()
 );
 
-// vdump($fs->getArg('arrArg'));
+// vdump($fs->getArg('arrArg'));
diff --git a/src/CliApp.php b/src/CliApp.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag;
 
@@ -660,14 +667,20 @@ public function setParams(array $params): void
 
     /**
      * @param string $name
-     *
-     * @return void
      */
     public function setName(string $name): void
     {
         $this->params['name'] = $name;
     }
 
+    /**
+     * @param string $name
+     */
+    public function setDesc(string $name): void
+    {
+        $this->params['name'] = $name;
+    }
+
     /**
      * @return FlagsParser
      */

diff --git a/src/CliCmd.php b/src/CliCmd.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag;
 
@@ -18,6 +25,7 @@ class CliCmd
     }
 
     public string $name = '';
+
     public string $desc = 'command description';
 
     /**

diff --git a/src/Concern/HelperRenderTrait.php b/src/Concern/HelperRenderTrait.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Concern;
 

diff --git a/src/Concern/RuleParserTrait.php b/src/Concern/RuleParserTrait.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Concern;
 
@@ -292,7 +299,7 @@ protected function parseRuleOptName(string $key): array
 
             // max length string as option name.
             if (($kl = strlen($k)) > 1) {
-                if (!$name ) {
+                if (!$name) {
                     $name = $k;
                 } elseif ($kl > strlen($name)) {
                     $aliases[] = $name;

diff --git a/src/Contract/CmdHandlerInterface.php b/src/Contract/CmdHandlerInterface.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Contract;
 

diff --git a/src/Contract/ParserInterface.php b/src/Contract/ParserInterface.php
@@ -17,6 +17,7 @@
 interface ParserInterface
 {
     public const KIND_OPT = 'option';
+
     public const KIND_ARG = 'argument';
 
     /**
@@ -282,5 +283,4 @@ public function unlock(): void;
      * @return bool
      */
     public function isLocked(): bool;
-
 }
diff --git a/src/Contract/ValidatorInterface.php b/src/Contract/ValidatorInterface.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Contract;
 

diff --git a/src/Contract/ValueInterface.php b/src/Contract/ValueInterface.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Contract;
 

diff --git a/src/Exception/FlagParseException.php b/src/Exception/FlagParseException.php
@@ -1,8 +1,14 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Exception;
 
-use Throwable;
 use Toolkit\PFlag\FlagsParser;
 
 /**

diff --git a/src/Flag/Option.php b/src/Flag/Option.php
@@ -9,7 +9,6 @@
 
 namespace Toolkit\PFlag\Flag;
 
-use Toolkit\Cli\Helper\FlagHelper;
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagType;
 use Toolkit\PFlag\FlagUtil;
@@ -200,5 +199,4 @@ public function toArray(): array
         $info['shorts']  = $this->shorts;
         return $info;
     }
-
 }
diff --git a/src/FlagUtil.php b/src/FlagUtil.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag;
 

diff --git a/src/FlagsParser.php b/src/FlagsParser.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag;
 
@@ -30,6 +37,7 @@ abstract class FlagsParser implements ParserInterface
     use RuleParserTrait;
 
     public const TRIM_CHARS    = "; \t\n\r\0\x0B";
+
     public const OPT_MAX_WIDTH = 16;
 
     public const RULE_SEP = ';';
@@ -49,6 +57,7 @@ abstract class FlagsParser implements ParserInterface
      *  - posix: `-abc`  will expand: `-a=bc`
      */
     public const SHORT_STYLE_GUN   = 'gnu';
+
     public const SHORT_STYLE_POSIX = 'posix';
 
     public const DEFINE_ITEM = [

diff --git a/src/Helper/ValueBinding.php b/src/Helper/ValueBinding.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Helper;
 
@@ -7,5 +14,4 @@
  */
 class ValueBinding
 {
-
 }
diff --git a/src/Helper/ValueCollector.php b/src/Helper/ValueCollector.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Helper;
 
@@ -23,6 +30,5 @@ public function new(): self
      */
     public function collect(FlagsParser $fs): void
     {
-
     }
 }
diff --git a/src/Validator/AbstractValidator.php b/src/Validator/AbstractValidator.php
@@ -1,4 +1,11 @@
 <?php declare(strict_types=1);
+/**
+ * This file is part of toolkit/pflag.
+ *
+ * @link     https://github.com/php-toolkit
+ * @author   https://github.com/inhere
+ * @license  MIT
+ */
 
 namespace Toolkit\PFlag\Validator;