breaking: migreate to php 8.0+ syntax

Author: inhere

.github/workflows/php.yml

@@ -15,15 +15,15 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.3, 7.4, 8.0]
+        php: [8.0, 8.1]
         os: [ubuntu-latest, macOS-latest] # windows-latest,
-        include:
-          - os: 'ubuntu-latest'
-            php: '7.2'
-            phpunit: '8.5.13'
-          - os: 'ubuntu-latest'
-            php: '7.1'
-            phpunit: '7.5.20'
+#        include:
+#          - os: 'ubuntu-latest'
+#            php: '7.2'
+#            phpunit: '8.5.13'
+#          - os: 'ubuntu-latest'
+#            php: '7.1'
+#            phpunit: '7.5.20'
 
     steps:
       - name: Checkout

.github/workflows/release.yml

@@ -42,21 +42,20 @@ jobs:
           echo "release tag: ${tag1}"
           composer install --no-progress
 
-      # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
-      # Docs: https://getcomposer.org/doc/articles/scripts.md
-
-      #      - name: Build phar and send to github assets
-      #        run: |
-      #          echo $RELEASE_TAG
-      #          echo $RELEASE_NAME
-      #          php -d phar.readonly=0 bin/kite phar:pack -o kite-${RELEASE_TAG}.phar --no-progress
-      #          php kite-${RELEASE_TAG}.phar -V
-
-      # https://github.com/actions/create-release
-      - uses: meeDamian/[email protected]
+      - name: Generate changelog file
+        id: 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
+
+      # https://github.com/softprops/action-gh-release
+      - name: Create release and upload assets
+        uses: softprops/action-gh-release@v1
         with:
-          gzip: false
-          token: ${{ secrets.GITHUB_TOKEN }}
-          tag: ${{ env.RELEASE_TAG }}
           name: ${{ env.RELEASE_TAG }}
