sunnyflail/color-cli

A simple abstraction over colorful cli messages!

1.0.1 2021-06-04 02:00 UTC

This package is auto-updated.

Last update: 2024-04-20 16:14:08 UTC


README

A simple abstraction over php cli text effects

How to use

Just wrap the alias of wanted effect with XML style brackets (<>) and apply it with Console::apply. Aliases are case insensitive

eg.

use SunnyFlail\Console\Console;
$string = "<r>This will be printed in red<_> while this will be in default color";
echo Console::apply($string);

Effects and their aliases

Text transformations

Alias Effect Code
_ Reset to default "\e[0m"
H_ Start Bold Text "\e[1m"
_H End Bold Text "\e[21m"
D_ Start Dimmed Text "\e[2m"
_D End Dimmed Text "\e[22m"
U_ Start Underscored Text "\e[4m"
_U End Underscored Text "\e[24m"
B_ Start Blinking Text "\e[5m"
_B End Blinking Text "\e[25m"
R_ Start Reversed Text "\e[7m"
_R End Reversed Text "\e[27m"
I_ Start Invisible Text "\e[8m"
_I End Invisible Text "\e[28m"

Foreground Colors

Alias Effect Code
BC BLACK "\e[0;30m"
D_GY GRAY "\e[1;30m"
R RED "\e[0;31m"
L_R LIGHT RED "\e[1;31m"
GR GREEN "\e[0;32m"
L_GR LIGHT GREEN "\e[1;32m"
BR BROWN "\e[0;33m"
Y YELLOW "\e[0;33m"
BL BLUE "\e[0;34m"
L_BL LIGHT BLUE "\e[1;34m"
M MAGENTA "\e[0;35m"
P PURPLE "\e[2;35m"
L_M LIGHT MAGENTA "\e[1;35m"
L_P LIGHT PURPLE "\e[1;35m"
C CYAN "\e[0;36m"
L_C LIGHT CYAN "\e[1;36m"
L_GY LIGHT GRAY "\e[2;37m"
BD_W WHITE "\e[1;38m"
W WHITE "\e[0;38m"
DEF DEFAULT "\e[39m"
GY GRAY "\e[0;90m"
L_Y LIGHT YELLOW "\e[1;93m"
L_R_A ALT LIGHT RED "\e[91m"
L_GR_A ALT LIGHT GREEN "\e[92m"
L_Y_A ALT LIGHT YELLOW "\e[93m"
L_BL_A ALT LIGHT BLUE "\e[94m"
L_M_A ALT LIGHT MAGENTA "\e[95m"
L_C_A ALT LIGHT CYAN "\e[96m"
L_W_A ALT WHITE "\e[97m"

Background Colors

Alias Effect Code
B_BC BLACK BACKGROUND "\e[40m"
B_R RED BACKGROUND "\e[41m"
B_GR GREEN BACKGROUND "\e[42m"
B_Y YELLOW BACKGROUND "\e[43m"
B_BL BLUE BACKGROUND "\e[44m"
B_M MAGENTA BACKGROUND "\e[45m"
B_C CYAN BACKGROUND "\e[46m"
B_L_GY LIGHT GRAY BACKGROUND "\e[47m"
B_DEF DEFAULT BACKGROUND "\e[49m"
B_D_GY GRAY BACKGROUND "\e[100m"
B_L_R LIGHT RED BACKGROUND "\e[101m"
B_L_GR LIGHT GREEN BACKGROUND "\e[102m"
B_L_Y LIGHT YELLOW BACKGROUND "\e[103m"
B_L_BL LIGHT BLUE BACKGROUND "\e[104m"
B_L_M LIGHT MAGENTA BACKGROUND "\e[105m"
B_L_C LIGHT CYAN BACKGROUND "\e[106m"
B_W WHITE BACKGROUND "\e[107m"