@andrew_l/pino-pretty 0.2.17 → 0.2.18

package/dist/index.d.cts

@@ -91,6 +91,11 @@ type TypeConfig = {
     color: ColorValue;
 };
 interface PrettyOptions {
+    /**
+     * Pino message key.
+     * @default 'regular'
+     */
+    inspect: 'regular' | 'compact' | InspectFunction;
     /**
      * Pino message key.
      */
@@ -168,6 +173,26 @@ type TypeName = 'number' | 'boolean' | 'string' | 'object' | 'error' | 'errorSta
  * Can be a single color name, array of color names, or 'rand' for random colors.
  */
 type ColorValue = 'rand' | Arrayable<ColorName>;
+type InspectFunction = (obj: any, opts: InspectOptions) => string;
+interface InspectOptions {
+    /** Maximum depth of the inspection @default 5 */
+    depth: number;
+    /** Quote style for strings @default 'single' */
+    quoteStyle: 'single' | 'double';
+    /** Maximum string length before truncation @default Infinity */
+    maxStringLength: number;
+    /** Indentation spaces @default 2 */
+    indent: number;
+    /** Add numeric separators (1_234.567_8) @default false */
+    numericSeparator: boolean;
+    /** Custom stringify functions for different types */
+    customStringify: {
+        [x: string]: InspectCustomStringify;
+    };
+    /** Available width columns */
+    columns: number;
+}
+type InspectCustomStringify = (value: any) => string;
 
 declare namespace PinoPretty {
     type Options = DeepPartial<PrettyOptions>;

package/dist/index.d.mts

@@ -91,6 +91,11 @@ type TypeConfig = {
     color: ColorValue;
 };
 interface PrettyOptions {
+    /**
+     * Pino message key.
+     * @default 'regular'
+     */
+    inspect: 'regular' | 'compact' | InspectFunction;
     /**
      * Pino message key.
      */
@@ -168,6 +173,26 @@ type TypeName = 'number' | 'boolean' | 'string' | 'object' | 'error' | 'errorSta
  * Can be a single color name, array of color names, or 'rand' for random colors.
  */
 type ColorValue = 'rand' | Arrayable<ColorName>;
+type InspectFunction = (obj: any, opts: InspectOptions) => string;
+interface InspectOptions {
+    /** Maximum depth of the inspection @default 5 */
+    depth: number;
+    /** Quote style for strings @default 'single' */
+    quoteStyle: 'single' | 'double';
+    /** Maximum string length before truncation @default Infinity */
+    maxStringLength: number;
+    /** Indentation spaces @default 2 */
+    indent: number;
+    /** Add numeric separators (1_234.567_8) @default false */
+    numericSeparator: boolean;
+    /** Custom stringify functions for different types */
+    customStringify: {
+        [x: string]: InspectCustomStringify;
+    };
+    /** Available width columns */
+    columns: number;
+}
+type InspectCustomStringify = (value: any) => string;
 
 declare namespace PinoPretty {
     type Options = DeepPartial<PrettyOptions>;

package/dist/index.d.ts

@@ -91,6 +91,11 @@ type TypeConfig = {
     color: ColorValue;
 };
 interface PrettyOptions {
+    /**
+     * Pino message key.
+     * @default 'regular'
+     */
+    inspect: 'regular' | 'compact' | InspectFunction;
     /**
      * Pino message key.
      */
@@ -168,6 +173,26 @@ type TypeName = 'number' | 'boolean' | 'string' | 'object' | 'error' | 'errorSta
  * Can be a single color name, array of color names, or 'rand' for random colors.
  */
 type ColorValue = 'rand' | Arrayable<ColorName>;
+type InspectFunction = (obj: any, opts: InspectOptions) => string;
+interface InspectOptions {
+    /** Maximum depth of the inspection @default 5 */
+    depth: number;
+    /** Quote style for strings @default 'single' */
+    quoteStyle: 'single' | 'double';
+    /** Maximum string length before truncation @default Infinity */
+    maxStringLength: number;
+    /** Indentation spaces @default 2 */
+    indent: number;
+    /** Add numeric separators (1_234.567_8) @default false */
+    numericSeparator: boolean;
+    /** Custom stringify functions for different types */
+    customStringify: {
+        [x: string]: InspectCustomStringify;
+    };
+    /** Available width columns */
+    columns: number;
+}
+type InspectCustomStringify = (value: any) => string;
 
 declare namespace PinoPretty {
     type Options = DeepPartial<PrettyOptions>;

package/dist/index.mjs

@@ -1,9 +1,9 @@
 import { Transform } from 'node:stream';
 import abstractTransport from 'pino-abstract-transport';
 import pump from 'pump';
-import { noop, isObject, isFunction, withCache, crc32, deepDefaults, arrayable, capitalize, isString, omit, has } from '@andrew_l/toolkit';
+import { noop, isObject, isFunction, typeOf, isPrimitive, withCache, crc32, deepDefaults, arrayable, capitalize, isString, omit, def, has } from '@andrew_l/toolkit';
 import path from 'node:path';
-import { inspect as inspect$1, formatWithOptions } from 'node:util';
+import { inspect, formatWithOptions } from 'node:util';
 import _SonicBoom from 'sonic-boom';
 import { isMainThread } from 'node:worker_threads';
 import * as tty from 'node:tty';
@@ -196,24 +196,36 @@ function addNumericSeparator(num, str) {
   }
   return str.replace(SEP_REGEX, "$&_");
 }
-function inspectString(str, opts) {
-  var processedStr = str;
-  if (str.length > opts.maxStringLength) {
-    var remaining = str.length - opts.maxStringLength;
-    var trailer = `... ${remaining} more character${remaining > 1 ? "s" : ""}`;
-    processedStr = str.slice(0, opts.maxStringLength);
-    return inspectString(processedStr, opts) + trailer;
-  }
+function escapeString(str, opts) {
   var quoteRegex = QUOTE_REGEX[opts.quoteStyle];
-  var escaped = processedStr.replace(quoteRegex, "\\$1").replace(/[\x00-\x1f]/g, (char) => {
+  return str.replace(quoteRegex, "\\$1").replace(/[\x00-\x1f]/g, (char) => {
     var code = char.charCodeAt(0);
     var escapeChar = ESCAPE_CHARS[code];
     return escapeChar ? `\\${escapeChar}` : `\\x${code.toString(16).padStart(2, "0").toUpperCase()}`;
   });
+}
+function inspectString$1(str, opts) {
+  if (str.length > opts.maxStringLength) {
+    var remaining = str.length - opts.maxStringLength;
+    var trailer = `... ${remaining} more character${remaining > 1 ? "s" : ""}`;
+    str = str.slice(0, opts.maxStringLength);
+    return inspectString$1(str, opts) + trailer;
+  }
+  var escaped = escapeString(str, opts);
   var quote = QUOTES[opts.quoteStyle];
   var result = `${quote}${escaped}${quote}`;
   return opts.customStringify.string?.(result) ?? result;
 }
+function inspectNumber(num, opts) {
+  if (typeof num === "bigint") {
+    var str = `${num}n`;
+    var result = opts.numericSeparator ? addNumericSeparator(num, str) : str;
+    return opts.customStringify.number?.(result) ?? result;
+  }
+  var str = Object.is(num, -0) ? "-0" : String(num);
+  var result = opts.numericSeparator ? addNumericSeparator(num, str) : str;
+  return opts.customStringify.number?.(result) ?? result;
+}
 function getIndentStrings(opts, depth) {
   if (depth === 0) return { base: " ".repeat(opts.indent), prev: "" };
   return {
@@ -248,23 +260,17 @@ function getObjectEntries(obj, inspectFn) {
   }
   return entries;
 }
-function inspectValue(obj, opts, depth, seen) {
+function inspectValue$1(obj, opts, depth, seen) {
   if (obj === void 0)
     return opts.customStringify.undefined?.(obj) ?? "undefined";
   if (obj === null) return opts.customStringify.null?.(obj) ?? "null";
   if (typeof obj === "boolean")
     return opts.customStringify.boolean?.(obj) ?? String(obj);
-  if (typeof obj === "string") return inspectString(obj, opts);
+  if (typeof obj === "string") return inspectString$1(obj, opts);
   if (typeof obj === "number") {
-    if (obj === 0) return Object.is(obj, -0) ? "-0" : "0";
-    var str = String(obj);
-    var result = opts.numericSeparator ? addNumericSeparator(obj, str) : str;
-    return opts.customStringify.number?.(result) ?? result;
-  }
-  if (typeof obj === "bigint") {
-    var str = `${obj}n`;
-    var result = opts.numericSeparator ? addNumericSeparator(obj, str) : str;
-    return opts.customStringify.number?.(result) ?? result;
+    return inspectNumber(obj, opts);
+  } else if (typeof obj === "bigint") {
+    return inspectNumber(obj, opts);
   }
   if (depth >= opts.depth && opts.depth > 0 && typeof obj === "object") {
     return Array.isArray(obj) ? "[Array]" : "[Object]";
@@ -272,7 +278,7 @@ function inspectValue(obj, opts, depth, seen) {
   if (seen.has(obj)) return "[Circular]";
   seen.add(obj);
   var indent = getIndentStrings(opts, depth);
-  var inspectChild = (value) => inspectValue(value, opts, depth + 1, seen);
+  var inspectChild = (value) => inspectValue$1(value, opts, depth + 1, seen);
   if (Array.isArray(obj)) {
     if (obj.length === 0) return "[]";
     var entries = getObjectEntries(obj, inspectChild);
@@ -282,10 +288,10 @@ function inspectValue(obj, opts, depth, seen) {
     return `[ ${entries.join(", ")} ]`;
   }
   if (isObject(obj)) {
-    if (isFunction(obj[inspect$1.custom])) {
+    if (isFunction(obj[inspect.custom])) {
       var lineJoiner = `
 ${indent.prev}`;
-      return inspect$1(obj, { depth: opts.depth - depth }).split("\n").join(lineJoiner);
+      return inspect(obj, { depth: opts.depth - depth }).split("\n").join(lineJoiner);
     }
     var entries = getObjectEntries(obj, inspectChild);
     if (entries.length === 0) return "{}";
@@ -297,9 +303,137 @@ ${indent.prev}`;
   seen.delete(obj);
   return String(obj);
 }
-function inspect(obj, options) {
+function inspectRegular(obj, options) {
+  return inspectValue$1(obj, options, 0, /* @__PURE__ */ new WeakSet());
+}
+
+var INSPECT_MAP = {
+  boolean: (obj, opts) => opts.customStringify.boolean?.(obj) ?? String(obj),
+  string: inspectString,
+  number: inspectNumber,
+  bigint: inspectNumber,
+  undefined: (obj, opts) => opts.customStringify.undefined?.(obj) ?? "undefined",
+  null: () => "null",
+  array: formatArray,
+  object: formatObject
+};
+function inspectCompact(obj, options) {
   return inspectValue(obj, options, 0, /* @__PURE__ */ new WeakSet());
 }
+function inspectValue(obj, opts, depth = 0, seen) {
+  var spaces = depth > 0 ? " ".repeat(opts.indent * depth) : "";
+  var type = typeOf(obj);
+  var inspectFn = INSPECT_MAP[type] || String;
+  if (isFunction(obj[inspect.custom])) {
+    var lineJoiner = `
+${spaces}`;
+    return spaces + inspect(obj, { depth: opts.depth - depth }).split("\n").join(lineJoiner);
+  }
+  return inspectFn(obj, opts, depth, spaces, seen);
+}
+function inspectString(str, opts) {
+  if (str.length > opts.maxStringLength) {
+    var remaining = str.length - opts.maxStringLength;
+    str = str.slice(0, opts.maxStringLength);
+    return formatString(str, remaining, opts);
+  }
+  return formatString(str, 0, opts);
+}
+function formatString(str, remaining, opts) {
+  var escaped = escapeString(str, opts);
+  var quote = QUOTES[opts.quoteStyle];
+  var result;
+  var trailer = remaining > 0 ? opts.customStringify.stringRemaining(`... ${remaining} more characters`) : "";
+  if (escaped.length > opts.columns && escaped.includes("\\n")) {
+    escaped = escaped.replaceAll("\\n", "\n");
+    result = "\n```\n" + (trailer ? `${escaped}
+${trailer}` : escaped) + "\n```";
+  } else {
+    result = `${quote}${escaped}${trailer ?? ""}${quote}`;
+  }
+  return opts.customStringify.string?.(result) ?? result;
+}
+function formatArray(arr, opts, depth, spaces, seen) {
+  if (opts.depth > 0 && depth >= opts.depth) {
+    return "[Array]";
+  }
+  if (seen.has(arr)) {
+    return "[Circular]";
+  }
+  seen.add(arr);
+  var len = arr.length;
+  if (isCompactFormat(arr, depth, spaces.length, opts)) {
+    var compact = [];
+    for (var i = 0; i < len; i++) {
+      compact.push(inspectValue(arr[i], opts, 0, seen));
+    }
+    return `[${compact.join(", ")}]`;
+  }
+  var multiline = [];
+  for (var i = 0; i < len; i++) {
+    var strValue = inspectValue(arr[i], opts, depth + 1, seen);
+    multiline.push(
+      `${spaces}- ${strValue.trimStart ? strValue.trimStart() : strValue}`
+    );
+  }
+  return multiline.join("\n");
+}
+function isCompactFormat(value, depth, spaces, opts) {
+  var availableLength = opts.columns - spaces - depth * opts.indent;
+  var totalLength = 0;
+  if (availableLength <= 0) return false;
+  for (var item of value.flat()) {
+    totalLength += String(item).length + 2;
+    if (totalLength > availableLength || !isPrimitive(item)) return false;
+  }
+  return true;
+}
+function formatObject(obj, opts, depth, spaces, seen) {
+  if (opts.depth > 0 && depth >= opts.depth) {
+    return "[Array]";
+  }
+  if (seen.has(obj)) {
+    return "[Circular]";
+  }
+  seen.add(obj);
+  var entries = Object.entries(obj);
+  var len = entries.length;
+  if (len === 0) return "{}";
+  if (isCompactFormat(entries, depth, spaces.length, opts)) {
+    var compact = [];
+    var key, value;
+    for (var i = 0; i < len; i++) {
+      key = entries[i][0];
+      value = entries[i][1];
+      compact.push(`${key}: ${inspectValue(value, opts, 0, seen)}`);
+    }
+    return `{ ${compact.join(", ")} }`;
+  }
+  var multiline = [];
+  var key, value, strValue, compactMode;
+  for (var i = 0; i < len; i++) {
+    key = entries[i][0];
+    value = entries[i][1];
+    strValue = inspectValue(value, opts, depth + 1, seen);
+    compactMode = strValue[0] === "{" || strValue[0] === "[";
+    if (compactMode) {
+      multiline.push(`${spaces}${key}: ${strValue}`);
+    } else if (value && typeof value === "object") {
+      if (Array.isArray(value) && value.length > 0 && strValue[0] !== "[") {
+        multiline.push(`${spaces}${key}:
+${strValue}`);
+      } else if (!Array.isArray(value)) {
+        multiline.push(`${spaces}${key}:
+${strValue}`);
+      } else {
+        multiline.push(`${spaces}${key}: ${strValue}`);
+      }
+    } else {
+      multiline.push(`${spaces}${key}: ${strValue}`);
+    }
+  }
+  return multiline.join("\n");
+}
 
 function parseOptions(value) {
   const defOptions = {
@@ -313,6 +447,7 @@ function parseOptions(value) {
     numericSeparator: false,
     ignore: "hostname,pid",
     colorize: true,
+    inspect: "compact",
     types: {
       number: { color: "green" },
       boolean: { color: "redBright" },
@@ -342,13 +477,15 @@ function parseOptions(value) {
     ...opts,
     sw,
     colorFallback: createColorizeFn(opts.colorize, "gray"),
-    inspect: {
+    inspectFn: opts.inspect === "regular" ? inspectRegular : opts.inspect === "compact" ? inspectCompact : isFunction(opts.inspect) ? opts.inspect : inspectRegular,
+    inspectOptions: {
       depth: opts.depth,
       quoteStyle: opts.quoteStyle,
       indent: opts.indent,
       maxStringLength: opts.maxStringLength,
       numericSeparator: opts.numericSeparator,
-      customStringify: {}
+      customStringify: {},
+      columns: opts.columns
     },
     levels: Object.fromEntries(
       Object.entries(opts.levels).map(([key, value2]) => [
@@ -382,10 +519,11 @@ function parseOptions(value) {
       opts.ignore.split(",").map((v) => v.trim()).filter(Boolean)
     )
   };
-  result.inspect.customStringify = {
+  result.inspectOptions.customStringify = {
     number: result.types.number.color,
     boolean: result.types.boolean.color,
-    string: result.types.string.color
+    string: result.types.string.color,
+    stringRemaining: result.colorFallback
   };
   return result;
 }
@@ -488,20 +626,16 @@ function formatAdditional(obj, opts) {
     for (const key in obj) {
       empty = false;
       if (isSerializedError(obj[key])) {
-        additional[key] = {
-          ...obj[key],
-          [inspect$1.custom]: () => formatError(obj[key], 0, opts)
-        };
-      } else {
-        additional[key] = obj[key];
+        def(obj[key], inspect.custom, () => formatError(obj[key], 0, opts));
       }
+      additional[key] = obj[key];
     }
   }
   if (empty) {
     return "";
   }
   const colorizeObject = opts.types.object?.color || opts.colorFallback;
-  return colorizeObject(inspect(additional, opts.inspect).slice(2, -2));
+  return colorizeObject(opts.inspectFn(additional, opts.inspectOptions));
 }
 function pretty(logObj) {
   const opts = this;
@@ -535,12 +669,22 @@ function build(opts = {}) {
         messageKey: source.messageKey || "msg",
         ...opts
       });
+      var extraLine = false;
+      var line;
       const stream = new Transform({
         objectMode: true,
         autoDestroy: true,
         transform(chunk, enc, cb) {
-          const line = pretty2(chunk);
-          cb(null, line + "\n");
+          line = pretty2(chunk);
+          if (line.endsWith("\n")) {
+            extraLine = true;
+          } else if (extraLine) {
+            line = "\n" + line + "\n";
+            extraLine = false;
+          } else {
+            line = line + "\n";
+          }
+          cb(null, line);
         }
       });
       destination = buildSafeSonicBoom({
@@ -549,8 +693,8 @@ function build(opts = {}) {
         mkdir: true,
         sync: false
       });
-      source.on("unknown", function(line) {
-        destination.write(line + "\n");
+      source.on("unknown", function(line2) {
+        destination.write(line2 + "\n");
       });
       pump(source, stream, destination);
       return stream;