colorize (original) (raw)

8.15

Colorize the output text of your console as you wish, source code.
NOTE: this is a exported version of ruby gem colorize.

1 Procedure Reference🔗ℹ

Colorize str with color1 as it’s foreground color, color2 as it’s background color, and style as the it’s style.

show a list of value for the colorize’s possible arguments.

check if #code{str} is colorized or not.

2 Usage Example🔗ℹ

Examples:

> (require colorize)

> (colorize/argv 'color)

'(black light-black red light-red green light-green yellow light-yellow blue light-blue magenta light-magenta cyan light-cyan white light-white default)

> (colorize/argv 'style)

'(default bold italic underline blink swap hide)

> (colorize/argv 'all)

'((color black light-black red light-red green light-green yellow light-yellow blue light-blue magenta light-magenta cyan light-cyan white light-white default) (style default bold italic underline blink swap hide))

> (colorize "this is a raw red string" 'red)

"\e[0;31;49mthis is a raw red string\e[0m"

; below is an example about how to display the the red string to your terminal

> (displayln (colorize "this is a raw red string" 'red))

[0;31;49mthis is a raw red string[0m

> (colorize "this is a raw red string on blue with underline" 'red #:background 'blue #:style 'underline)

"\e[4;31;44mthis is a raw red string on blue with underline\e[0m"

; a practical usage example shown below:

> (string-join `("\n" ,(colorize "Happy" 'light-red) ,(colorize "Hacking" 'blue) ,(colorize (string-titlecase (or (getenv "USER") "user")) 'green) "-" ,(colorize "Racket" 'cyan) ,(colorize "♥" 'magenta) ,(colorize "You" 'light-magenta) ,(colorize "!!!" 'red) "\n\n") " ")

"\n \e[0;91;49mHappy\e[0m \e[0;34;49mHacking\e[0m \e[0;32;49mUser\e[0m - \e[0;36;49mRacket\e[0m \e[0;35;49m♥\e[0m \e[0;95;49mYou\e[0m \e[0;31;49m!!!\e[0m \n\n"

> (require colorize)
> (colorize/argv 'color)
'(black light-black red light-red green light-green yellow light-yellow blue light-blue magenta light-magenta cyan light-cyan white light-white default)
> (colorize/argv 'style)
'(default bold italic underline blink swap hide)
> (colorize/argv 'all)
'((color black light-black red light-red green light-green yellow light-yellow blue light-blue magenta light-magenta cyan light-cyan white light-white default) (style default bold italic underline blink swap hide))
> (colorize "this is a raw red string" 'red)
"\e[0;31;49mthis is a raw red string\e[0m"
; below is an example about how to display the the red string to your terminal
> (displayln (colorize "this is a raw red string" 'red))
[0;31;49mthis is a raw red string[0m
> (colorize "this is a raw red string on blue with underline" 'red #:background 'blue #:style 'underline)
"\e[4;31;44mthis is a raw red string on blue with underline\e[0m"
; a practical usage example shown below:
> (string-join `("\n" ,(colorize "Happy" 'light-red) ,(colorize "Hacking" 'blue) ,(colorize (string-titlecase (or (getenv "USER") "user")) 'green) "-" ,(colorize "Racket" 'cyan) ,(colorize "♥" 'magenta) ,(colorize "You" 'light-magenta) ,(colorize "!!!" 'red) "\n\n") " ")
"\n \e[0;91;49mHappy\e[0m \e[0;34;49mHacking\e[0m \e[0;32;49mUser\e[0m - \e[0;36;49mRacket\e[0m \e[0;35;49m♥\e[0m \e[0;95;49mYou\e[0m \e[0;31;49m!!!\e[0m \n\n"

3 Optional Colorization🔗ℹ

Parameter used by colorize-optional.

True if the environment variable "NO_COLOR"is set and not equal to 0.

Parameter used by colorize-optional. Initial value of this parameter is equal to the value of NO_COLOR?,

(colorize-optional str arg ...)

If colorize? is #true and no-color? is #falsethen the str will be colorized with colorize.

arg ... are the arguments passed down to colorize.

Example: