update some for phar building

Author: inhere

phar.build.inc

@@ -14,14 +14,17 @@ $compiler
   ->setShebang(true)
   ->addExclude([
     'demo',
+    'example',
+    'runtime',
+    'node_modules',
     'test',
     'tmp',
   ])
   ->addFile([
     'LICENSE',
     'composer.json',
     'README.md',
-    'test/boot.php',
+    'test/bootstrap.php',
   ])
   ->setCliIndex('examples/app')
   // ->setWebIndex('web/index.php')
@@ -30,7 +33,7 @@ $compiler
 
 // Console 下的 Command Controller 命令类不去除注释，注释上是命令帮助信息
 $compiler->setStripFilter(static function ($file) {
-  /** @var \SplFileInfo $file */
+  /** @var SplFileInfo $file */
   $name = $file->getFilename();
 
   return false === strpos($name, 'Command.php') && false === strpos($name, 'Controller.php');

src/Application.php

@@ -14,7 +14,6 @@
 use Inhere\Console\IO\Output;
 use Inhere\Console\Util\Helper;
 use InvalidArgumentException;
-use ReflectionException;
 use RuntimeException;
 use SplFileInfo;
 use function class_exists;
@@ -285,7 +284,7 @@ public function dispatch(string $name, bool $detachedRun = false)
             }
 
             $commands = $this->router->getAllNames();
-            $this->output->error("The command '{$name}' is not exists!");
+            $this->output->error("The command '$name' is not exists!");
 
             // find similar command names by similar_text()
             if ($similar = Helper::findSimilar($name, $commands)) {
@@ -360,7 +359,6 @@ protected function runCommand(string $name, $handler, array $options)
      * @param bool  $detachedRun
      *
      * @return mixed
-     * @throws ReflectionException
      */
     protected function runAction(array $info,  array $options, bool $detachedRun = false)
     {

src/BuiltIn/PharController.php

@@ -72,10 +72,10 @@ protected function packConfigure(Input $input): void
      *                          default is current work-dir(default: <cyan>{workDir}</cyan>)
      *  -c, --config STRING     Use the custom config file for build phar(default: <cyan>./phar.build.inc</cyan>)
      *  -o, --output STRING     Setting the output file name(<cyan>{defaultPkgName}</cyan>)
-     *  --fast                  Fast build. only add modified files by <cyan>git status -s</cyan>
-     *  --refresh               Whether build vendor folder files on phar file exists(<cyan>False</cyan>)
-     *  --files  STRING         Only pack the list files to the exist phar, multi use ',' split
-     *  --no-progress           Disable output progress on the runtime
+     *      --fast              Fast build. only add modified files by <cyan>git status -s</cyan>
+     *      --refresh           Whether build vendor folder files on phar file exists(<cyan>False</cyan>)
+     *      --files  STRING     Only pack the list files to the exist phar, multi use ',' split
+     *      --no-progress       Disable output progress on the runtime
      *
      * @param Input  $input
      * @param Output $output
@@ -92,7 +92,7 @@ protected function packConfigure(Input $input): void
      * only update the input files:
      *   php -d phar.readonly=0 {binFile} phar:pack -o=mycli.phar --debug --files app/Command/ServeCommand.php
      */
-    public function packCommand($input, $output): int
+    public function packCommand(Input $input, Output $output): int
     {
         $startAt = microtime(true);
         $workDir = $input->getPwd();
@@ -169,7 +169,6 @@ protected function configCompiler(string $dir): PharCompiler
         $configFile = $this->input->getSameOpt(['c', 'config']) ?: $dir . '/phar.build.inc';
 
         if ($configFile && is_file($configFile)) {
-            /** @noinspection PhpIncludeInspection */
             require $configFile;
             return $compiler->in($dir);
         }

src/Component/PharCompiler.php

@@ -8,6 +8,7 @@
 use DateTimeZone;
 use Exception;
 use FilesystemIterator;
+use Generator;
 use Inhere\Console\Util\Helper;
 use InvalidArgumentException;
 use Iterator;
@@ -116,20 +117,29 @@ class PharCompiler
     private $suffixes = ['.php'];
 
     /**
-     * @var array Want to exclude directory/file name list
+     * Want to exclude directory/file name list
+     *
+     * ```php
      * [
      *  '/test/', // exclude all contains '/test/' path
      * ]
+     * ```
+     *
+     * @var array
      */
     private $excludes = [];
 
     /**
-     * @var array The directory paths, will collect files in there.
+     * The directory paths, will collect files in there.
+     *
+     * @var array
      */
     private $directories = [];
 
     /**
-     * @var Closure[] Some events. if you want to get some info on packing.
+     * Some events. if you want to get some info on packing.
+     *
+     * @var Closure[]
      */
     private $events = [];
 
@@ -178,6 +188,9 @@ class PharCompiler
      */
     private $versionFile = '';
 
+    /**
+     * @var string
+     */
     private $versionFileContent = '';
 
     // -------------------- internal properties --------------------
@@ -210,6 +223,22 @@ class PharCompiler
      */
     private $fileQueue;
 
+    /**
+     * @throws RuntimeException
+     */
+    private static function checkEnv(): void
+    {
+        if (!class_exists(Phar::class, false)) {
+            throw new RuntimeException("The 'phar' extension is required for build phar package");
+        }
+
+        if (ini_get('phar.readonly')) {
+            throw new RuntimeException(
+                "The 'phar.readonly' is 'On', build phar must setting it 'Off' or exec with 'php -d phar.readonly=0'"
+            );
+        }
+    }
+
     /**
      * @param string            $pharFile
      * @param string            $extractTo
@@ -220,7 +249,7 @@ class PharCompiler
      * @throws BadMethodCallException
      * @throws RuntimeException
      */
-    public static function unpack(string $pharFile, string $extractTo, $files = null, $overwrite = false): bool
+    public static function unpack(string $pharFile, string $extractTo, $files = null, bool $overwrite = false): bool
     {
         self::checkEnv();
 
@@ -229,22 +258,6 @@ public static function unpack(string $pharFile, string $extractTo, $files = null
         return $phar->extractTo($extractTo, $files, $overwrite);
     }
 
-    /**
-     * @throws RuntimeException
-     */
-    private static function checkEnv(): void
-    {
-        if (!class_exists(Phar::class, false)) {
-            throw new RuntimeException("The 'phar' extension is required for build phar package");
-        }
-
-        if (ini_get('phar.readonly')) {
-            throw new RuntimeException(
-                "The 'phar.readonly' is 'On', build phar must setting it 'Off' or exec with 'php -d phar.readonly=0'"
-            );
-        }
-    }
-
     /**
      * PharCompiler constructor.
      *
@@ -256,7 +269,7 @@ public function __construct(string $basePath)
     {
         self::checkEnv();
 
-        $this->basePath  = realpath($basePath);
+        $this->basePath  = File::realpath($basePath);
         $this->fileQueue = new SplQueue();
 
         if (!is_dir($this->basePath)) {
@@ -352,7 +365,7 @@ public function setExcludes(array $excludes): self
     }
 
     /**
-     * @param bool $value
+     * @param bool|string|int $value
      *
      * @return PharCompiler
      */
@@ -363,7 +376,7 @@ public function stripComments($value): self
     }
 
     /**
-     * @param bool $value
+     * @param bool|string|int $value
      *
      * @return PharCompiler
      */
@@ -578,9 +591,9 @@ protected function collectFileInfo(SplFileInfo $file): void
      *
      * @throws RuntimeException
      */
-    public function findChangedByGit()
+    public function findChangedByGit(): ?Generator
     {
-        // -u expand dir's files
+        // -u expand dir files
         [, $output,] = Sys::run('git status -s -u', $this->basePath);
 
         // 'D some.file'    deleted
@@ -608,10 +621,10 @@ public function findChangedByGit()
     /**
      * @param string $directory
      *
-     * @return Iterator|SplFileInfo[]
+     * @return Iterator
      * @throws InvalidArgumentException
      */
-    protected function findFiles(string $directory)
+    protected function findFiles(string $directory): Iterator
     {
         return Helper::directoryIterator(
             $directory,
@@ -711,19 +724,21 @@ private function createStub(): string
             $stub    = "$shebang\n$stub";
         }
 
-        if ($this->cliIndex && $this->webIndex) {
+        $cliIndex = $this->cliIndex;
+        $webIndex = $this->webIndex;
+        if ($cliIndex && $webIndex) {
             $stub .= <<<EOF
 // for command line            
 if (PHP_SAPI === 'cli') {
-    require 'phar://$pharName/{$this->cliIndex}';
+    require 'phar://$pharName/$cliIndex';
 } else {
-    require 'phar://$pharName/{$this->webIndex}';
+    require 'phar://$pharName/$webIndex';
 }
 EOF;
-        } elseif ($this->cliIndex) {
-            $stub .= "\nrequire 'phar://$pharName/{$this->cliIndex}';\n";
-        } elseif ($this->webIndex) {
-            $stub .= "\nrequire 'phar://$pharName/{$this->webIndex}';\n";
+        } elseif ($cliIndex) {
+            $stub .= "\nrequire 'phar://$pharName/$cliIndex';\n";
+        } elseif ($webIndex) {
+            $stub .= "\nrequire 'phar://$pharName/$webIndex';\n";
         } else {
             throw new RuntimeException("'cliIndex' and 'webIndex', please set at least one");
         }
@@ -989,11 +1004,13 @@ public function setVersionFile(string $versionFile): PharCompiler
     }
 
     /**
+     * @param bool $abbrev
+     *
      * @return string
      */
-    public function getLastCommit(): string
+    public function getLastCommit(bool $abbrev = true): string
     {
-        return $this->lastCommit;
+        return $abbrev ? substr($this->lastCommit, 0, 7) : $this->lastCommit;
     }
 
     /**