Determine if ANSI output is enabled.

The first checks are for the JVM system property io.aviso.ansi.enable and then system property ENABLE_ANSI_COLORS. If either of these is non-nil, it sets the value: the value false (matched caselessly) disables ANSI colors and fonts, otherwise they are enabled.

Next, there is an attempt to determine if execution is currently inside a REPL environment, possibly started from an IDE; a check is made to see if nrepl.core namespace is available; if so, then ANSI colors are enabled.

This has been verified to work with Cursive, with lein repl, and with clojure (or clj).

This check is necessary, because often in such cases, there is no console (the next check).

Otherwise, if the system has a console (via (System/console)) ANSI output will be enabled; when Clojure is running in a pipe, or as a background job without a terminal attached, the console will be nil and ANSI output will be disabled.

When this value is false, all the generated color and font constants return the empty string, and the color and font functions return the input string unchanged. This is decided during macro expansion when the ansi namespace is first loaded, so it can’t be changed at runtime.

Wraps the provided text with ANSI codes to render text in black.

Wraps the provided text with ANSI codes to render with a black background.

Constant for ANSI code to render with a black background.

Constant for ANSI code to render text in black.

Wraps the provided text with ANSI codes to render text in blue.

Wraps the provided text with ANSI codes to render with a blue background.

Constant for ANSI code to render with a blue background.

Constant for ANSI code to render text in blue.

Wraps the provided text with ANSI codes to render in bold.

Wraps the provided text with ANSI codes to render text in bright black.

Wraps the provided text with ANSI codes to render with a bright black background.

Constant for ANSI code to render with a bright black background.

Constant for ANSI code to render text in bright black.

Wraps the provided text with ANSI codes to render text in bright blue.

Wraps the provided text with ANSI codes to render with a bright blue background.

Constant for ANSI code to render with a bright blue background.

Constant for ANSI code to render text in bright blue.

Wraps the provided text with ANSI codes to render text in bright cyan.

Wraps the provided text with ANSI codes to render with a bright cyan background.

Constant for ANSI code to render with a bright cyan background.

Constant for ANSI code to render text in bright cyan.

Constant for ANSI code to render in bold.

Wraps the provided text with ANSI codes to render text in bright green.

Wraps the provided text with ANSI codes to render with a bright green background.

Constant for ANSI code to render with a bright green background.

Constant for ANSI code to render text in bright green.

Wraps the provided text with ANSI codes to render text in bright magenta.

Wraps the provided text with ANSI codes to render with a bright magenta background.

Constant for ANSI code to render with a bright magenta background.

Constant for ANSI code to render text in bright magenta.

Wraps the provided text with ANSI codes to render text in bright red.

Wraps the provided text with ANSI codes to render with a bright red background.

Constant for ANSI code to render with a bright red background.

Constant for ANSI code to render text in bright red.

Wraps the provided text with ANSI codes to render text in bright white.

Wraps the provided text with ANSI codes to render with a bright white background.

Constant for ANSI code to render with a bright white background.

Constant for ANSI code to render text in bright white.

Wraps the provided text with ANSI codes to render text in bright yellow.

Wraps the provided text with ANSI codes to render with a bright yellow background.

Constant for ANSI code to render with a bright yellow background.

Constant for ANSI code to render text in bright yellow.

Wraps the provided text with ANSI codes to render text in bright black.

Wraps the provided text with ANSI codes to render with a bright black background.

Constant for ANSI code to render with a bright black background.

Constant for ANSI code to render text in bright black.

Wraps the provided text with ANSI codes to render text in bright blue.

Wraps the provided text with ANSI codes to render with a bright blue background.

Constant for ANSI code to render with a bright blue background.

Constant for ANSI code to render text in bright blue.

Wraps the provided text with ANSI codes to render text in bright cyan.

Wraps the provided text with ANSI codes to render with a bright cyan background.

Constant for ANSI code to render with a bright cyan background.

Constant for ANSI code to render text in bright cyan.

Wraps the provided text with ANSI codes to render text in bright green.

Wraps the provided text with ANSI codes to render with a bright green background.

Constant for ANSI code to render with a bright green background.

Constant for ANSI code to render text in bright green.

Wraps the provided text with ANSI codes to render text in bright magenta.

Wraps the provided text with ANSI codes to render with a bright magenta background.

Constant for ANSI code to render with a bright magenta background.

Constant for ANSI code to render text in bright magenta.

Wraps the provided text with ANSI codes to render text in bright red.

