@loggerjs/pretty 0.5.6 → 0.7.0

package/README.md

@@ -1,12 +1,12 @@
+<p align="center">
+  <a href="https://jskits.github.io/loggerjs/"><img src="https://raw.githubusercontent.com/jskits/loggerjs/main/docs/public/logo.png" alt="LoggerJS logo" width="64" height="64" /></a>
+</p>
+
 # @loggerjs/pretty
 
 Pretty display transports and formatters for LoggerJS.
 
-This package is for local developer experience: browser DevTools, Node
-terminals, and custom debug sinks. Production delivery should still prefer
-structured transports such as `stdoutTransport()`, `fileTransport()`,
-`browserHttpTransport()`, OTLP, Loki, Datadog, or another machine-readable
-destination.
+This package is for local developer experience: browser DevTools, Node terminals, and custom debug sinks. Production delivery should still prefer structured transports such as `stdoutTransport()`, `fileTransport()`, `browserHttpTransport()`, OTLP, Loki, Datadog, or another machine-readable destination.
 
 ## Browser / Console
 
@@ -25,8 +25,7 @@ const logger = createLogger({
 });
 ```
 
-`prettyConsoleTransport()` writes through the unpatched console registry, so it
-can run beside `captureConsoleIntegration()` without feedback loops.
+`prettyConsoleTransport()` writes through the unpatched console registry, so it can run beside `captureConsoleIntegration()` without feedback loops.
 
 ## Node Terminal
 
@@ -45,10 +44,7 @@ const logger = createLogger({
 });
 ```
 
-`prettyStdoutTransport()` and `prettyStderrTransport()` use ANSI colors when the
-target stream is a TTY. They honor `NO_COLOR` and `FORCE_COLOR`, and their
-`flush()` waits for `drain` when the stream reports backpressure. Use these for
-local development; keep `stdoutTransport()` for production NDJSON.
+`prettyStdoutTransport()` and `prettyStderrTransport()` use ANSI colors when the target stream is a TTY. They honor `NO_COLOR` and `FORCE_COLOR`, and their `flush()` waits for `drain` when the stream reports backpressure. Use these for local development; keep `stdoutTransport()` for production NDJSON.
 
 ## Formatter
 
