@darksheep/logger 1.0.6 → 1.0.8

package/src/utilities/colour.js

@@ -28,18 +28,18 @@ const BACKGROUND = 4;
 
 /**
  * @typedef {Object} ColourOptions
- * @property {ColourNames} [foreground] The foreground colour name
- * @property {ColourMode} [foregroundMode] The foreground colour mode
- * @property {ColourNames} [background] The background colour name
- * @property {ColourMode} [backgroundMode] The background colour mode
- * @property {ColourEffects[]} [effects] The string effents
- * @property {boolean | Omit<ColourOptions, 'reset'>} [reset] How to handle the string termination
+ * @property {ColourNames} [foreground] - The foreground colour name.
+ * @property {ColourMode} [foregroundMode] - The foreground colour mode.
+ * @property {ColourNames} [background] - The background colour name.
+ * @property {ColourMode} [backgroundMode] - The background colour mode.
+ * @property {ColourEffects[]} [effects] - The string effents.
+ * @property {boolean | Omit<ColourOptions, 'reset'>} [reset] - How to handle the string termination.
  */
 
 /**
- * @param {ColourNames} colour  [description]
- * @param {typeof FOREGROUND | typeof BACKGROUND} base  [description]
- * @param {ColourMode} [mode]  [description]
+ * @param {ColourNames} colour - [description].
+ * @param {typeof FOREGROUND | typeof BACKGROUND} base - [description].
+ * @param {ColourMode} [mode] - [description].
  * @returns {{ colour: typeof colours[ColourNames], mode: number }}
  */
 function getColour(colour, base, mode) {
@@ -59,7 +59,7 @@ function getColour(colour, base, mode) {
 }
 
 /**
- * @param {ColourOptions} options How to colour the string
+ * @param {ColourOptions} options - How to colour the string.
  * @returns {{ prefix: string[], suffix: string[] }}
  */
 function computeColours(options) {
@@ -74,8 +74,8 @@ function computeColours(options) {
     );
 
     if (colour != null) {
-      prefix.add(`\x1B[${mode}${colour}m`);
-      suffix.add(`\x1B[${FOREGROUND}9m`);
+      prefix.add(`\u001B[${mode}${colour}m`);
+      suffix.add(`\u001B[${FOREGROUND}9m`);
     }
   }
 
@@ -87,8 +87,8 @@ function computeColours(options) {
     );
 
     if (colour != null) {
-      prefix.add(`\x1B[${mode}${colour}m`);
-      suffix.add(`\x1B[${BACKGROUND}9m`);
+      prefix.add(`\u001B[${mode}${colour}m`);
+      suffix.add(`\u001B[${BACKGROUND}9m`);
     }
   }
 
@@ -96,8 +96,8 @@ function computeColours(options) {
     for (const effect of options.effects) {
       if (Object.hasOwn(effects, effect)) {
         const [ start, end ] = effects[effect];
-        prefix.add(`\x1B[${start}m`);
-        suffix.add(`\x1B[2${end}m`);
+        prefix.add(`\u001B[${start}m`);
+        suffix.add(`\u001B[2${end}m`);
       }
     }
   }