Wraps the provided text with ANSI codes to render with a bright red background.

Constant for ANSI code to render with a bright red background.

Constant for ANSI code to render text in bright red.

Wraps the provided text with ANSI codes to render text in bright white.

Wraps the provided text with ANSI codes to render with a bright white background.

Constant for ANSI code to render with a bright white background.

Constant for ANSI code to render text in bright white.

Wraps the provided text with ANSI codes to render text in bright yellow.

Wraps the provided text with ANSI codes to render with a bright yellow background.

Constant for ANSI code to render with a bright yellow background.

Constant for ANSI code to render text in bright yellow.

Given a Hiccup-inspired data structure, composes and returns a string that includes necessary ANSI codes.

The data structure may consist of literal values (strings, numbers, etc.) that are formatted with str and concatenated.

Nested sequences are composed recursively; this (for example) allows the output from map or for to be mixed into the composed string seamlessly.

Nested vectors represent blocks; the first element in the vector is a keyword that defines the font used within the block. The font def contains one or more terms, separated by periods.

The terms:

• foreground color: e.g. red or bright-red
• background color: e.g., green-bg or bright-green-bg
• boldness: bold, faint, or plain
• italics: italic or roman
• inverse: inverse or normal
• underline: underlined or not-underlined

e.g.

(compose [:yellow "Warning: the " [:bold.bright-white.bright-red-bg "reactor"]
  " is about to "
  [:italic.bold-red "meltdown!"]])
=> ...

Font defs apply on top of the font def of the enclosing block, and the outer block’s font def is restored at the end of the inner block, e.g. [:red " RED " [:bold "RED/BOLD"] " RED "].

compose presumes that on entry the current font is plain (default foreground and background, not bold, or inverse, or italic) and appends a reset-font to the end of the returned string to ensure that later output is also plain.

The control sequence initiator: ESC [

Wraps the provided text with ANSI codes to render text in cyan.

Wraps the provided text with ANSI codes to render with a cyan background.

Constant for ANSI code to render with a cyan background.

Constant for ANSI code to render text in cyan.

Wraps the provided text with ANSI codes to render with the default background color.

Constant for ANSI code to render with the default background color.

Wraps the provided text with ANSI codes to render with the default foreground color.

Constant for ANSI code to render with the default foreground color.

Wraps the provided text with ANSI codes to render as faint (not bold or plain).

Constant for ANSI code to render as faint (not bold or plain).

Wraps the provided text with ANSI codes to render text in green.

Wraps the provided text with ANSI codes to render with a green background.

Constant for ANSI code to render with a green background.

Constant for ANSI code to render text in green.

Wraps the provided text with ANSI codes to render as inverse (foreground and background colors reversed).

Constant for ANSI code to render as inverse (foreground and background colors reversed).

Wraps the provided text with ANSI codes to render italicized.

Constant for ANSI code to render italicized.

Wraps the provided text with ANSI codes to render text in magenta.

Wraps the provided text with ANSI codes to render with a magenta background.

Constant for ANSI code to render with a magenta background.

Constant for ANSI code to render text in magenta.

Wraps the provided text with ANSI codes to render as normal (not inverse).

Constant for ANSI code to render as normal (not inverse).

Wraps the provided text with ANSI codes to render not underlined.

Constant for ANSI code to render not underlined.

Wraps the provided text with ANSI codes to render as plain (not bold or faint).

Constant for ANSI code to render as plain (not bold or faint).

Wraps the provided text with ANSI codes to render text in red.

Wraps the provided text with ANSI codes to render with a red background.

Constant for ANSI code to render with a red background.

Constant for ANSI code to render text in red.

Resets the font, clearing all colors and other attributes.

Wraps the provided text with ANSI codes to render as romain (not italic).

Constant for ANSI code to render as romain (not italic).

The Select Graphic Rendition suffix: m

Removes ANSI codes from a string, returning just the raw text.

Wraps the provided text with ANSI codes to render underlined.

Constant for ANSI code to render underlined.

Returns the length of the string, with ANSI codes stripped out.

Wraps the provided text with ANSI codes to render text in white.

Wraps the provided text with ANSI codes to render with a white background.

Constant for ANSI code to render with a white background.

Constant for ANSI code to render text in white.

Wraps the provided text with ANSI codes to render text in yellow.

Wraps the provided text with ANSI codes to render with a yellow background.

Constant for ANSI code to render with a yellow background.

Constant for ANSI code to render text in yellow.