web64/laravel-cli-colors

Laravel包,用于生成带出色彩的CLI输出!

v0.20 2020-09-27 17:36 UTC

This package is auto-updated.

Last update: 2024-09-28 02:36:38 UTC


README

Laravel CLI Colors是一个简单的包,基于jakub-onderka/php-console-color库,使得输出各种颜色和样式的文本变得容易。

Laravel本身已经为Command类提供了一些内置样式,但我也经常在其他类中输出调试信息,并希望有更多的灵活性来设置输出样式,因此我创建了此包。

请注意,可用的颜色和样式功能将取决于您的操作系统和控制台设置。

安装

composer require web64/laravel-cli-colors

要发布colors.php配置文件,请运行

php artisan vendor:publish --provider="Web64\Colors\ColorsServiceProvider" --tag="config"

运行此命令以查看如何使用Laravel CLI Colors的示例。

php artisan colors:test 

快速入门

use Web64\Colors\Facades\Colors;

Colors::red('Red Text');

默认颜色

文本颜色

default, black, red, green, yellow, blue, magenta, cyan, light_gray, dark_gray, light_red, light_green, light_yellow, light_blue, light_magenta, light_cyan, white

背景颜色

bg_default, bg_black, bg_red, bg_green, bg_yellow, bg_blue, bg_magenta, bg_cyan, bg_white, bg_light_gray, bg_dark_gray, bg_light_red, bg_light_green, bg_light_yellow, bg_light_blue, bg_light_magenta, bg_light_cyan

Colors::light_blue('Light blue text');
Colors::bg_light_blue('Light blue background');

自定义样式

在colors.php配置文件中,您可以定义自己的自定义样式。数组的键将是Colors外观类上的静态方法名称,值是应用样式数组。

// config.php
return [
    'myStyle' => ['bold','blue', 'bg_white'],
    ...
];
Colors::myStyle('Bold blue text with white background');

预定义样式

colors.php配置文件已经有一份预定义样式的列表。您可以自由修改、删除或添加此配置文件中的样式。

// Laravel-style output
Colors::info('Green text');
Colors::question('Black text on light blue background');

// Model changed styles
Colors::created("Green bg to indicate model was created");
Colors::updated("Yellow bg to indicate model was updated");
Colors::deleted("Red bg to indicate model was deleted");

查看和验证自定义样式

运行此命令以查看自定义样式的外观以及是否存在任何错误。

php artisan colors:test --config

内联样式

要快速测试样式,您可以添加多个内联样式并用双下划线(__)分隔。

Colors::bold__underline__reverse__blue__bg_light_gray("Text..");

当您找到一个喜欢的样式时,可以将它们添加到colors.php配置中。

格式化

您可以使用粗体、下划线、斜体和反相来格式化文本。

Colors::bold()->red('Bold red text');
Colors::underline()->blue('Underlined blue text');
Colors::italic()->green('Italic green text');
Colors::reverse()->default('Reversed default text and background color');

添加nobr()可以防止添加换行符,因此您可以在同一行更改样式。

Colors::nobr()->red('U');
Colors::nobr()->white('S');
Colors::blue('A');

快捷键

您可以使用'light_'和'dark_'的前缀来代替'light_'和'dark_'。

对于粗体、下划线和反相,您可以使用快捷键:'b'、'u'和'rev'

Colors::b__u__dgray__bg_lcyan('Text');
// Same as 
Colors::bold__underline__dark_gray__bg_light_cyan('Text');

助手

如果您不想使用外观,则有一个助手函数可用。

第一个参数是包含样式的字符串或数组,第二个参数是输出的文本。

colors('red', 'Hello World!');
colors('b__u__red', 'Hello World!');
colors(['bold', 'underline', 'red'], 'Hello World!');

有趣的功能

使用rainbow()函数为每个字符显示随机颜色。

// Random text colors:
Colors::rainbow('Text');

// Random background colors:
Colors::reverse()->rainbow('Text');

示例

Default Config Text Colors Background Colors

贡献

如果您有任何改进此包的想法,请告诉我!

在此留下问题或在Twitter上联系我 @OlavHjertaker