@katyella/legio 0.1.0

package/src/logging/color.test.ts

@@ -0,0 +1,118 @@
+import { spawn } from "node:child_process";
+import { dirname, join } from "node:path";
+import { describe, expect, test } from "vitest";
+
+// Resolve the project root from this file's location (src/logging/ -> project root)
+const projectRoot = join(dirname(import.meta.dirname), "..");
+
+function makeEnv(overrides: Record<string, string | undefined>): Record<string, string> {
+	const merged = { ...process.env, ...overrides };
+	return Object.fromEntries(Object.entries(merged).filter(([, v]) => v !== undefined)) as Record<
+		string,
+		string
+	>;
+}
+
+async function runBun(
+	code: string,
+	envOverrides: Record<string, string | undefined>,
+): Promise<string> {
+	return new Promise((resolve, reject) => {
+		const proc = spawn("node", ["-e", code], {
+			cwd: projectRoot,
+			env: makeEnv(envOverrides),
+			stdio: ["ignore", "pipe", "pipe"],
+		});
+		let stdout = "";
+		proc.stdout?.on("data", (chunk: Buffer) => {
+			stdout += chunk.toString();
+		});
+		proc.on("close", () => resolve(stdout));
+		proc.on("error", reject);
+	});
+}
+
+describe("color module", () => {
+	// Test via subprocess to control env vars at import time
+
+	test("colors enabled by default (no env vars)", async () => {
+		const code =
+			'import { color, colorsEnabled } from "./src/logging/color.ts"; console.log(JSON.stringify({ colorsEnabled, reset: color.reset }))';
+		const output = await runBun(code, {
+			NO_COLOR: undefined,
+			FORCE_COLOR: undefined,
+			TERM: undefined,
+		});
+		const result = JSON.parse(output.trim());
+		expect(result.colorsEnabled).toBe(true);
+		expect(result.reset).toBe("\x1b[0m");
+	});
+
+	test("NO_COLOR disables colors", async () => {
+		const code =
+			'import { color, colorsEnabled } from "./src/logging/color.ts"; console.log(JSON.stringify({ colorsEnabled, reset: color.reset }))';
+		const output = await runBun(code, { NO_COLOR: "1", FORCE_COLOR: undefined });
+		const result = JSON.parse(output.trim());
+		expect(result.colorsEnabled).toBe(false);
+		expect(result.reset).toBe("");
+	});
+
+	test("TERM=dumb disables colors", async () => {
+		const code =
+			'import { color, colorsEnabled } from "./src/logging/color.ts"; console.log(JSON.stringify({ colorsEnabled, reset: color.reset }))';
+		const output = await runBun(code, {
+			TERM: "dumb",
+			NO_COLOR: undefined,
+			FORCE_COLOR: undefined,
+		});
+		const result = JSON.parse(output.trim());
+		expect(result.colorsEnabled).toBe(false);
+		expect(result.reset).toBe("");
+	});
+
+	test("FORCE_COLOR overrides NO_COLOR", async () => {
+		const code =
+			'import { color, colorsEnabled } from "./src/logging/color.ts"; console.log(JSON.stringify({ colorsEnabled, reset: color.reset }))';
+		const output = await runBun(code, { NO_COLOR: "1", FORCE_COLOR: "1" });
+		const result = JSON.parse(output.trim());
+		expect(result.colorsEnabled).toBe(true);
+		expect(result.reset).toBe("\x1b[0m");
+	});
+
+	test("FORCE_COLOR=0 disables colors", async () => {
+		const code =
+			'import { color, colorsEnabled } from "./src/logging/color.ts"; console.log(JSON.stringify({ colorsEnabled, reset: color.reset }))';
+		const output = await runBun(code, { FORCE_COLOR: "0", NO_COLOR: undefined });
+		const result = JSON.parse(output.trim());
+		expect(result.colorsEnabled).toBe(false);
+	});
+
+	test("setQuiet/isQuiet controls quiet mode", async () => {
+		const { isQuiet, setQuiet } = await import("./color.ts");
+		expect(isQuiet()).toBe(false);
+		setQuiet(true);
+		expect(isQuiet()).toBe(true);
+		setQuiet(false);
+		expect(isQuiet()).toBe(false);
+	});
+
+	test("all color keys present", async () => {
+		const { color } = await import("./color.ts");
+		const expectedKeys = [
+			"reset",
+			"bold",
+			"dim",
+			"red",
+			"green",
+			"yellow",
+			"blue",
+			"magenta",
+			"cyan",
+			"white",
+			"gray",
+		];
+		for (const key of expectedKeys) {
+			expect(key in color).toBe(true);
+		}
+	});
+});

package/src/logging/color.ts

@@ -0,0 +1,71 @@
+/**
+ * Central ANSI color and output control.
+ *
+ * Respects the NO_COLOR convention (https://no-color.org/):
+ * - When NO_COLOR env var is set (any value), all color codes become empty strings
+ * - When TERM=dumb, colors are disabled
+ * - When FORCE_COLOR is set to a truthy value, colors are forced on
+ *
+ * Also provides --quiet support: when quiet mode is enabled, non-error
+ * output is suppressed. Commands check isQuiet() before writing to stdout.
+ */
+
+/**
+ * Priority order for color detection:
+ * 1. FORCE_COLOR (highest) — set to non-"0" to force colors on
+ * 2. NO_COLOR — any value disables colors
+ * 3. TERM=dumb — disables colors
+ * 4. Default: colors enabled
+ */
+function shouldUseColor(): boolean {
+	if (process.env.FORCE_COLOR !== undefined) {
+		return process.env.FORCE_COLOR !== "0";
+	}
+	if (process.env.NO_COLOR !== undefined) {
+		return false;
+	}
+	if (process.env.TERM === "dumb") {
+		return false;
+	}
+	return true;
+}
+
+const useColor = shouldUseColor();
+
+function code(ansiCode: string): string {
+	return useColor ? ansiCode : "";
+}
+
+/**
+ * ANSI color codes that respect NO_COLOR.
+ * When colors are disabled, all values are empty strings.
+ */
+export const color = {
+	reset: code("\x1b[0m"),
+	bold: code("\x1b[1m"),
+	dim: code("\x1b[2m"),
+	red: code("\x1b[31m"),
+	green: code("\x1b[32m"),
+	yellow: code("\x1b[33m"),
+	blue: code("\x1b[34m"),
+	magenta: code("\x1b[35m"),
+	cyan: code("\x1b[36m"),
+	white: code("\x1b[37m"),
+	gray: code("\x1b[90m"),
+} as const;
+
+/** Whether ANSI colors are currently enabled. */
+export const colorsEnabled = useColor;
+
+// --- Quiet mode ---
+let quietMode = false;
+
+/** Enable quiet mode (suppress non-error output). */
+export function setQuiet(enabled: boolean): void {
+	quietMode = enabled;
+}
+
+/** Check if quiet mode is active. */
+export function isQuiet(): boolean {
+	return quietMode;
+}