@reliverse/relico 1.1.0 → 1.1.2

package/bin/utils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Logs a "FATAL" error, triggers a debugger in dev, and throws an error.
+ */
+export declare const shouldNeverHappen: (msg?: string, ...args: any[]) => never;

package/bin/utils.js

@@ -0,0 +1,10 @@
+function isDevEnv() {
+  return process.env.NODE_ENV === "development";
+}
+export const shouldNeverHappen = (msg, ...args) => {
+  console.error(msg, ...args);
+  if (isDevEnv()) {
+    debugger;
+  }
+  throw new Error(`This should never happen: ${msg}`);
+};

package/package.json

@@ -1,15 +1,15 @@
 {
   "dependencies": {
     "@reliverse/runtime": "^1.0.3",
-    "c12": "^3.0.2",
+    "c12": "^3.0.3",
     "pathe": "^2.0.3"
   },
-  "description": "@reliverse/relico is doing its best to improve your terminal colorization experience by leveraging TypeScript and TypeBox for enhanced reliability and type safety.",
+  "description": "@reliverse/relico is a themeable, chainable, typed, truecolor-powered, modern terminal styling toolkit. Designed to make your CLI output colorful, accessible, and human-friendly. It gives you a flexible way to apply colors and styles — with reliability and a smart developer experience baked in. Built for humans, not just terminals.",
   "homepage": "https://docs.reliverse.org",
   "license": "MIT",
   "name": "@reliverse/relico",
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "author": "reliverse",
   "bugs": {
     "email": "blefnk@gmail.com",
@@ -24,22 +24,23 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
-    "@eslint/js": "^9.23.0",
+    "@eslint/js": "^9.26.0",
     "@reliverse/relidler-cfg": "^1.1.3",
     "@stylistic/eslint-plugin": "^4.2.0",
-    "@types/bun": "^1.2.8",
-    "@types/node": "^22.13.17",
-    "eslint": "^9.23.0",
+    "@total-typescript/ts-reset": "^0.6.1",
+    "@types/bun": "^1.2.13",
+    "@types/node": "^22.15.18",
+    "eslint": "^9.26.0",
     "eslint-plugin-no-relative-import-paths": "^1.6.1",
-    "eslint-plugin-perfectionist": "^4.11.0",
+    "eslint-plugin-perfectionist": "^4.13.0",
     "jiti": "^2.4.2",
-    "knip": "^5.46.4",
-    "typescript": "^5.8.2",
-    "typescript-eslint": "^8.29.0",
-    "vitest": "^3.1.1"
+    "knip": "^5.56.0",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.32.1",
+    "vitest": "^3.1.3"
   },
   "exports": {
-    ".": "./bin/main.js"
+    ".": "./bin/mod.js"
   },
   "files": [
     "bin",
@@ -47,8 +48,8 @@
     "README.md",
     "LICENSE"
   ],
-  "main": "./bin/main.js",
-  "module": "./bin/main.js",
+  "main": "./bin/mod.js",
+  "module": "./bin/mod.js",
   "publishConfig": {
     "access": "public"
   }

package/bin/main.d.ts

@@ -1,124 +0,0 @@
-/** A color definition: [primary, secondary]. */
-export type ColorDefinition = [string, string];
-/** A list of default color keys. */
-export declare const defaultColorKeys: readonly ["reset", "bold", "dim", "italic", "underline", "inverse", "hidden", "strikethrough", "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "gray", "bgBlack", "bgRed", "bgGreen", "bgYellow", "bgBlue", "bgMagenta", "bgCyan", "bgWhite", "blackBright", "redBright", "greenBright", "yellowBright", "blueBright", "magentaBright", "cyanBright", "whiteBright", "bgBlackBright", "bgRedBright", "bgGreenBright", "bgYellowBright", "bgBlueBright", "bgMagentaBright", "bgCyanBright", "bgWhiteBright"];
-/** Union of all default color keys */
-export type DefaultColorKeys = (typeof defaultColorKeys)[number];
-/**
- * Format keys that must NOT be overridden by the user.
- * We'll exclude them from IntelliSense and also skip them at runtime.
- */
-type RestrictedKeys = "reset" | "bold" | "dim" | "italic" | "underline" | "inverse" | "hidden" | "strikethrough";
-/** All the keys user is allowed to override */
-type OverridableColorKeys = Exclude<DefaultColorKeys, RestrictedKeys>;
-/** A map of user-overridable color definitions (no format keys) */
-export type OverridableColorMap = Partial<Record<OverridableColorKeys, ColorDefinition>>;
-/**
- * `relico.config.ts` configuration options.
- * Note: `customColors` is restricted to OverridableColorMap.
- */
-export type RelicoConfig = {
-    /**
-     * Determines which ANSI mode is used:
-     * - 0: no color
-     * - 1: basic ANSI (8 colors)
-     * - 2: 256 color palette
-     * - 3: 24-bit truecolor (default)
-     */
-    colorLevel?: 0 | 1 | 2 | 3;
-    /**
-     * Theme to use for color definitions.
-     * - "primary": primary theme (default)
-     * - "secondary": secondary theme
-     */
-    theme?: "primary" | "secondary";
-    /**
-     * Custom color definitions.
-     * - Theming: ["primary", "secondary"]
-     */
-    customColors?: OverridableColorMap;
-};
-export type IRelicoColors = {
-    reset(text: string | number): string;
-    bold(text: string | number): string;
-    dim(text: string | number): string;
-    italic(text: string | number): string;
-    underline(text: string | number): string;
-    inverse(text: string | number): string;
-    hidden(text: string | number): string;
-    strikethrough(text: string | number): string;
-    black(text: string | number): string;
-    red(text: string | number): string;
-    green(text: string | number): string;
-    yellow(text: string | number): string;
-    blue(text: string | number): string;
-    magenta(text: string | number): string;
-    cyan(text: string | number): string;
-    white(text: string | number): string;
-    gray(text: string | number): string;
-    bgBlack(text: string | number): string;
-    bgRed(text: string | number): string;
-    bgGreen(text: string | number): string;
-    bgYellow(text: string | number): string;
-    bgBlue(text: string | number): string;
-    bgMagenta(text: string | number): string;
-    bgCyan(text: string | number): string;
-    bgWhite(text: string | number): string;
-    blackBright(text: string | number): string;
-    redBright(text: string | number): string;
-    greenBright(text: string | number): string;
-    yellowBright(text: string | number): string;
-    blueBright(text: string | number): string;
-    magentaBright(text: string | number): string;
-    cyanBright(text: string | number): string;
-    whiteBright(text: string | number): string;
-    bgBlackBright(text: string | number): string;
-    bgRedBright(text: string | number): string;
-    bgGreenBright(text: string | number): string;
-    bgYellowBright(text: string | number): string;
-    bgBlueBright(text: string | number): string;
-    bgMagentaBright(text: string | number): string;
-    bgCyanBright(text: string | number): string;
-    bgWhiteBright(text: string | number): string;
-    [k: string]: (text: string | number) => string;
-};
-export declare const re: IRelicoColors;
-/**
- * Configures the library with a partial or complete
- * `RelicoConfig`. Invalid fields are just ignored.
- */
-export declare function configure(userInput: unknown): void;
-/** Returns a color function by name (or `reset` or identity if not found). */
-export declare function getColor(name: string): (text: string | number) => string;
-/** Colorizes text with a color function. */
-export declare function colorize(name: string, text: string | number): string;
-/** Sets the color level (0=none, 1=basic, 2=256, 3=truecolor). */
-export declare function setColorLevel(level: 0 | 1 | 2 | 3): void;
-/** Returns a custom "rgb" color function if level is truecolor, otherwise identity. */
-export declare function rgb(r: number, g: number, b: number): (text: string | number) => string;
-export type ColorSupport = {
-    isColorSupported: boolean;
-    isForced: boolean;
-    isDisabled: boolean;
-    terminalName: string;
-};
-export declare const colorSupport: ColorSupport;
-export declare function initUserConfig(): Promise<void>;
-/**
- * Provides type safety and IntelliSense for user configuration.
- * Example usage in `relico.config.ts`:
- * ```ts
- * import { defineConfig } from "@reliverse/relico-cfg";
- * export default defineConfig({
- *   colorLevel: 3,
- *   theme: "secondary",
- *   customColors: {
- *     red: ["#f00", "#c00"],
- *     blue: ["#0af", "#08f"],
- *     green: ["#00ff00", "#00cc00"],
- *   },
- * });
- * ```
- */
-export declare function defineConfig(cfg: RelicoConfig): RelicoConfig;
-export {};

package/bin/main.js

@@ -1,369 +0,0 @@
-import { getCurrentTerminalName } from "@reliverse/runtime";
-import { env, isWindows } from "@reliverse/runtime";
-import { loadConfig } from "c12";
-export const defaultColorKeys = [
-  "reset",
-  "bold",
-  "dim",
-  "italic",
-  "underline",
-  "inverse",
-  "hidden",
-  "strikethrough",
-  "black",
-  "red",
-  "green",
-  "yellow",
-  "blue",
-  "magenta",
-  "cyan",
-  "white",
-  "gray",
-  "bgBlack",
-  "bgRed",
-  "bgGreen",
-  "bgYellow",
-  "bgBlue",
-  "bgMagenta",
-  "bgCyan",
-  "bgWhite",
-  "blackBright",
-  "redBright",
-  "greenBright",
-  "yellowBright",
-  "blueBright",
-  "magentaBright",
-  "cyanBright",
-  "whiteBright",
-  "bgBlackBright",
-  "bgRedBright",
-  "bgGreenBright",
-  "bgYellowBright",
-  "bgBlueBright",
-  "bgMagentaBright",
-  "bgCyanBright",
-  "bgWhiteBright"
-];
-const argv = typeof process === "undefined" ? [] : process.argv;
-const isDisabled = "NO_COLOR" in env || argv.includes("--no-color");
-const isForced = "FORCE_COLOR" in env || argv.includes("--color");
-const isCI = "CI" in env && ("GITHUB_ACTIONS" in env || "GITLAB_CI" in env || "CIRCLECI" in env);
-const isCompatibleTerminal = typeof process !== "undefined" && Boolean(process.stdout) && Boolean(process.stdout.isTTY) && env.TERM !== "dumb";
-const colorterm = (env.COLORTERM ?? "").toLowerCase();
-const supportsTrueColor = colorterm === "truecolor" || colorterm === "24bit";
-function detectColorLevel() {
-  if (isDisabled) return 0;
-  if (isForced) return 3;
-  if (supportsTrueColor) return 3;
-  if (isWindows) return 2;
-  if (isCI) return 2;
-  if (isCompatibleTerminal) return 2;
-  return 0;
-}
-const baseColors = {
-  // Text formatting
-  reset: ["\x1B[0m", "\x1B[0m"],
-  bold: ["\x1B[1m", "\x1B[22m"],
-  dim: ["\x1B[2m", "\x1B[22m"],
-  italic: ["\x1B[3m", "\x1B[23m"],
-  underline: ["\x1B[4m", "\x1B[24m"],
-  inverse: ["\x1B[7m", "\x1B[27m"],
-  hidden: ["\x1B[8m", "\x1B[28m"],
-  strikethrough: ["\x1B[9m", "\x1B[29m"],
-  // Foreground colors
-  black: ["#000000", "#000000"],
-  red: ["#ff5555", "#ff0000"],
-  green: ["#00ff00", "#00ff00"],
-  yellow: ["#ffff00", "#ffff00"],
-  blue: ["#0000ff", "#0000ff"],
-  magenta: ["#ff00ff", "#ff00ff"],
-  cyan: ["#00ffff", "#00ffff"],
-  white: ["#ffffff", "#ffffff"],
-  gray: ["#808080", "#808080"],
-  // Background colors
-  bgBlack: ["#000000", "#000000"],
-  bgRed: ["#ff5555", "#ff0000"],
-  bgGreen: ["#00ff00", "#00ff00"],
-  bgYellow: ["#ffff00", "#ffff00"],
-  bgBlue: ["#0000ff", "#0000ff"],
-  bgMagenta: ["#ff00ff", "#ff00ff"],
-  bgCyan: ["#00ffff", "#00ffff"],
-  bgWhite: ["#ffffff", "#ffffff"],
-  // Bright colors.
-  blackBright: ["#000000", "#000000"],
-  redBright: ["#ff5555", "#ff5555"],
-  greenBright: ["#50fa7b", "#50fa7b"],
-  yellowBright: ["#f1fa8c", "#f1fa8c"],
-  blueBright: ["#24bdff", "#24bdff"],
-  magentaBright: ["#ff79c6", "#ff79c6"],
-  cyanBright: ["#8be9fd", "#8be9fd"],
-  whiteBright: ["#ffffff", "#ffffff"],
-  // Bright background colors.
-  bgBlackBright: ["#000000", "#000000"],
-  bgRedBright: ["#ff5555", "#ff5555"],
-  bgGreenBright: ["#50fa7b", "#50fa7b"],
-  bgYellowBright: ["#f1fa8c", "#f1fa8c"],
-  bgBlueBright: ["#24bdff", "#24bdff"],
-  bgMagentaBright: ["#ff79c6", "#ff79c6"],
-  bgCyanBright: ["#8be9fd", "#8be9fd"],
-  bgWhiteBright: ["#ffffff", "#ffffff"]
-};
-const windowsTerminalColors = {
-  ...baseColors,
-  red: ["#ff5555", "#ff5555"],
-  green: ["#50fa7b", "#50fa7b"],
-  yellow: ["#f1fa8c", "#f1fa8c"],
-  blue: ["#6272a4", "#6272a4"],
-  magenta: ["#ff79c6", "#ff79c6"],
-  cyan: ["#8be9fd", "#8be9fd"]
-};
-const restrictedKeys = /* @__PURE__ */ new Set([
-  "reset",
-  "bold",
-  "dim",
-  "italic",
-  "underline",
-  "inverse",
-  "hidden",
-  "strikethrough"
-]);
-let config = {
-  colorLevel: detectColorLevel(),
-  theme: "primary"
-  // default theme; can be overridden in user config
-};
-let colorMap = {};
-let colorFunctions = {};
-function hexToRGB(hex) {
-  if (hex.startsWith("#")) {
-    hex = hex.slice(1);
-  }
-  if (hex.length === 3) {
-    hex = hex.split("").map((c) => c + c).join("");
-  }
-  if (hex.length !== 6) {
-    throw new Error(`Invalid hex color: ${hex}`);
-  }
-  const r = Number.parseInt(hex.substring(0, 2), 16);
-  const g = Number.parseInt(hex.substring(2, 4), 16);
-  const b = Number.parseInt(hex.substring(4, 6), 16);
-  return { r, g, b };
-}
-function hexToAnsiParts(hex, isBg = false) {
-  const { r, g, b } = hexToRGB(hex);
-  const open = isBg ? `\x1B[48;2;${r};${g};${b}m` : `\x1B[38;2;${r};${g};${b}m`;
-  const close = isBg ? "\x1B[49m" : "\x1B[39m";
-  return { open, close };
-}
-function hexToAnsi256(hex, isBg = false) {
-  const { r, g, b } = hexToRGB(hex);
-  const r5 = Math.round(r / 51);
-  const g5 = Math.round(g / 51);
-  const b5 = Math.round(b / 51);
-  const index = 16 + 36 * r5 + 6 * g5 + b5;
-  return isBg ? `\x1B[48;5;${index}m` : `\x1B[38;5;${index}m`;
-}
-const basicColors = [
-  { name: "black", rgb: { r: 0, g: 0, b: 0 }, fg: 30, bg: 40 },
-  { name: "red", rgb: { r: 205, g: 0, b: 0 }, fg: 31, bg: 41 },
-  { name: "green", rgb: { r: 0, g: 205, b: 0 }, fg: 32, bg: 42 },
-  { name: "yellow", rgb: { r: 205, g: 205, b: 0 }, fg: 33, bg: 43 },
-  { name: "blue", rgb: { r: 0, g: 0, b: 238 }, fg: 34, bg: 44 },
-  { name: "magenta", rgb: { r: 205, g: 0, b: 205 }, fg: 35, bg: 45 },
-  { name: "cyan", rgb: { r: 0, g: 205, b: 205 }, fg: 36, bg: 46 },
-  { name: "white", rgb: { r: 229, g: 229, b: 229 }, fg: 37, bg: 47 }
-];
-function hexToAnsiBasic(hex, isBg = false) {
-  const { r, g, b } = hexToRGB(hex);
-  let bestMatch = basicColors[0];
-  let bestDistance = Number.MAX_VALUE;
-  for (const color of basicColors) {
-    const dr = r - color.rgb.r;
-    const dg = g - color.rgb.g;
-    const db = b - color.rgb.b;
-    const distance = dr * dr + dg * dg + db * db;
-    if (distance < bestDistance) {
-      bestDistance = distance;
-      bestMatch = color;
-    }
-  }
-  const code = isBg ? bestMatch.bg : bestMatch.fg;
-  return `\x1B[${code}m`;
-}
-function convertColorDefinition(key, def) {
-  const isBg = key.toLowerCase().startsWith("bg");
-  const theme = config.theme ?? "primary";
-  const chosen = theme === "primary" ? def[0] : def[1];
-  function convert(str) {
-    if (!str.startsWith("#")) return str;
-    if (config.colorLevel === 3) {
-      return hexToAnsiParts(str, isBg).open;
-    }
-    if (config.colorLevel === 2) {
-      return hexToAnsi256(str, isBg);
-    }
-    if (config.colorLevel === 1) {
-      return hexToAnsiBasic(str, isBg);
-    }
-    return "";
-  }
-  const openConverted = convert(chosen);
-  const close = isBg ? "\x1B[49m" : "\x1B[39m";
-  return [openConverted, close];
-}
-function buildColorMap(cfg) {
-  const terminalName = getCurrentTerminalName();
-  const isWinTerm = terminalName === "Windows Terminal";
-  if (cfg.colorLevel === 0) {
-    const noColorMap = {};
-    for (const k of Object.keys(baseColors)) {
-      noColorMap[k] = ["", ""];
-    }
-    return noColorMap;
-  }
-  let builtIn = { ...baseColors };
-  if (cfg.customColors) {
-    for (const [k, v] of Object.entries(cfg.customColors)) {
-      if (!restrictedKeys.has(k)) {
-        builtIn[k] = v;
-      }
-    }
-  }
-  if (isWinTerm && cfg.colorLevel === 3) {
-    builtIn = { ...windowsTerminalColors, ...builtIn };
-  }
-  for (const key of Object.keys(builtIn)) {
-    builtIn[key] = convertColorDefinition(key, builtIn[key]);
-  }
-  return builtIn;
-}
-function createFormatter(open, close) {
-  return (input) => {
-    return open + String(input) + close;
-  };
-}
-function identityColor(text) {
-  return String(text);
-}
-const typedRe = {
-  reset: identityColor,
-  bold: identityColor,
-  dim: identityColor,
-  italic: identityColor,
-  underline: identityColor,
-  inverse: identityColor,
-  hidden: identityColor,
-  strikethrough: identityColor,
-  black: identityColor,
-  red: identityColor,
-  green: identityColor,
-  yellow: identityColor,
-  blue: identityColor,
-  magenta: identityColor,
-  cyan: identityColor,
-  white: identityColor,
-  gray: identityColor,
-  bgBlack: identityColor,
-  bgRed: identityColor,
-  bgGreen: identityColor,
-  bgYellow: identityColor,
-  bgBlue: identityColor,
-  bgMagenta: identityColor,
-  bgCyan: identityColor,
-  bgWhite: identityColor,
-  blackBright: identityColor,
-  redBright: identityColor,
-  greenBright: identityColor,
-  yellowBright: identityColor,
-  blueBright: identityColor,
-  magentaBright: identityColor,
-  cyanBright: identityColor,
-  whiteBright: identityColor,
-  bgBlackBright: identityColor,
-  bgRedBright: identityColor,
-  bgGreenBright: identityColor,
-  bgYellowBright: identityColor,
-  bgBlueBright: identityColor,
-  bgMagentaBright: identityColor,
-  bgCyanBright: identityColor,
-  bgWhiteBright: identityColor
-};
-export const re = typedRe;
-function refreshTypedRe() {
-  for (const colorName of Object.keys(typedRe)) {
-    typedRe[colorName] = identityColor;
-  }
-  for (const [k, fn] of Object.entries(colorFunctions)) {
-    typedRe[k] = fn;
-  }
-}
-function initColorFunctions() {
-  colorFunctions = {};
-  if (config.colorLevel === 0) {
-    for (const k of Object.keys(baseColors)) {
-      colorFunctions[k] = identityColor;
-    }
-    return;
-  }
-  for (const [key, [open, close]] of Object.entries(colorMap)) {
-    colorFunctions[key] = createFormatter(open, close);
-  }
-}
-function rebuild() {
-  colorMap = buildColorMap(config);
-  initColorFunctions();
-  refreshTypedRe();
-}
-rebuild();
-export function configure(userInput) {
-  let newConfig;
-  if (typeof userInput === "object" && userInput !== null) {
-    newConfig = { ...config, ...userInput };
-  } else {
-    newConfig = { ...config };
-  }
-  config = newConfig;
-  rebuild();
-}
-export function getColor(name) {
-  const maybeFn = colorFunctions[name];
-  if (maybeFn) return maybeFn;
-  const resetFn = colorFunctions.reset;
-  if (resetFn) return resetFn;
-  return identityColor;
-}
-export function colorize(name, text) {
-  const fn = getColor(name);
-  return fn(text);
-}
-export function setColorLevel(level) {
-  configure({ colorLevel: level });
-}
-export function rgb(r, g, b) {
-  if (config.colorLevel === 3) {
-    const open = `\x1B[38;2;${r};${g};${b}m`;
-    const close = "\x1B[39m";
-    return createFormatter(open, close);
-  }
-  return identityColor;
-}
-function getConfig() {
-  return { ...config };
-}
-export const colorSupport = {
-  isColorSupported: getConfig().colorLevel !== 0,
-  isForced,
-  isDisabled,
-  terminalName: getCurrentTerminalName()
-};
-export async function initUserConfig() {
-  try {
-    const { config: userConfig } = await loadConfig({ name: "relico" });
-    configure(userConfig);
-  } catch (err) {
-    console.warn("Failed to load user config via c12:", err);
-  }
-}
-export function defineConfig(cfg) {
-  return cfg;
-}