@darksheep/logger 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.0.6](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.0.5...logger-v1.0.6) (2024-09-13)
+
+
+### 📦 Dependencies
+
+* **pkg:** update dependency traverse to v0.6.10 ([#369](https://github.com/DarkSheepSoftware/node-packages/issues/369)) ([ba540ec](https://github.com/DarkSheepSoftware/node-packages/commit/ba540ecb9e5e7b2fd372cf310382c13f1a05c7db))
+
+## [1.0.5](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.0.4...logger-v1.0.5) (2024-09-03)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @darksheep/environment bumped from 3.0.7 to 3.0.8
+
 ## [1.0.4](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.0.3...logger-v1.0.4) (2024-08-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darksheep/logger",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Logging your stuff to where ever you want it",
   "license": "UNLICENCED",
   "type": "module",
@@ -22,16 +22,16 @@
     "test:watch": "node --watch --test src/**/*.test.js"
   },
   "dependencies": {
-    "@darksheep/environment": "3.0.7",
+    "@darksheep/environment": "3.0.8",
     "deepmerge-ts": "7.1.0",
     "stacktrace-parser": "0.1.10",
-    "traverse": "0.6.9"
+    "traverse": "0.6.10"
   },
   "devDependencies": {
     "@types/node": "~20.16.0",
     "@types/traverse": "~0.6.33",
     "nock": "~13.5.0",
-    "typescript": "~5.5.0",
+    "typescript": "~5.6.0",
     "zod": "~3.23.0"
   },
   "engines": {

package/types/logger.d.ts

@@ -150,30 +150,18 @@ export class Logger {
     #private;
 }
 export type Options = {
-    /**
-     * The replacer function to use
-     */
     /**
      * The replacer function to use
      */
     replace?: typeof replace | undefined;
-    /**
-     * The replacers to use in the replacer
-     */
     /**
      * The replacers to use in the replacer
      */
     replacers?: import("./replacer.js").Replacer<any, any>[] | undefined;
-    /**
-     * 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;
-    /**
-     * The place to write the log to
-     */
     /**
      * The place to write the log to
      */

package/types/replacer.d.ts

@@ -14,30 +14,18 @@
  */
 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
      */

package/types/replacers/error.d.ts

@@ -10,23 +10,14 @@
 /** @type {import('../replacer.js').Replacer<Error, NormalisedError>} */
 export const ErrorReplacer: import("../replacer.js").Replacer<Error, NormalisedError>;
 export type BaseError = {
-    /**
-     * The error type or name
-     */
     /**
      * The error type or name
      */
     type: string;
-    /**
-     * The error message
-     */
     /**
      * The error message
      */
     message: string;
-    /**
-     * The stacktrace of the error
-     */
     /**
      * The stacktrace of the error
      */

package/types/utilities/colour.d.ts

@@ -14,44 +14,26 @@ export type ColourNames = keyof typeof colours;
 export type ColourMode = "bright" | "dim";
 export type ColourEffects = keyof typeof effects;
 export type ColourOptions = {
-    /**
-     * The foreground colour name
-     */
     /**
      * The foreground colour name
      */
     foreground?: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | undefined;
-    /**
-     * The foreground colour mode
-     */
     /**
      * The foreground colour mode
      */
     foregroundMode?: ColourMode | undefined;
-    /**
-     * The background colour name
-     */
     /**
      * The background colour name
      */
     background?: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | undefined;
-    /**
-     * The background colour mode
-     */
     /**
      * The background colour mode
      */
     backgroundMode?: ColourMode | undefined;
-    /**
-     * The string effents
-     */
     /**
      * The string effents
      */
     effects?: ("bold" | "faint" | "italic" | "underline")[] | undefined;
-    /**
-     * How to handle the string termination
-     */
     /**
      * How to handle the string termination
      */

package/types/utilities/log-types.d.ts

@@ -1,49 +1,28 @@
 export type LogLevels = {
-    /**
-     * A crucial part of the application is not working
-     */
     /**
      * A crucial part of the application is not working
      */
     critical: 0;
-    /**
-     * A non critical operation fails
-     */
     /**
      * A non critical operation fails
      */
     error: 1;
-    /**
-     * An operation might fail in the future
-     */
     /**
      * An operation might fail in the future
      */
     warning: 2;
-    /**
-     * Information about events that may be unusual
-     */
     /**
      * Information about events that may be unusual
      */
     notice: 3;
-    /**
-     * Information about successful operations
-     */
     /**
      * Information about successful operations
      */
     info: 4;
-    /**
-     * Information that is unlikely to help in production
-     */
     /**
      * Information that is unlikely to help in production
      */
     debug: 5;
-    /**
-     * Information to help resolve complex logic issues
-     */
     /**
      * Information to help resolve complex logic issues
      */
@@ -69,51 +48,30 @@ export type LogLevel = LogLevels[LogLevelNames];
 export type Callsite = import("./stacktrace.js").Callsite;
 export type NormalisedError = import("../replacers/error.js").NormalisedError;
 export type LogInternal = {
-    /**
-     * A timestamp for the log message
-     */
     /**
      * A timestamp for the log message
      */
     timestamp?: Date | undefined;
-    /**
-     * A channel to bind to the log
-     */
     /**
      * A channel to bind to the log
      */
     channel?: string | undefined;
-    /**
-     * The log level
-     */
     /**
      * The log level
      */
     level?: LogLevel | undefined;
-    /**
-     * A message to use
-     */
     /**
      * A message to use
      */
     message?: string | undefined;
-    /**
-     * The stack trace bound to the log
-     */
     /**
      * The stack trace bound to the log
      */
     stack?: string | import("./stacktrace.js").Callsite[] | undefined;
-    /**
-     * A child error for the core error
-     */
     /**
      * A child error for the core error
      */
     cause?: Error | import("../replacers/error.js").NormalisedError | undefined;
-    /**
-     * The trail id bound to the callsite
-     */
     /**
      * The trail id bound to the callsite
      */

package/types/utilities/stacktrace.d.ts

@@ -14,44 +14,26 @@
  */
 export function parseStack(stack?: string | undefined): Callsite[];
 export type Callsite = {
-    /**
-     * The file name for the callsite
-     */
     /**
      * The file name for the callsite
      */
     file: string;
-    /**
-     * The relative path for the callsite.file
-     */
     /**
      * The relative path for the callsite.file
      */
     relativePath?: string | undefined;
-    /**
-     * The absolute path for the callsite.file
-     */
     /**
      * The absolute path for the callsite.file
      */
     absolutePath?: string | undefined;
-    /**
-     * The methodName from the callsite
-     */
     /**
      * The methodName from the callsite
      */
     methodName: string;
-    /**
-     * The line number in the file
-     */
     /**
      * The line number in the file
      */
     line: number;
-    /**
-     * The column number in the file
-     */
     /**
      * The column number in the file
      */