@likec4/log 1.44.0 → 1.45.0

package/dist/index.d.mts

@@ -14,6 +14,41 @@ declare function getConsoleSink(options?: ConsoleSinkOptions): Sink;
 declare function getConsoleStderrSink(options?: ConsoleSinkOptions): Sink;
 
 declare function loggable(error: unknown): string;
+type NormalizeError<ErrorArg> = ErrorArg extends Error ? ErrorArg : Error;
+/**
+ * Appends `message` to `error.message`. If `message` ends with `:` or `:\n`,
+ * prepends it instead.
+ *
+ * Returns `error`. If `error` is not an `Error` instance, it is converted to
+ * one.
+ *
+ * @example
+ * ```js
+ * wrapErrorMessage(new Error('Message.'), 'Additional message.')
+ * // Error: Message.
+ * // Additional message.
+ *
+ * wrapErrorMessage(new Error('Message.'), 'Additional message:')
+ * // Error: Additional message: Message.
+ *
+ * wrapErrorMessage(new Error('Message.'), 'Additional message:\n')
+ * // Error: Additional message:
+ * // Message.
+ *
+ * wrapErrorMessage(new Error('Message.'), '')
+ * // Error: Message.
+ *
+ * const invalidError = 'Message.'
+ * wrapErrorMessage(invalidError, 'Additional message.')
+ * // Error: Message.
+ * // Additional message.
+ *
+ * wrapErrorMessage(new Error('  Message with spaces  '), '  Additional message  ')
+ * // Error: Message with spaces
+ * // Additional message
+ * ```
+ */
+declare function wrapError<ErrorArg>(error: ErrorArg, newMessage: string): NormalizeError<ErrorArg>;
 
 declare const logger: _logtape_logtape.Logger;
 
@@ -26,4 +61,4 @@ declare const logger: _logtape_logtape.Logger;
 declare function createLogger(subcategory: string | readonly [string] | readonly [string, ...string[]]): _logtape_logtape.Logger;
 declare function configureLogger<TSinkId extends string, TFilterId extends string>(config?: Partial<Config<TSinkId, TFilterId>>): void;
 
-export { configureLogger, logger as consola, createLogger, errorFromLogRecord, getAnsiColorFormatter, getConsoleSink, getConsoleStderrSink, getMessageOnlyFormatter, getTextFormatter, loggable, logger, logger as rootLogger };
+export { configureLogger, logger as consola, createLogger, errorFromLogRecord, getAnsiColorFormatter, getConsoleSink, getConsoleStderrSink, getMessageOnlyFormatter, getTextFormatter, loggable, logger, logger as rootLogger, wrapError };

package/dist/index.mjs

@@ -1302,14 +1302,23 @@ function loggable(error) {
   }
   return safeStringify(error, { indentation: "	" });
 }