@@ -109,7 +109,7 @@ function computeColours(options) {
 }
 
 /**
- * Should colours be used in the output
+ * Should colours be used in the output.
  * @returns {boolean}
  */
 export function shouldColour() {
@@ -124,9 +124,9 @@ export function shouldColour() {
 }
 
 /**
- * Colour a string
- * @param {string} string The string to colour
- * @param {ColourOptions} options The options to use to colour the string
+ * Colour a string.
+ * @param {string} string - The string to colour.
+ * @param {ColourOptions} options - The options to use to colour the string.
  * @returns {string}
  */
 export function colourString(string, options) {

package/src/utilities/environment.js

@@ -25,7 +25,7 @@ export const environment = {
   isProduction: NODE_ENV === 'production',
 
   logLevel: parseLogLevel(LOG_LEVEL, NODE_ENV),
-  logFilters: parseFilters(LOG_FILTERS, [ /.*/ ]),
+  logFilters: parseFilters(LOG_FILTERS, [ /.*/u ]),
   secretFilters: parseFilters(LOG_SECRETS),
   includeCallsite: LOG_CALLSITES,
   stringMaxLength: LOG_MAX_LENGTH,

package/src/utilities/json-path.js

@@ -1,15 +1,15 @@
 /**
- * @param {string} path The json path component to escape
+ * @param {string} path - The json path component to escape.
  * @returns {string}
  */
 function jsonPathEscape(path) {
   return path
-    .replace(/\b~/g, '~0')
-    .replace(/\//g, '~1');
+    .replaceAll(/\b~/gu, '~0')
+    .replaceAll('/', '~1');
 }
 
 /**
- * @param {string[]} nodes The nodes to the element
+ * @param {string[]} nodes - The nodes to the element.
  * @returns {string}
  */
 export function nodesToPath(nodes) {

package/src/utilities/last-callsite.js

@@ -1,7 +1,7 @@
 import { parseStack } from './stacktrace.js';
 
 /**
- * Get the callsite that we think is outside the package
+ * Get the callsite that we think is outside the package.
  * @returns {{ file: string, line: number, column: number } | void}
  */
 export function getLastCallsite() {

package/src/utilities/log-filters.js

@@ -1,8 +1,8 @@
 import { environment } from './environment.js';
 
 /**
- * Check to see if {loggerLevel} should get logged
- * @param {import('./log-types.js').LogLevel} level The log level to check
+ * Check to see if {loggerLevel} should get logged.
+ * @param {import('./log-types.js').LogLevel} level - The log level to check.
  * @returns {boolean}
  */
 export function checkLogLevel(level) {
@@ -10,8 +10,8 @@ export function checkLogLevel(level) {
 }
 
 /**
- * Check to see if a message with {channel} should get logged
- * @param {string} [channel] The channel to check
+ * Check to see if a message with {channel} should get logged.
+ * @param {string} [channel] - The channel to check.
  * @returns {boolean}
  */
 export function checkLogFilters(channel = '') {

package/src/utilities/log-types.js

@@ -1,12 +1,12 @@
 /**
  * @typedef {Object} LogLevels
- * @property {0} critical A crucial part of the application is not working
- * @property {1} error A non critical operation fails
- * @property {2} warning An operation might fail in the future
- * @property {3} notice Information about events that may be unusual
- * @property {4} info Information about successful operations
- * @property {5} debug Information that is unlikely to help in production
- * @property {6} silly Information to help resolve complex logic issues
+ * @property {0} critical - A crucial part of the application is not working.
+ * @property {1} error - A non critical operation fails.
+ * @property {2} warning - An operation might fail in the future.
+ * @property {3} notice - Information about events that may be unusual.
+ * @property {4} info - Information about successful operations.
+ * @property {5} debug - Information that is unlikely to help in production.
+ * @property {6} silly - Information to help resolve complex logic issues.
  */
 /** @type {LogLevels} */
 export const LogLevels = {
@@ -31,13 +31,13 @@ export const LogNames = Object.fromEntries(
 
 /**
  * @typedef {Object} LogInternal
- * @property {Date} [timestamp] A timestamp for the log message
- * @property {string} [channel] A channel to bind to the log
- * @property {LogLevel} [level] The log level
- * @property {string} [message] A message to use
- * @property {string | Callsite[]} [stack] The stack trace bound to the log
- * @property {NormalisedError | Error} [cause] A child error for the core error
- * @property {string} [trail] The trail id bound to the callsite
+ * @property {Date} [timestamp] - A timestamp for the log message.
+ * @property {string} [channel] - A channel to bind to the log.
+ * @property {LogLevel} [level] - The log level.
+ * @property {string} [message] - A message to use.
+ * @property {string | Callsite[]} [stack] - The stack trace bound to the log.
+ * @property {NormalisedError | Error} [cause] - A child error for the core error.
+ * @property {string} [trail] - The trail id bound to the callsite.
  */
 
 /**

package/src/utilities/parse-filters.js

@@ -1,10 +1,10 @@
-const matcher = /^(-?)(?!-)(.+)$/;
-const oneLevelWildcard = /(?:(?!\.).)*/;
-const multiLevelWildcard = /.*/;
+const matcher = /^(?<type>-?)(?!-)(?<channel>.+)$/u;
+const oneLevelWildcard = /(?:(?!\.).)*/u;
+const multiLevelWildcard = /.*/u;
 
 /**
- * @param {string} [filter] The filter string
- * @param {RegExp[]} [fallback] Fallback to the following allowed regexp
+ * @param {string} [filter] - The filter string.
+ * @param {RegExp[]} [fallback] - Fallback to the following allowed regexp.
  * @returns {{ allowed: RegExp[], blocked: RegExp[] }}
  */
 export function parseFilters(filter = '', fallback = []) {
@@ -14,19 +14,24 @@ export function parseFilters(filter = '', fallback = []) {
   const blocked = [];
 
   for (const filter of filters) {
-    const [ , type, channel ] = filter.match(matcher) ?? [];
+    const match = matcher.exec(filter);
+    if (match?.groups == null) {
+      continue;
+    }
+
+    const { channel, type } = match.groups;
 
     if (channel == null || channel === '') {
       continue;
     }
 
     let regex = channel
-      .replace(/[\s#$()*+,.?[\\\]^{|}-]/g, '\\$&')
-      .replace(/\\\*/g, multiLevelWildcard.source)
-      .replace(/\\\+/g, oneLevelWildcard.source);
+      .replaceAll(/[\s#$()*+,\-.?[\\\]^{|}]/gu, String.raw`\$&`)
+      .replaceAll(String.raw`\*`, multiLevelWildcard.source)
+      .replaceAll(String.raw`\+`, oneLevelWildcard.source);
 
     // Allow for multi level wildcards at the start of a filter
-    if (regex.startsWith('.*\\.')) {
+    if (regex.startsWith(String.raw`.*\.`)) {
       regex = `(?:.*\\.)?${regex.slice(4)}`;
     }
 

package/src/utilities/parse-log-level.js

@@ -1,23 +1,23 @@
 import { LogLevels } from './log-types.js';
 
 /**
- * Convert a given string to a LogLevel
- * @param {string} [input] The string to convert
- * @param {string} [node] The current NODE_ENV
+ * Convert a given string to a LogLevel.
+ * @param {string} [input] - The string to convert.
+ * @param {string} [node] - The current NODE_ENV.
  * @returns {import('./log-types.js').LogLevel}
  */
 export function parseLogLevel(input, node) {
   switch (input) {
-    case 'crit': return LogLevels.critical;
-    case 'critical': return LogLevels.critical;
-    case 'error': return LogLevels.error;
-    case 'warn': return LogLevels.warning;
-    case 'warning': return LogLevels.warning;
-    case 'notice': return LogLevels.notice;
-    case 'info': return LogLevels.info;
-    case 'debug': return LogLevels.debug;
-    case 'verbose': return LogLevels.debug;
-    case 'silly': return LogLevels.silly;
+    case 'crit': { return LogLevels.critical; }
+    case 'critical': { return LogLevels.critical; }
+    case 'error': { return LogLevels.error; }
+    case 'warn': { return LogLevels.warning; }
+    case 'warning': { return LogLevels.warning; }
+    case 'notice': { return LogLevels.notice; }
+    case 'info': { return LogLevels.info; }
+    case 'debug': { return LogLevels.debug; }
+    case 'verbose': { return LogLevels.debug; }
+    case 'silly': { return LogLevels.silly; }
   }
 
   if (node === 'development') {

package/src/utilities/stacktrace.js

@@ -4,17 +4,17 @@ import { parse } from 'stacktrace-parser';
 
 /**
  * @typedef {Object} Callsite
- * @property {string} file The file name for the callsite
- * @property {string} [relativePath] The relative path for the callsite.file
- * @property {string} [absolutePath] The absolute path for the callsite.file
- * @property {string} methodName The methodName from the callsite
- * @property {number} line The line number in the file
- * @property {number} column The column number in the file
+ * @property {string} file - The file name for the callsite.
+ * @property {string} [relativePath] - The relative path for the callsite.file.
+ * @property {string} [absolutePath] - The absolute path for the callsite.file.
+ * @property {string} methodName - The methodName from the callsite.
+ * @property {number} line - The line number in the file.
+ * @property {number} column - The column number in the file.
  */
 
 /**
- * Get the callsite that we think is outside the package
- * @param {string} [stack] The stacktrace to parse
+ * Get the callsite that we think is outside the package.
+ * @param {string} [stack] - The stacktrace to parse.
  * @returns {Callsite[]}
  */
 export function parseStack(stack) {

package/types/assert.zod.d.ts

@@ -1,16 +1,16 @@
 /**
- * @param {unknown} input  The input to convert to a zod schema
+ * @param {unknown} input - The input to convert to a zod schema.
  * @returns {ZodType}
  */
 export function convertToZod(input: unknown): ZodType;
 /**
- * @param {unknown} input The input object test with
+ * @param {unknown} input - The input object test with.
  * @returns {ZodType}
  */
 export function objectContaining(input: unknown): ZodType;
 /**
- * @param {unknown} actual The value we're testing
- * @param {unknown} expected The schema we're testing against
+ * @param {unknown} actual - The value we're testing.
+ * @param {unknown} expected - The schema we're testing against.
  * @returns {void}
  */
 export function assertSchema(actual: unknown, expected: unknown): void;

package/types/create-logger.d.ts

@@ -1,5 +1,5 @@
 /**
- * @param {string} [channel] The logging channel
+ * @param {string} [channel] - The logging channel.
  * @returns {import('./logger.js').Logger}
  */
 export function createLogger(channel?: string | undefined): import("./logger.js").Logger;

package/types/formatters/formatter-console.d.ts

@@ -1,5 +1,5 @@
 /**
- * @param {LogEntry} logEntry the Log entry which we're going to convert to a splatted string
+ * @param {LogEntry} logEntry - The Log entry which we're going to convert to a splatted string.
  * @returns {string}
  */
 export function formatterConsole(logEntry: LogEntry): string;

package/types/formatters/formatter-json.d.ts

@@ -1,5 +1,5 @@
 /**
- * @param {import('../utilities/log-types.js').LogEntry} logEntry the Log entry which we're going to convert to JSON
+ * @param {import('../utilities/log-types.js').LogEntry} logEntry - The Log entry which we're going to convert to JSON.
  * @returns {string}
  */
 export function formatterJson(logEntry: import("../utilities/log-types.js").LogEntry): string;

package/types/logger.d.ts

@@ -1,149 +1,149 @@
 /**
  * @typedef {Object} Options
- * @property {typeof replace} [replace] The replacer function to use
- * @property {import('./replacer.js').Replacer<any, any>[]} [replacers] The replacers to use in the replacer
- * @property {typeof formatter} [format] The formatter function to use (eg console or json formatter)
- * @property {typeof stdoutWrite} [write] The place to write the log to
+ * @property {typeof replace} [replace] - The replacer function to use.
+ * @property {import('./replacer.js').Replacer<any, any>[]} [replacers] - The replacers to use in the replacer.
+ * @property {typeof formatter} [format] - The formatter function to use (eg console or json formatter).
+ * @property {typeof stdoutWrite} [write] - The place to write the log to.
  */
 export class Logger {
     /** @type {AsyncLocalStorage<import('./utilities/log-types.js').LogContext[]>} */
     static storage: AsyncLocalStorage<import("./utilities/log-types.js").LogContext[]>;
     /**
-     * @param {import('./utilities/log-types.js').LogContext} context Context to bind ot the async context
+     * @param {import('./utilities/log-types.js').LogContext} context - Context to bind ot the async context.
      * @returns {void}
      */
     static addAsyncContext(context: import("./utilities/log-types.js").LogContext): void;
     /**
      * @template [R=unknown]
      * @overload
-     * @param {() => R} callback The function to wrap the context in
+     * @param {() => R} callback - The function to wrap the context in.
      * @returns {R}
      */
     static wrap<R = unknown>(callback: () => R): R;
     /**
      * @template [R=unknown]
      * @overload
-     * @param {import('./utilities/log-types.js').LogContext} context Context to bind ot the async context
-     * @param {() => R} callback The function to wrap the context in
+     * @param {import('./utilities/log-types.js').LogContext} context - Context to bind ot the async context.
+     * @param {() => R} callback - The function to wrap the context in.
      * @returns {R}
      */
     static wrap<R = unknown>(context: import("./utilities/log-types.js").LogContext, callback: () => R): R;
     /**
-     * @param {import('./utilities/log-types.js').LogContext} [context] Context to add to the logger
-     * @param {Options} [options] Options for the loggers output
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Context to add to the logger.
+     * @param {Options} [options] - Options for the loggers output.
      */
     constructor(context?: import("./utilities/log-types.js").LogContext | undefined, options?: Options | undefined);
     /** @type {import('./replacer.js').Replacer[]} */
     replacers: import("./replacer.js").Replacer[];
     /**
-     * Set the channel in the new logger
-     * @param {string} channel The channel name
+     * Set the channel in the new logger.
+     * @param {string} channel - The channel name.
      * @returns {Logger}
      */
     channel(channel: string): Logger;
     /**
-     * Creating a new logger with {context, ...this.context}
+     * Creating a new logger with {context, ...this.context}.
      * @overload
-     * @param {import('./utilities/log-types.js').LogContext} context The new context
+     * @param {import('./utilities/log-types.js').LogContext} context - The new context.
      * @returns {Logger}
      */
     context(context: import("./utilities/log-types.js").LogContext): Logger;
     /**
-     * Creating a new logger with {context, ...this.context}
+     * Creating a new logger with {context, ...this.context}.
      * @overload
-     * @param {import('./utilities/log-types.js').LogContext} context The new context
-     * @param {import('./utilities/log-types.js').LogLevel} level The log level at which we allow this context
+     * @param {import('./utilities/log-types.js').LogContext} context - The new context.
+     * @param {import('./utilities/log-types.js').LogLevel} level - The log level at which we allow this context.
      * @returns {Logger}
      */
     context(context: import("./utilities/log-types.js").LogContext, level: import("./utilities/log-types.js").LogLevel): Logger;
     /**
-     * Creating a new logger with {context, ...this.context}
+     * Creating a new logger with {context, ...this.context}.
      * @overload
-     * @param {import('./utilities/log-types.js').LogLevel} level The log level at which we allow this context
-     * @param {import('./utilities/log-types.js').LogContext} context The new context
+     * @param {import('./utilities/log-types.js').LogLevel} level - The log level at which we allow this context.
+     * @param {import('./utilities/log-types.js').LogContext} context - The new context.
      * @returns {Logger}
      */
     context(level: import("./utilities/log-types.js").LogLevel, context: import("./utilities/log-types.js").LogContext): Logger;
     /**
-     * Write a log with the level 'critical' - A crucial part of the application is not working
+     * Write a log with the level 'critical' - A crucial part of the application is not working.
      *
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Additional context
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
      * @returns {void}
      */
     critical(message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
     /**
-     * Write a log with the level 'debug' - Information that is unlikely to help in production
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Additional context
+     * Write a log with the level 'debug' - Information that is unlikely to help in production.
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
      * @returns {void}
      */
     debug(message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
     /**
-     * Write a log with the level 'error' - A non critical operation fails
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Additional context
+     * Write a log with the level 'error' - A non critical operation fails.
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
      * @returns {void}
      */
     error(message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
     /**
-     * Get a value from the context by key
-     * @param {string} key The key to get from the context
+     * Get a value from the context by key.
+     * @param {string} key - The key to get from the context.
      * @returns {unknown}
      */
     get(key: string): unknown;
     /**
-     * Write a log with the level 'info' - Information about successful operations
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Additional context
+     * Write a log with the level 'info' - Information about successful operations.
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
      * @returns {void}
      */
     info(message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
     /**
-     * Write a log with the level 'notice' - Information about events that may be unusual
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Additional context
+     * Write a log with the level 'notice' - Information about events that may be unusual.
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
      * @returns {void}
      */
     notice(message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
     /**
-     * Set a value into a new context by key
-     * @param {string} key The key to set
-     * @param {unknown} value The value to set
+     * Set a value into a new context by key.
+     * @param {string} key - The key to set.
+     * @param {unknown} value - The value to set.
      * @returns {Logger}
      */
     set(key: string, value: unknown): Logger;
     /**
-     * Write a log with the level 'silly' - Information to help resolve complex logic issues
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Additional context
+     * Write a log with the level 'silly' - Information to help resolve complex logic issues.
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
      * @returns {void}
      */
     silly(message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
     /**
-     * Set the trail in the new logger
-     * @param {string} [trail] The trail id
+     * Set the trail in the new logger.
+     * @param {string} [trail] - The trail id.
      * @returns {Logger}
      */
     trail(trail?: string | undefined): Logger;
     /**
-     * Write a log with the level 'warning' - An operation might fail in the future
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Additional context
+     * Write a log with the level 'warning' - An operation might fail in the future.
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
      * @returns {void}
      */
     warning(message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
     /**
      * @template [R=unknown]
-     * @param {() => R} callback The function to wrap the context in
+     * @param {() => R} callback - The function to wrap the context in.
      * @returns {R}
      */
     wrap<R = unknown>(callback: () => R): R;
     /**
-     * Write a new log entry
-     * @param {import('./utilities/log-types.js').LogLevel} level the log level of the message to log
-     * @param {Error | string} message The message to log
-     * @param {import('./utilities/log-types.js').LogContext} [context] Context to add to the log (merged with this.context, and Logger.contexts)
+     * Write a new log entry.
+     * @param {import('./utilities/log-types.js').LogLevel} level - The log level of the message to log.
+     * @param {Error | string} message - The message to log.
+     * @param {import('./utilities/log-types.js').LogContext} [context] - Context to add to the log (merged with this.context, and Logger.contexts).
      * @returns {void}
      */
     write(level: import("./utilities/log-types.js").LogLevel, message: Error | string, context?: import("./utilities/log-types.js").LogContext | undefined): void;
@@ -151,22 +151,23 @@ export class Logger {
 }
 export type Options = {
     /**
-     * The replacer function to use
+     * - The replacer function to use.
      */
-    replace?: typeof replace | undefined;
+    replace?: typeof replace;
     /**
-     * The replacers to use in the replacer
+     * - The replacers to use in the replacer.
      */
-    replacers?: import("./replacer.js").Replacer<any, any>[] | undefined;
+    replacers?: import("./replacer.js").Replacer<any, any>[];
     /**
-     * The formatter function to use (eg console or json formatter)
+     * - The formatter function to use (eg console or json formatter).
      */
-    format?: import("./formatter.js").Formatter | undefined;
+    format?: typeof formatter;
     /**
-     * The place to write the log to
+     * - The place to write the log to.
      */
-    write?: typeof stdoutWrite | undefined;
+    write?: typeof stdoutWrite;
 };
 import { AsyncLocalStorage } from 'node:async_hooks';
 import { replace } from './replacer.js';
+import { formatter } from './formatter.js';
 import { stdoutWrite } from './stdout-write.js';

package/types/replacer.d.ts

@@ -2,32 +2,32 @@
  * @template [T=unknown]
  * @template [O=unknown]
  * @typedef {Object} Replacer
- * @property {string} name The name of the replacer
- * @property {(input: unknown, path?: string[]) => boolean} shouldReplace Check to see if input can be replaced
- * @property {(input: T, path?: string[]) => O} replace The replace function if shouldReplace returns true
- * @property {boolean} [stopHere] Should the traverse stop here
+ * @property {string} name - The name of the replacer.
+ * @property {(input: unknown, path?: string[]) => boolean} shouldReplace - Check to see if input can be replaced.
+ * @property {(input: T, path?: string[]) => O} replace - The replace function if shouldReplace returns true.
+ * @property {boolean} [stopHere] - Should the traverse stop here.
  */
 /**
- * @param {unknown} object The object we're replacing
- * @param {Replacer[]} replacers The Replacer array to execute
+ * @param {unknown} object - The object we're replacing.
+ * @param {Replacer[]} replacers - The Replacer array to execute.
  * @returns {unknown}
  */
 export function replace(object: unknown, replacers?: Replacer[]): unknown;
 export type Replacer<T = unknown, O = unknown> = {
     /**
-     * The name of the replacer
+     * - The name of the replacer.
      */
     name: string;
     /**
-     * Check to see if input can be replaced
+     * - Check to see if input can be replaced.
      */
     shouldReplace: (input: unknown, path?: string[]) => boolean;
     /**
-     * The replace function if shouldReplace returns true
+     * - The replace function if shouldReplace returns true.
      */
     replace: (input: T, path?: string[]) => O;
     /**
-     * Should the traverse stop here
+     * - Should the traverse stop here.
      */
-    stopHere?: boolean | undefined;
+    stopHere?: boolean;
 };