lfischer/cli-helper

一个帮助您输出内容到命令行界面(CLI)的小组件

1.3 2021-05-19 13:34 UTC

This package is auto-updated.

Last update: 2024-09-19 21:01:10 UTC


README

一个帮助您在命令行界面(CLI)上输出内容的小组件。我在termsys.demon.co.uk/vtansi.htm上找到了很多信息。本项目遵循语义版本控制

使用方法

前景色

可以通过ForegroundColorFG(简称)类来更改前景色(即文字颜色)。您可以使用类常量或静态方法设置不同的颜色。甚至还有一个方法可以使用完整的rgb光谱 :)

use lfischer\cli\ForegroundColor;
use lfischer\cli\Color\FG;

echo ForegroundColor::BLUE . 'Blue foreground!' . ForegroundColor::RESET . PHP_EOL;
echo ForegroundColor::blue('Blue foreground!') . PHP_EOL;
echo FG::BLUE . 'Blue foreground!' . FG::NONE . PHP_EOL;
echo FG::blue('Blue foreground!') . PHP_EOL;
echo FG::rgb(0, 0, 255) . 'Blue foreground!' . FG::RESET . PHP_EOL;

背景色

可以使用BackgroundColorBG(简称)类以相同的功能用于背景

use lfischer\cli\BackgroundColor;
use lfischer\cli\Color\BG;

echo BackgroundColor::BLUE . 'Blue foreground!' . BackgroundColor::RESET . PHP_EOL;
echo BackgroundColor::blue('Blue foreground!') . PHP_EOL;
echo BG::BLUE . 'Blue foreground!' . BG::NONE . PHP_EOL;
echo BG::blue('Blue foreground!') . PHP_EOL;
echo BG::rgb(0, 0, 255) . 'Blue foreground!' . BG::RESET . PHP_EOL;

输出样式

您还可以使用Style类定义输出的样式。

use lfischer\cli\Style;

echo Style::bold('Bold') . PHP_EOL;
echo Style::underline('Underline') . PHP_EOL;
echo Style::nounderline('No underline') . PHP_EOL;
echo Style::negative('Negative') . PHP_EOL;
echo Style::positive('Positive') . PHP_EOL;

交互式提问

您可以通过使用Input类从用户那里请求输入,使CLI更加交互式:$answer = Input::ask('<问题>', '<可选默认值>');

use lfischer\cli\Input;

$name = Input::ask('What is your name?');
$result = Input::ask('Do you like PHP?', 'yes');

静态代码分析和代码风格

代码正在使用vimeo/psalm的帮助进行静态分析。PSR2代码风格将使用friendsofphp/php-cs-fixer进行检查/应用。

单元测试(得益于PHP Unit)

从1.3.0版本开始,对颜色和样式的基本用法有单元测试。