@@ -59,5 +55,4 @@ const rendered = formatPrettyEvent(event, { mode: "expanded", colors: "never" })
 console.log(rendered.text);
 ```
 
-The formatter returns plain text, ANSI text, browser console arguments, and raw
-detail values so custom transports can preserve inspectable objects.
+The formatter returns plain text, ANSI text, browser console arguments, and raw detail values so custom transports can preserve inspectable objects.

package/dist/console-transport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"console-transport.d.ts","sourceRoot":"","sources":["../src/console-transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,QAAQ,EAEb,KAAK,SAAS,EAEf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAqB,KAAK,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE7E,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACpC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACnC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,6BAA8B,SAAQ,sBAAsB;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACjC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;CACvC;AAmDD,wBAAgB,sBAAsB,CAAC,OAAO,GAAE,6BAAkC,GAAG,SAAS,CAqC7F"}
+{"version":3,"file":"console-transport.d.ts","sourceRoot":"","sources":["../src/console-transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,QAAQ,EAEb,KAAK,SAAS,EAEf,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAqB,KAAK,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE7E,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACpC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACnC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACrC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,6BAA8B,SAAQ,sBAAsB;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACjC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,OAAO,CAAC;CACvC;AAmDD,wBAAgB,sBAAsB,CAAC,OAAO,GAAE,6BAAkC,GAAG,SAAS,CAqC7F"}

package/dist/index.cjs

@@ -1,354 +1,9 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-let _loggerjs_core = require("@loggerjs/core");
-//#region src/formatter.ts
-const ansiReset = "\x1B[0m";
-const ansiStyles = {
-	trace: "\x1B[90m",
-	debug: "\x1B[36m",
-	info: "\x1B[34m",
-	warn: "\x1B[33m",
-	error: "\x1B[31m",
-	fatal: "\x1B[35m"
-};
-const cssStyles = {
-	trace: "color:#6b7280;font-weight:600",
-	debug: "color:#0891b2;font-weight:600",
-	info: "color:#2563eb;font-weight:600",
-	warn: "color:#b45309;font-weight:700",
-	error: "color:#dc2626;font-weight:700",
-	fatal: "color:#7e22ce;font-weight:800"
-};
-const labels = {
-	trace: "TRACE",
-	debug: "DEBUG",
-	info: "INFO ",
-	warn: "WARN ",
-	error: "ERROR",
-	fatal: "FATAL"
-};
-function levelStyle(levelName, overrides) {
-	const override = overrides?.[levelName];
-	return {
-		label: override?.label ?? labels[levelName],
-		ansi: override?.ansi ?? ansiStyles[levelName],
-		css: override?.css ?? cssStyles[levelName]
-	};
-}
-function formatTime(event, format) {
-	if (typeof format === "function") return format(event);
-	if (format === "none") return void 0;
-	const date = new Date(event.time);
-	if (format === "iso") return date.toISOString();
-	if (format === "local") return date.toLocaleString();
-	return date.toISOString().slice(11, 23);
-}
-function scalar(value) {
-	if (value === null) return "null";
-	if (value === void 0) return "undefined";
-	if (typeof value === "string") return value;
-	if (typeof value === "number" || typeof value === "boolean" || typeof value === "bigint") return String(value);
-	return (0, _loggerjs_core.safeJsonStringify)(value, {
-		maxDepth: 2,
-		maxArrayLength: 20,
-		maxObjectKeys: 20
-	});
-}
-function truncate(value, maxLength) {
-	if (value.length <= maxLength) return value;
-	if (maxLength <= 1) return value.slice(0, maxLength);
-	return `${value.slice(0, Math.max(0, maxLength - 3))}...`;
-}
-function tagText(tags, maxInlineLength) {
-	if (!tags) return void 0;
-	const entries = Object.entries(tags);
-	if (entries.length === 0) return void 0;
-	return entries.map(([key, value]) => `${key}=${truncate(scalar(value), maxInlineLength)}`).join(" ");
-}
-function detailText(value, options) {
-	return (0, _loggerjs_core.safeJsonStringify)(value, {
-		maxDepth: options.maxObjectDepth ?? 4,
-		maxArrayLength: 50,
-		maxObjectKeys: options.maxObjectKeys ?? 80,
-		stable: true
-	});
-}
-function collectDetails(event, options) {
-	const details = [];
-	const push = (key, value) => {
-		if (value === void 0) return;
-		details.push({
-			key,
-			value,
-			text: detailText(value, options)
-		});
-	};
-	if (options.includeData ?? true) push("data", event.data);
-	if (options.includeError ?? true) push("error", event.error);
-	if (options.includeContext ?? false) push("context", event.context);
-	if (options.includeTrace ?? false) push("trace", event.trace);
-	if (options.includeSource ?? false) push("source", event.source);
-	if (options.includeId ?? false) push("id", event.id);
-	return details;
-}
-function baseSegments(event, options) {
-	const maxInlineLength = options.maxInlineLength ?? 160;
-	const style = levelStyle(event.levelName, options.levelStyles);
-	const segments = [];
-	const time = formatTime(event, options.time ?? "time");
-	if (time) segments.push(`[${time}]`);
-	segments.push(style.label);
-	if (options.includeLogger ?? true) segments.push(event.logger);
-	if ((options.includeType ?? true) && event.type) segments.push(`<${event.type}>`);
-	if (options.includeTags ?? true) {
-		const tags = tagText(event.tags, maxInlineLength);
-		if (tags) segments.push(`[${tags}]`);
-	}
-	return segments;
-}
-function plainBaseLine(event, options) {
-	return `${baseSegments(event, options).join(" ")} ${event.message}`;
-}
-function compactText(baseLine, details, maxInlineLength) {
-	if (details.length === 0) return baseLine;
-	return `${baseLine} ${details.map((detail) => `${detail.key}=${truncate(detail.text, maxInlineLength)}`).join(" ")}`;
-}
-function expandedText(baseLine, details) {
-	if (details.length === 0) return baseLine;
-	return [baseLine, ...details.map((detail) => `  ${detail.key}: ${detail.text}`)].join("\n");
-}
-function withAnsi(event, text, options) {
-	if (options.colors !== "always") return text;
-	const style = levelStyle(event.levelName, options.levelStyles);
-	const label = style.label;
-	return text.replace(label, `${style.ansi}${label}${ansiReset}`);
-}
-function browserArgs(event, options, details) {
-	const style = levelStyle(event.levelName, options.levelStyles);
-	const segments = baseSegments(event, options);
-	const levelIndex = segments.indexOf(style.label);
-	const beforeLevel = segments.slice(0, levelIndex).join(" ");
-	const afterLevel = segments.slice(levelIndex + 1).join(" ");
-	const before = beforeLevel ? `${beforeLevel} ` : "";
-	const after = afterLevel ? ` ${afterLevel}` : "";
-	return [
-		`%c${before}%c${style.label}%c${after} ${event.message}`,
-		"color:#6b7280",
-		style.css,
-		"",
-		...details.map((detail) => detail.value)
-	];
-}
-function formatPrettyEvent(event, options = {}) {
-	const maxInlineLength = options.maxInlineLength ?? 160;
-	const details = collectDetails(event, options);
-	const baseLine = plainBaseLine(event, options);
-	const text = (options.mode ?? "compact") === "expanded" ? expandedText(baseLine, details) : compactText(baseLine, details, maxInlineLength);
-	return {
-		text,
-		ansiText: withAnsi(event, text, options),
-		browserArgs: browserArgs(event, options, details),
-		details
-	};
-}
-//#endregion
-//#region src/console-transport.ts
-function methodForEvent(event) {
-	if (event.levelName === "trace") return "trace";
-	if (event.levelName === "debug") return "debug";
-	if (event.levelName === "warn") return "warn";
-	if (event.levelName === "error" || event.levelName === "fatal") return "error";
-	return "info";
-}
-function defaultFilter(event) {
-	const integration = event.source?.integration;
-	return integration !== "capture-console" && integration !== "integration:capture-console";
-}
-function browserStyleSupport() {
-	return typeof window !== "undefined" && typeof document !== "undefined";
-}
-function shouldUseBrowserStyles(value) {
-	if (value === void 0 || value === "auto") return browserStyleSupport();
-	return value;
-}
-function writerFor(method, target) {
-	if (target) return (target[method] ?? target.log ?? target.info ?? (() => {})).bind(target);
-	const registry = (0, _loggerjs_core.registerUnpatchedDefaults)();
-	const fallback = typeof console === "undefined" ? {} : console;
-	const writer = registry.console[method] ?? fallback[method] ?? registry.console.log ?? fallback.log ?? (() => {});
-	return typeof console === "undefined" ? writer : writer.bind(console);
-}
-function prettyConsoleTransport(options = {}) {
-	const filter = options.filter ?? defaultFilter;
-	const useBrowserStyles = shouldUseBrowserStyles(options.browserStyles);
-	const writeEvent = (event) => {
-		if (!filter(event)) return;
-		const rendered = formatPrettyEvent(event, options);
-		const writer = writerFor(methodForEvent(event), options.console);
-		const args = useBrowserStyles ? rendered.browserArgs : [options.colors === "always" ? rendered.ansiText : rendered.text, ...rendered.details.map((detail) => detail.value)];
-		if (options.includeEvent) args.push(event);
-		writer(...args);
-	};
-	const writeRecord = (record, context) => {
-		writeEvent(context.toEvent(record));
-	};
-	return {
-		name: options.name ?? "pretty-console",
-		write(record, context) {
-			writeRecord(record, context);
-		},
-		writeBatch(records, context) {
-			for (const record of records) writeRecord(record, context);
-		},
-		log(event) {
-			writeEvent(event);
-		},
-		logBatch(events) {
-			for (const event of events) writeEvent(event);
-		}
-	};
-}
-//#endregion
-//#region src/stream-transport.ts
-function normalizeError(error) {
-	return error instanceof Error ? error : new Error(String(error));
-}
-function currentProcess() {
-	return globalThis.process;
-}
-function processFor(options) {
-	return options.process ?? currentProcess();
-}
-function shouldUseAnsi(stream, options) {
-	if (options.colors === "always") return true;
-	if (options.colors === "never") return false;
-	const env = processFor(options)?.env;
-	if (env?.NO_COLOR !== void 0) return false;
-	if (env?.FORCE_COLOR !== void 0 && env.FORCE_COLOR !== "0") return true;
-	return stream.isTTY === true;
-}
-function streamFromProcess(options, key) {
-	const stream = processFor(options)?.[key];
-	if (!stream) throw new Error(`pretty ${key} transport requires a writable stream or process.${key}`);
-	return stream;
-}
-function prettyStreamTransport(options = {}) {
-	const stream = options.stream ?? streamFromProcess(options, "stdout");
-	const useAnsi = shouldUseAnsi(stream, options);
-	const newline = options.newline ?? "\n";
-	const waiters = [];
-	let pendingDrains = 0;
-	let lastError;
-	let lastContext;
-	let closed = false;
-	const settleWaitersIfIdle = () => {
-		if (pendingDrains > 0 || waiters.length === 0) return;
-		const error = lastError;
-		lastError = void 0;
-		for (const waiter of waiters.splice(0)) if (error) waiter.reject(error);
-		else waiter.resolve();
-	};
-	const recordError = (error, operation) => {
-		lastError = normalizeError(error);
-		lastContext?.reportInternalError(lastError, {
-			phase: "transport",
-			transport: options.name ?? "pretty-stream",
-			operation
-		});
-		settleWaitersIfIdle();
-	};
-	const onError = (error) => recordError(error, "stream-error");
-	stream.on?.("error", onError);
-	const waitForDrain = () => {
-		if (!stream.once) return;
-		pendingDrains += 1;
-		stream.once("drain", () => {
-			pendingDrains -= 1;
-			settleWaitersIfIdle();
-		});
-	};
-	const writePayload = (payload, context) => {
-		if (closed) return;
-		lastContext = context;
-		try {
-			if (stream.write(payload) === false) waitForDrain();
-		} catch (error) {
-			recordError(error, "write");
-		}
-	};
-	const writeEvent = (event, context) => {
-		if (options.minLevel !== void 0 && event.level < (0, _loggerjs_core.toLevelValue)(options.minLevel)) return;
-		const rendered = formatPrettyEvent(event, {
-			...options,
-			colors: useAnsi ? "always" : "never"
-		});
-		writePayload(`${useAnsi ? rendered.ansiText : rendered.text}${newline}`, context);
-	};
-	const transport = {
-		name: options.name ?? "pretty-stream",
-		minLevel: options.minLevel,
-		write(record, context) {
-			writeEvent(context.toEvent(record), context);
-		},
-		writeBatch(records, context) {
-			for (const record of records) writeEvent(context.toEvent(record), context);
-		},
-		log(event, context) {
-			writeEvent(event, context);
-		},
-		logBatch(events, context) {
-			for (const event of events) writeEvent(event, context);
-		},
-		flush() {
-			if (pendingDrains === 0) {
-				const error = lastError;
-				lastError = void 0;
-				if (error) return Promise.reject(error);
-				return Promise.resolve();
-			}
-			return new Promise((resolve, reject) => {
-				waiters.push({
-					resolve,
-					reject
-				});
-			});
-		},
-		flushSync() {},
-		close() {
-			return Promise.resolve(transport.flush?.()).then(() => new Promise((resolve, reject) => {
-				closed = true;
-				stream.off?.("error", onError);
-				if (!options.endOnClose || !stream.end) {
-					resolve();
-					return;
-				}
-				stream.end((error) => {
-					if (error) reject(error);
-					else resolve();
-				});
-			}));
-		}
-	};
-	return transport;
-}
-function prettyStdoutTransport(options = {}) {
-	return prettyStreamTransport({
-		...options,
-		name: options.name ?? "pretty-stdout",
-		stream: options.stream ?? streamFromProcess(options, "stdout")
-	});
-}
-function prettyStderrTransport(options = {}) {
-	return prettyStreamTransport({
-		...options,
-		name: options.name ?? "pretty-stderr",
-		stream: options.stream ?? streamFromProcess(options, "stderr")
-	});
-}
-//#endregion
-exports.formatPrettyEvent = formatPrettyEvent;
-exports.prettyConsoleTransport = prettyConsoleTransport;
-exports.prettyStderrTransport = prettyStderrTransport;
-exports.prettyStdoutTransport = prettyStdoutTransport;
-exports.prettyStreamTransport = prettyStreamTransport;
-
-//# sourceMappingURL=index.cjs.map
+const require_formatter = require("./formatter.cjs");
+const require_transport_console = require("./transport-console.cjs");
+const require_transport_stream = require("./transport-stream.cjs");
+exports.formatPrettyEvent = require_formatter.formatPrettyEvent;
+exports.prettyConsoleTransport = require_transport_console.prettyConsoleTransport;
+exports.prettyStderrTransport = require_transport_stream.prettyStderrTransport;
+exports.prettyStdoutTransport = require_transport_stream.prettyStdoutTransport;
+exports.prettyStreamTransport = require_transport_stream.prettyStreamTransport;