+function wrapError(error, newMessage) {
+  return wrapErrorMessage(error, newMessage);
+}
 
 function gerErrorFromLogRecord(record) {
-  const errors = Object.values(record.properties).filter((v) => v instanceof Error).map((err) => {
-    const mergedErr = mergeErrorCause(err);
-    if (mergedErr.stack) {
-      mergedErr.stack = parseStack(mergedErr.stack).join("\n");
+  const errors = Object.entries(record.properties).flatMap(([k, err]) => {
+    if (err instanceof Error) {
+      const mergedErr = mergeErrorCause(err);
+      if (mergedErr.stack) {
+        mergedErr.stack = parseStack(mergedErr.stack).join("\n");
+      }
+      return [mergedErr];
+    }
+    if (k === "error" || k === "err") {
+      return [new Error(`${err}`)];
     }
-    return mergedErr;
+    return [];
   });
   if (errors.length === 0) {
     return null;
@@ -1323,7 +1332,7 @@ function errorFromLogRecord(record) {
   }
   return error;
 }
-function appendErrorToMessage(values, color) {
+function appendErrorToMessage(values, color = false) {
   const error = gerErrorFromLogRecord(values.record);
   if (error) {
     let errorMessge = error.message;
@@ -1446,4 +1455,4 @@ function configureLogger(config) {
   }
 }
 
-export { configureLogger, logger as consola, createLogger, errorFromLogRecord, getAnsiColorFormatter, getConsoleSink, getConsoleStderrSink, getMessageOnlyFormatter, getTextFormatter, loggable, logger, logger as rootLogger };
+export { configureLogger, logger as consola, createLogger, errorFromLogRecord, getAnsiColorFormatter, getConsoleSink, getConsoleStderrSink, getMessageOnlyFormatter, getTextFormatter, loggable, logger, logger as rootLogger, wrapError };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@likec4/log",
   "description": "Shared interface for logging",
   "license": "MIT",
-  "version": "1.44.0",
+  "version": "1.45.0",
   "bugs": "https://github.com/likec4/likec4/issues",
   "homepage": "https://likec4.dev",
   "author": "Denis Davydkov <denis@davydkov.com>",
@@ -38,11 +38,11 @@
     "@types/node": "~20.19.22",
     "merge-error-cause": "^5.0.2",
     "safe-stringify": "^1.2.0",
-    "std-env": "^3.9.0",
+    "std-env": "^3.10.0",
     "typescript": "5.9.3",
     "unbuild": "3.5.0",
     "wrap-error-message": "^3.0.1",
-    "@likec4/tsconfig": "1.44.0",
+    "@likec4/tsconfig": "1.45.0",
     "@likec4/devops": "1.42.0"
   },
   "scripts": {

package/src/formatters.ts

@@ -17,14 +17,19 @@ import { indent, parseStack } from './utils'
 
 function gerErrorFromLogRecord(record: LogRecord): Error | null {
   const errors = Object
-    .values(record.properties)
-    .filter((v) => v instanceof Error)
-    .map(err => {
-      const mergedErr = mergeErrorCause(err)
-      if (mergedErr.stack) {
-        mergedErr.stack = parseStack(mergedErr.stack).join('\n')
+    .entries(record.properties)
+    .flatMap(([k, err]) => {
+      if (err instanceof Error) {
+        const mergedErr = mergeErrorCause(err)
+        if (mergedErr.stack) {
+          mergedErr.stack = parseStack(mergedErr.stack).join('\n')
+        }
+        return [mergedErr]
       }
-      return mergedErr
+      if (k === 'error' || k === 'err') {
+        return [new Error(`${err}`)]
+      }
+      return []
     })
   if (errors.length === 0) {
     return null
@@ -40,7 +45,7 @@ export function errorFromLogRecord(record: LogRecord): Error | null {
   return error
 }
 
-export function appendErrorToMessage(values: FormattedValues, color?: boolean): FormattedValues {
+export function appendErrorToMessage(values: FormattedValues, color = false): FormattedValues {
   const error = gerErrorFromLogRecord(values.record)
   if (error) {
     let errorMessge = error.message

package/src/index.ts

@@ -34,7 +34,10 @@ export {
   logger as rootLogger,
 }
 
-export { loggable } from './utils'
+export {
+  loggable,
+  wrapError,
+} from './utils'
 
 /**
  * Get a child logger with the given subcategory.

package/src/utils.ts

@@ -1,5 +1,6 @@
 import mergeErrorCause from 'merge-error-cause'
 import safeStringify from 'safe-stringify'
+import wrapErrorMessage from 'wrap-error-message'
 
 export const parseStack = (stack: string): string[] => {
   const lines = stack
@@ -36,3 +37,42 @@ export function loggable(error: unknown): string {
   }
   return safeStringify(error, { indentation: '\t' })
 }
+
+type NormalizeError<ErrorArg> = ErrorArg extends Error ? ErrorArg : Error
+
+/**
+ * Appends `message` to `error.message`. If `message` ends with `:` or `:\n`,
+ * prepends it instead.
+ *
+ * Returns `error`. If `error` is not an `Error` instance, it is converted to
+ * one.
+ *
+ * @example
+ * ```js
+ * wrapErrorMessage(new Error('Message.'), 'Additional message.')
+ * // Error: Message.
+ * // Additional message.
+ *
+ * wrapErrorMessage(new Error('Message.'), 'Additional message:')
+ * // Error: Additional message: Message.
+ *
+ * wrapErrorMessage(new Error('Message.'), 'Additional message:\n')
+ * // Error: Additional message:
+ * // Message.
+ *
+ * wrapErrorMessage(new Error('Message.'), '')
+ * // Error: Message.
+ *
+ * const invalidError = 'Message.'
+ * wrapErrorMessage(invalidError, 'Additional message.')
+ * // Error: Message.
+ * // Additional message.
+ *
+ * wrapErrorMessage(new Error('  Message with spaces  '), '  Additional message  ')
+ * // Error: Message with spaces
+ * // Additional message
+ * ```
+ */
+export function wrapError<ErrorArg>(error: ErrorArg, newMessage: string): NormalizeError<ErrorArg> {
+  return wrapErrorMessage(error, newMessage)
+}