-#          files: kite-${{ env.RELEASE_TAG }}.phar
+          tag_name: ${{ env.RELEASE_TAG }}
+          body_path: changelog.md
+          # files: kite-${{ env.RELEASE_TAG }}.phar
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -81,7 +81,7 @@ Terminal::clearScreen();
 > This is inspire `jakub-onderka/php-console-highlighter`
 
 ```php
-use Toolkit\Cli\Highlighter;
+use Toolkit\Cli\Util\Highlighter;
 
 // this is an comment
 $rendered = Highlighter::create()->highlight(file_get_contents(__FILE__));

composer.json

@@ -19,10 +19,9 @@
     }
   ],
   "require": {
-    "php": ">7.1.0"
+    "php": ">8.0.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5",
     "ext-posix": "*",
     "ext-readline": "*"
   },

example/readline/cb_handler.php

@@ -18,7 +18,7 @@ function handler_read_demo(int $count, string $prompt = null): string
 
     // 初始化一个 readline 回调接口，然后终端输出提示信息并立即返回
     // TIP: 第二次调用这个函数不需要移除上一个回调接口，这个函数将自动覆盖旧的接口
-    readline_callback_handler_install($prompt ?? " \e[D", function ($input) use (&$prev) {
+    readline_callback_handler_install($prompt ?? " \e[D", static function ($input) use (&$prev) {
         echo "Input is: $input\n";
         $prev .= $input . '|';
     });

example/term_move.php

@@ -2,7 +2,7 @@
 
 class TermMove {
 
-    const KEYS = [
+    public const KEYS = [
         10  => 'enter',
         127 => 'backspace',
         65  => 'up',
@@ -50,7 +50,7 @@ public function char() : string
             return $c;
         }
 
-        readline_callback_handler_install('', function() {});
+        readline_callback_handler_install('', static function() {});
         // $c = $this->read(1);
         // $c = fread(STDIN, 4);
         $c = stream_get_contents(STDIN, 4);

src/App.php

@@ -37,11 +37,12 @@
  * Class App - A lite CLI Application
  *
  * @package Inhere\Console
+ * @deprecated please use package: toolkit/pflag
  */
 class App
 {
-    /** @var self */
-    public static $global;
+    /** @var self|null */
+    public static ?self $global = null;
 
     private const COMMAND_CONFIG = [
         'desc'  => '',
@@ -50,12 +51,12 @@ class App
     ];
 
     /** @var string Current dir */
-    private $pwd;
+    private string $pwd;
 
     /**
      * @var array
      */
-    protected $params = [
+    protected array $params = [
         'name'    => 'My application',
         'desc'    => 'My command line application',
         'version' => '0.2.1'
@@ -64,37 +65,37 @@ class App
     /**
      * @var array Parsed from `arg0 name=val var2=val2`
      */
-    private $args;
+    private mixed $args;
 
     /**
      * @var array Parsed from `--name=val --var2=val2 -d`
      */
-    private $opts;
+    private mixed $opts;
 
     /**
      * @var string
      */
-    private $script;
+    private mixed $script;
 
     /**
      * @var string
      */
-    private $command = '';
+    private string $command = '';
 
     /**
      * @var array User add commands
      */
-    private $commands = [];
+    private array $commands = [];
 
     /**
      * @var array Command messages for the commands
      */
-    private $messages = [];
+    private array $messages = [];
 
     /**
      * @var int
      */
-    private $keyWidth = 12;
+    private int $keyWidth = 12;
 
     /**
      * @return static
@@ -233,7 +234,7 @@ public function stop(int $code = 0): void
      * @return mixed
      * @throws InvalidArgumentException
      */
-    public function runHandler(string $command, $handler)
+    public function runHandler(string $command, mixed $handler): mixed
     {
         if (is_string($handler)) {
             // function name
@@ -315,19 +316,19 @@ public function addByConfig(callable $handler, array $config): void
     /**
      * @param string            $command
      * @param callable          $handler
-     * @param null|array|string $config
+     * @param array|string|null $config
      */
-    public function add(string $command, callable $handler, $config = null): void
+    public function add(string $command, callable $handler, array|string $config = null): void
     {
         $this->addCommand($command, $handler, $config);
     }
 
     /**
      * @param string            $command
      * @param callable          $handler
-     * @param null|array|string $config
+     * @param array|string|null $config
      */
-    public function addCommand(string $command, callable $handler, $config = null): void
+    public function addCommand(string $command, callable $handler, array|string $config = null): void
     {
         if (!$command) {
             throw new InvalidArgumentException('Invalid arguments for add command');
@@ -463,45 +464,45 @@ public function displayCommandHelp(string $name): void
     }
 
     /**
-     * @param string|int $name
-     * @param mixed      $default
+     * @param int|string $name
+     * @param mixed|null $default
      *
      * @return mixed|null
      */
-    public function getArg($name, $default = null)
+    public function getArg(int|string $name, mixed $default = null): mixed
     {
         return $this->args[$name] ?? $default;
     }
 
     /**
-     * @param string|int $name
+     * @param int|string $name
      * @param int        $default
      *
      * @return int
      */
-    public function getIntArg($name, int $default = 0): int
+    public function getIntArg(int|string $name, int $default = 0): int
     {
         return (int)$this->getArg($name, $default);
     }
 
     /**
-     * @param string|int $name
+     * @param int|string $name
      * @param string     $default
      *
      * @return string
      */
-    public function getStrArg($name, string $default = ''): string
+    public function getStrArg(int|string $name, string $default = ''): string
     {
         return (string)$this->getArg($name, $default);
     }
 
     /**
      * @param string $name
-     * @param mixed  $default
+     * @param mixed|null $default
      *
      * @return mixed|null
      */
-    public function getOpt(string $name, $default = null)
+    public function getOpt(string $name, mixed $default = null): mixed
     {
         return $this->opts[$name] ?? $default;
     }
@@ -688,7 +689,7 @@ public function setMetas(array $params): void
      *
      * @return mixed|string|null
      */
-    public function getParam(string $key, $default = null)
+    public function getParam(string $key, $default = null): mixed
     {
         return $this->params[$key] ?? $default;
     }
@@ -697,7 +698,7 @@ public function getParam(string $key, $default = null)
      * @param string $key
      * @param mixed  $val
      */
-    public function setParam(string $key, $val): void
+    public function setParam(string $key, mixed $val): void
     {
         $this->params[$key] = $val;
     }

src/Cli.php

@@ -24,7 +24,7 @@
 use function is_numeric;
 use function json_encode;
 use function preg_replace;
-use function strpos;
+use function stream_isatty;
 use function strtoupper;
 use function trim;
 use const DIRECTORY_SEPARATOR;
@@ -87,10 +87,10 @@ public static function __callStatic(string $method, array $args)
     /**
      * Print colored message to STDOUT
      *
-     * @param string|array      $message
-     * @param string|array|null $style
+     * @param array|string $message
+     * @param array|string $style
      */
-    public static function colored($message, $style = 'info'): void
+    public static function colored(array|string $message, array|string $style = 'info'): void
     {
         $str = is_array($message) ? implode(' ', $message) : (string)$message;
 
@@ -110,12 +110,12 @@ public static function style(): Style
     }
 
     /**
-     * @param string                $text
-     * @param string|int|array|null $style
+     * @param string $text
+     * @param array|string|null $style
      *
      * @return string
      */
-    public static function color(string $text, $style = null): string
+    public static function color(string $text, array|string $style = null): string
     {
         return Color::render($text, $style);
     }
@@ -152,7 +152,7 @@ public static function clog(string $msg, array $data = [], string $type = 'info'
         $userOpts = [];
 
         foreach ($opts as $n => $v) {
-            if (is_numeric($n) || strpos($n, '_') === 0) {
+            if (is_numeric($n) || str_starts_with($n, '_')) {
                 $userOpts[] = "[$v]";
             } else {
                 $userOpts[] = "[$n:$v]";
@@ -225,7 +225,7 @@ public static function isSupportColor(): bool
      */
     public static function isSupport256Color(): bool
     {
-        return DIRECTORY_SEPARATOR === '/' && strpos(getenv('TERM'), '256color') !== false;
+        return DIRECTORY_SEPARATOR === '/' && str_contains(getenv('TERM'), '256color');
     }
 
     /**
@@ -247,11 +247,11 @@ public static function isAnsiSupport(): bool
      *
      * @return boolean
      */
-    public static function isInteractive($fileDescriptor): bool
+    public static function isInteractive(mixed $fileDescriptor): bool
     {
         // PHP 7 >= 7.2.0
         if (function_exists('stream_isatty')) {
-            return \stream_isatty($fileDescriptor);
+            return stream_isatty($fileDescriptor);
         }
 
         return function_exists('posix_isatty') && @posix_isatty($fileDescriptor);