shelving/util/ansi.js

Toolkit for using data in JavaScript.

import { DOWN, FAILURE, LEFT, RIGHT, SUCCESS, UP, WAITING } from "./constants.js";
import { getEnvBoolean } from "./env.js";
// Colors.
export const ANSI_DEFAULT = "\x1b[39m";
export const ANSI_BLACK = "\x1b[30m";
export const ANSI_RED = "\x1b[31m";
export const ANSI_GREEN = "\x1b[32m";
export const ANSI_YELLOW = "\x1b[33m";
export const ANSI_BLUE = "\x1b[34m";
export const ANSI_MAGENTA = "\x1b[35m";
export const ANSI_CYAN = "\x1b[36m";
export const ANSI_WHITE = "\x1b[37m";
// Styles.
export const ANSI_BOLD = "\x1b[1m";
export const ANSI_ITALIC = "\x1b[3m";
export const ANSI_UNDERLINE = "\x1b[4m";
export const ANSI_STRIKE = "\x1b[9m";
export const ANSI_INVERSE = "\x1b[7m";
// Reset.
export const ANSI_RESET = "\x1b[0m";
/**
 * Wrap a string in the ANSI color/style codes (at the start), and `ANSI_RESET` at the end.
 *
 * - The `NO_COLOR` environment variable is read live on every call, so runtimes that populate `process.env` late (e.g. Cloudflare Workers, where `[vars]` bindings are only reliably available within the request scope) are honoured rather than baking in whatever `NO_COLOR` was at module-load time.
 */
export function ansiWrap(input, ...wrappers) {
    if (getEnvBoolean("NO_COLOR"))
        return input;
    return `${wrappers.join("")}${input}${ANSI_RESET}`;
}
/** Create a lazily-coloured {@link AnsiIcon} that wraps `icon` in `wrappers` on each `toString()`. */
function _createAnsiIcon(icon, ...wrappers) {
    return {
        toString() {
            return ansiWrap(icon, ...wrappers);
        },
    };
}
// Coloured icons.
export const ANSI_WAITING = _createAnsiIcon(WAITING, ANSI_BLUE);
export const ANSI_SUCCESS = _createAnsiIcon(SUCCESS, ANSI_GREEN);
export const ANSI_FAILURE = _createAnsiIcon(FAILURE, ANSI_RED);
export const ANSI_UP = _createAnsiIcon(UP, ANSI_BLUE);
export const ANSI_DOWN = _createAnsiIcon(DOWN, ANSI_BLUE);
export const ANSI_RIGHT = _createAnsiIcon(RIGHT, ANSI_BLUE);
export const ANSI_LEFT = _createAnsiIcon(LEFT, ANSI_BLUE);