Do some code quality check and fix #126

src/SPC/command/BaseCommand.php

@@ -17,16 +17,8 @@ abstract class BaseCommand extends Command
 {
     protected bool $no_motd = false;
 
-    /**
-     * 输入
-     */
     protected InputInterface $input;
 
-    /**
-     * 输出
-     *
-     * 一般来说同样会是 ConsoleOutputInterface
-     */
     protected OutputInterface $output;
 
     public function __construct(string $name = null)
@@ -36,12 +28,12 @@ abstract class BaseCommand extends Command
         $this->addOption('no-motd', null, null, 'Disable motd');
     }
 
-    public function initialize(InputInterface $input, OutputInterface $output)
+    public function initialize(InputInterface $input, OutputInterface $output): void
     {
         if ($input->getOption('no-motd')) {
             $this->no_motd = true;
         }
-        // 注册全局错误处理器
+
         set_error_handler(static function ($error_no, $error_msg, $error_file, $error_line) {
             $tips = [
                 E_WARNING => ['PHP Warning: ', 'warning'],
@@ -77,6 +69,9 @@ abstract class BaseCommand extends Command
         }
     }
 
+    /**
+     * @throws WrongUsageException
+     */
     abstract public function handle(): int;
 
     protected function execute(InputInterface $input, OutputInterface $output): int
@@ -93,7 +88,6 @@ abstract class BaseCommand extends Command
                 }
                 return static::FAILURE;
             } catch (\Throwable $e) {
-                // 不开 debug 模式就不要再显示复杂的调试栈信息了
                 if ($this->getOption('debug')) {
                     ExceptionHandler::getInstance()->handle($e);
                 } else {
@@ -118,11 +112,6 @@ abstract class BaseCommand extends Command
         return $this->input->getArgument($name);
     }
 
-    /**
-     * 是否应该执行
-     *
-     * @return bool 返回 true 以继续执行，返回 false 以中断执行
-     */
     protected function shouldExecute(): bool
     {
         return true;

src/SPC/command/BuildCliCommand.php

@@ -18,7 +18,7 @@ use ZM\Logger\ConsoleColor;
 #[AsCommand('build', 'build CLI binary')]
 class BuildCliCommand extends BuildCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('extensions', InputArgument::REQUIRED, 'The extensions will be compiled, comma separated');
         $this->addOption('with-libs', null, InputOption::VALUE_REQUIRED, 'add additional libraries, comma separated', '');
@@ -29,17 +29,16 @@ class BuildCliCommand extends BuildCommand
         $this->addOption('no-strip', null, null, 'build without strip, in order to debug and load external extensions');
         $this->addOption('enable-zts', null, null, 'enable ZTS support');
         $this->addOption('with-hardcoded-ini', 'I', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Patch PHP source code, inject hardcoded INI');
+        $this->addOption('with-micro-fake-cli', null, null, 'Enable phpmicro fake cli');
     }
 
     public function handle(): int
     {
-        // 从参数中获取要编译的 libraries，并转换为数组
+        // transform string to array
         $libraries = array_map('trim', array_filter(explode(',', $this->getOption('with-libs'))));
-        // 从参数中获取要编译的 extensions，并转换为数组
+        // transform string to array
         $extensions = array_map('trim', array_filter(explode(',', $this->getArgument('extensions'))));
 
-        define('BUILD_ALL_STATIC', true);
-
         $rule = BUILD_TARGET_NONE;
         $rule = $rule | ($this->getOption('build-cli') ? BUILD_TARGET_CLI : BUILD_TARGET_NONE);
         $rule = $rule | ($this->getOption('build-micro') ? BUILD_TARGET_MICRO : BUILD_TARGET_NONE);
@@ -54,9 +53,9 @@ class BuildCliCommand extends BuildCommand
             return static::FAILURE;
         }
         try {
-            // 构建对象
+            // create builder
             $builder = BuilderProvider::makeBuilderByInput($this->input);
-            // 根据提供的扩展列表获取依赖库列表并编译
+            // calculate dependencies
             [$extensions, $libraries, $not_included] = DependencyUtil::getExtLibsByDeps($extensions, $libraries);
             /* @phpstan-ignore-next-line */
             logger()->info('Build target: ' . ConsoleColor::yellow($builder->getBuildTypeName($rule)));
@@ -68,12 +67,11 @@ class BuildCliCommand extends BuildCommand
                 logger()->warning('some extensions will be enabled due to dependencies: ' . implode(',', $not_included));
             }
             sleep(2);
-            // 编译和检查库是否完整
+            // compile libraries
             $builder->buildLibs($libraries);
-            // 执行扩展检测
+            // check extensions
             $builder->proveExts($extensions);
-            // strip
-            $builder->setStrip(!$this->getOption('no-strip'));
+
             // Process -I option
             $custom_ini = [];
             foreach ($this->input->getOption('with-hardcoded-ini') as $value) {
@@ -84,11 +82,15 @@ class BuildCliCommand extends BuildCommand
             if (!empty($custom_ini)) {
                 SourcePatcher::patchHardcodedINI($custom_ini);
             }
-            // 构建
-            $builder->buildPHP($rule, $this->getOption('bloat'));
-            // 统计时间
+
+            // start to build
+            $builder->buildPHP($rule);
+
+            // compile stopwatch :P
             $time = round(microtime(true) - START_TIME, 3);
             logger()->info('Build complete, used ' . $time . ' s !');
+
+            // ---------- When using bin/spc-alpine-docker, the build root path is different from the host system ----------
             $build_root_path = BUILD_ROOT_PATH;
             $cwd = getcwd();
             $fixed = '';
@@ -106,15 +108,17 @@ class BuildCliCommand extends BuildCommand
             if (($rule & BUILD_TARGET_FPM) === BUILD_TARGET_FPM) {
                 logger()->info('Static php-fpm binary path' . $fixed . ': ' . $build_root_path . '/bin/php-fpm');
             }
-            // 导出相关元数据
+
+            // export metadata
             file_put_contents(BUILD_ROOT_PATH . '/build-extensions.json', json_encode($extensions, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
             file_put_contents(BUILD_ROOT_PATH . '/build-libraries.json', json_encode($libraries, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
-            // 导出 LICENSE
+            // export licenses
             $dumper = new LicenseDumper();
             $dumper->addExts($extensions)->addLibs($libraries)->addSources(['php-src'])->dump(BUILD_ROOT_PATH . '/license');
             logger()->info('License path' . $fixed . ': ' . $build_root_path . '/license/');
             return static::SUCCESS;
         } catch (WrongUsageException $e) {
+            // WrongUsageException is not an exception, it's a user error, so we just print the error message
             logger()->critical($e->getMessage());
             return static::FAILURE;
         } catch (\Throwable $e) {

src/SPC/command/BuildCommand.php

@@ -12,7 +12,6 @@ abstract class BuildCommand extends BaseCommand
     {
         parent::__construct($name);
 
-        // 根据运行的操作系统分配允许不同的命令行参数，Windows 需要额外的 VS 和 SDK等，*nix 需要提供架构
         switch (PHP_OS_FAMILY) {
             case 'Windows':
                 $this->addOption('with-sdk-binary-dir', null, InputOption::VALUE_REQUIRED, 'path to binary sdk');
@@ -29,9 +28,7 @@ abstract class BuildCommand extends BaseCommand
                 break;
         }
 
-        // 是否在编译 make 前清除旧的文件
         $this->addOption('with-clean', null, null, 'fresh build, `make clean` before `make`');
-        // 是否采用强制链接，让链接器强制加载静态库文件
         $this->addOption('bloat', null, null, 'add all libraries into binary');
     }
 }

src/SPC/command/BuildLibsCommand.php

@@ -15,14 +15,14 @@ use Symfony\Component\Console\Output\OutputInterface;
 #[AsCommand('build:libs', 'Build dependencies')]
 class BuildLibsCommand extends BuildCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('libraries', InputArgument::REQUIRED, 'The libraries will be compiled, comma separated');
         $this->addOption('clean', null, null, 'Clean old download cache and source before fetch');
         $this->addOption('all', 'A', null, 'Build all libs that static-php-cli needed');
     }
 
-    public function initialize(InputInterface $input, OutputInterface $output)
+    public function initialize(InputInterface $input, OutputInterface $output): void
     {
         // --all 等于 ""
         if ($input->getOption('all')) {

src/SPC/command/DeployCommand.php

@@ -16,7 +16,7 @@ use function Laravel\Prompts\text;
 #[AsCommand('deploy', 'Deploy static-php-cli self to an .phar application')]
 class DeployCommand extends BaseCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('target', InputArgument::OPTIONAL, 'The file or directory to pack.');
         $this->addOption('auto-phar-fix', null, InputOption::VALUE_NONE, 'Automatically fix ini option.');
@@ -25,6 +25,9 @@ class DeployCommand extends BaseCommand
         $this->addOption('with-dev', 'd', InputOption::VALUE_NONE, 'Automatically use dev composer dependencies');
     }
 
+    /**
+     * @throws \PharException
+     */
     public function handle(): int
     {
         $composer = require ROOT_DIR . '/vendor/composer/installed.php';
@@ -149,9 +152,9 @@ class DeployCommand extends BaseCommand
         return static::SUCCESS;
     }
 
-    private function progress(int $max = 0): ProgressBar
+    private function progress(): ProgressBar
     {
-        $progress = new ProgressBar($this->output, $max);
+        $progress = new ProgressBar($this->output, 0);
         $progress->setBarCharacter('<fg=green>⚬</>');
         $progress->setEmptyBarCharacter('<fg=red>⚬</>');
         $progress->setProgressCharacter('<fg=green>➤</>');

src/SPC/command/DoctorCommand.php

@@ -10,7 +10,7 @@ use Symfony\Component\Console\Attribute\AsCommand;
 #[AsCommand('doctor', 'Diagnose whether the current environment can compile normally')]
 class DoctorCommand extends BaseCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addOption('auto-fix', null, null, 'Automatically fix failed items (if possible)');
     }

src/SPC/command/DownloadCommand.php

@@ -23,7 +23,7 @@ class DownloadCommand extends BaseCommand
 
     protected string $php_major_ver;
 
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('sources', InputArgument::REQUIRED, 'The sources will be compiled, comma separated');
         $this->addOption('shallow-clone', null, null, 'Clone shallow');
@@ -35,7 +35,7 @@ class DownloadCommand extends BaseCommand
         $this->addOption('from-zip', 'Z', InputOption::VALUE_REQUIRED, 'Fetch from zip archive');
     }
 
-    public function initialize(InputInterface $input, OutputInterface $output)
+    public function initialize(InputInterface $input, OutputInterface $output): void
     {
         // --all 等于 "" ""，也就是所有东西都要下载
         if ($input->getOption('all') || $input->getOption('clean') || $input->getOption('from-zip')) {

src/SPC/command/DumpLicenseCommand.php

@@ -18,7 +18,7 @@ use Symfony\Component\Console\Input\InputOption;
 #[AsCommand('dump-license', 'Dump licenses for required libraries')]
 class DumpLicenseCommand extends BaseCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addOption('by-extensions', null, InputOption::VALUE_REQUIRED, 'Dump by extensions and related libraries', null);
         $this->addOption('without-php', null, InputOption::VALUE_NONE, 'Dump without php-src');
@@ -39,7 +39,7 @@ class DumpLicenseCommand extends BaseCommand
             // 从参数中获取要编译的 extensions，并转换为数组
             $extensions = array_map('trim', array_filter(explode(',', $this->getOption('by-extensions'))));
             // 根据提供的扩展列表获取依赖库列表并编译
-            [$extensions, $libraries, $not_included] = DependencyUtil::getExtLibsByDeps($extensions);
+            [$extensions, $libraries] = DependencyUtil::getExtLibsByDeps($extensions);
             $dumper->addExts($extensions);
             $dumper->addLibs($libraries);
             if (!$this->getOption('without-php')) {

src/SPC/command/ExtractCommand.php

@@ -5,6 +5,9 @@ declare(strict_types=1);
 namespace SPC\command;
 
 use SPC\builder\traits\UnixSystemUtilTrait;
+use SPC\exception\FileSystemException;
+use SPC\exception\RuntimeException;
+use SPC\exception\WrongUsageException;
 use SPC\store\SourceExtractor;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Input\InputArgument;
@@ -14,13 +17,16 @@ class ExtractCommand extends BaseCommand
 {
     use UnixSystemUtilTrait;
 
-    protected string $php_major_ver;
-
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('sources', InputArgument::REQUIRED, 'The sources will be compiled, comma separated');
     }
 
+    /**
+     * @throws WrongUsageException
+     * @throws FileSystemException
+     * @throws RuntimeException
+     */
     public function handle(): int
     {
         $sources = array_map('trim', array_filter(explode(',', $this->getArgument('sources'))));

src/SPC/command/MicroCombineCommand.php

@@ -12,7 +12,7 @@ use Symfony\Component\Console\Input\InputOption;
 #[AsCommand('micro:combine', 'Combine micro.sfx and php code together')]
 class MicroCombineCommand extends BaseCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('file', InputArgument::REQUIRED, 'The php or phar file to be combined');
         $this->addOption('with-micro', 'M', InputOption::VALUE_REQUIRED, 'Customize your micro.sfx file');

src/SPC/command/dev/AllExtCommand.php

@@ -5,17 +5,21 @@ declare(strict_types=1);
 namespace SPC\command\dev;
 
 use SPC\command\BaseCommand;
+use SPC\exception\FileSystemException;
 use SPC\store\Config;
 use Symfony\Component\Console\Attribute\AsCommand;
 
 #[AsCommand('dev:ext-all', 'Dev command', ['list-ext'])]
 class AllExtCommand extends BaseCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addOption('line', 'l', null, 'Show with separate lines');
     }
 
+    /**
+     * @throws FileSystemException
+     */
     public function handle(): int
     {
         $this->output->writeln(implode($this->input->getOption('line') ? PHP_EOL : ',', array_keys(Config::getExts())));

src/SPC/command/dev/ExtInfoCommand.php

@@ -5,6 +5,9 @@ declare(strict_types=1);
 namespace SPC\command\dev;
 
 use SPC\command\BaseCommand;
+use SPC\exception\FileSystemException;
+use SPC\exception\RuntimeException;
+use SPC\exception\WrongUsageException;
 use SPC\store\Config;
 use SPC\util\DependencyUtil;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -13,11 +16,16 @@ use Symfony\Component\Console\Input\InputArgument;
 #[AsCommand('dev:ext-info', 'Dev command')]
 class ExtInfoCommand extends BaseCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('extensions', InputArgument::REQUIRED, 'The extension name you need to get info');
     }
 
+    /**
+     * @throws WrongUsageException
+     * @throws FileSystemException
+     * @throws RuntimeException
+     */
     public function handle(): int
     {
         $extensions = array_map('trim', array_filter(explode(',', $this->getArgument('extensions'))));

src/SPC/command/dev/PhpVerCommand.php

@@ -12,7 +12,7 @@ use Symfony\Component\Console\Output\OutputInterface;
 #[AsCommand('dev:php-ver', 'Dev command')]
 class PhpVerCommand extends BaseCommand
 {
-    public function initialize(InputInterface $input, OutputInterface $output)
+    public function initialize(InputInterface $input, OutputInterface $output): void
     {
         $this->no_motd = true;
         parent::initialize($input, $output);

src/SPC/command/dev/SortConfigCommand.php

@@ -18,7 +18,7 @@ use Symfony\Component\Console\Input\InputArgument;
 #[AsCommand('dev:sort-config', 'After config edited, sort it by alphabet', ['sort-config'])]
 class SortConfigCommand extends BaseCommand
 {
-    public function configure()
+    public function configure(): void
     {
         $this->addArgument('config-name', InputArgument::REQUIRED, 'Your config to be sorted, you can sort "lib", "source" and "ext".');
     }