npm - @node-cli/logger - Versions diffs - 1.3.0 → 1.3.2 - Mend

@node-cli/logger 1.3.0 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -1,249 +1,384 @@
-# Node CLI Logger
+# @node-cli/logger
 ![npm](https://img.shields.io/npm/v/@node-cli/logger?label=version&logo=npm)
-> Logger is a dead-simple console logger for nodejs command-line applications.
+> A powerful, flexible console logger for Node.js command-line applications with rich formatting options and in-memory logging capabilities.
 ## Installation
 ```sh
-> cd your-project
-> npm install --save-dev @node-cli/logger
+npm install --save-dev @node-cli/logger
 ```
-2 classes are available:
+## Overview
-- `Logger` which is a facade for `console` and with added methods, such as `printBox()`
-- `Spinner` is an "elegant terminal spinner", relying behind the scenes on the excellent [ora](https://github.com/sindresorhus/ora)
+`@node-cli/logger` provides two main classes:
-## Usage
+- **`Logger`**: A versatile console logger with enhanced formatting, colors, and utility methods
+- **`Spinner`**: An elegant terminal spinner for displaying progress, based on [ora](https://github.com/sindresorhus/ora)
+## Basic Usage
+### Logger
 ```js
 import { Logger } from "@node-cli/logger";
+// Create a new logger instance
 const log = new Logger();
-log.info("this is an informational log");
-log.warn("this is a warning log");
-log.error("this is an error log");
+// Basic logging methods
+log.info("This is an informational message");
+log.warn("This is a warning message");
+log.error("This is an error message");
+log.debug("This is a debug message");
+log.log("This is a standard log message");
 ```
+### Spinner
 ```js
 import { Spinner } from "@node-cli/logger";
-const spinner = new Spinner("Updating package.json...");
-// assuming a long running process here...
-spinner.text = "Git stage and commit, please wait...";
-// assuming a long running process here...
-spinner.text = "Almost there...";
-// assuming a long running process here... returning some result
-if (result === "success") {
-	spinner.stop("Process completed successfully!");
-} else {
-	spinner.stop("Process failed miserably...", Spinner.ERROR);
-}
-```
-## API
-### Spinner methods
+// Create a new spinner with initial text
+const spinner = new Spinner("Processing files...");
-| Method      | Arguments    | Description                                                                                                                                                                                                                        |
-| ----------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| constructor | options      | Initialize a Spinner instance with [ora](https://github.com/sindresorhus/ora) options                                                                                                                                              |
-| start       | text         | Starts the spinner on the terminal and append a string to it                                                                                                                                                                       |
-| stop        | text, status | Stop the spinner, change it to a green, red, yellow or blue marker, and persist the current text, or text if provided. The argument `status` can be one of `Spinner.SUCCESS`, `Spinner.ERROR`, `Spinner.WARNING` or `Spinner.INFO` |
+// Start the spinner
+spinner.start();
-| Setter | Description                                                                         |
-| ------ | ----------------------------------------------------------------------------------- |
-| text   | Set the text of the spinner. If the spinner is stopped, the text will be persisted. |
+// Update the spinner text during a long-running process
+spinner.text = "Analyzing data...";
-### Logger methods
+// Complete the spinner with different statuses
+spinner.stop("Process completed successfully!"); // Success (default)
+// or
+spinner.stop("Process failed!", Spinner.ERROR); // Error
+// or
+spinner.stop("Process needs attention", Spinner.WARNING); // Warning
+// or
+spinner.stop("Process information", Spinner.INFO); // Info
+```
-Logger relies on `console` behind the scenes, and therefore supports the same [string substitution](https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions) capabilities and uses the following methods:
+## Advanced Logger Examples
-| Method             | Description                                               | Output color |
-| ------------------ | --------------------------------------------------------- | ------------ |
-| debug              | Outputs a message to the console with the log level debug | grey         |
-| log                | For general output of logging information.                | white        |
-| info               | Informative logging of information.                       | blue         |
-| warn               | Outputs a message to the console with the log level debug | yellow       |
-| error              | Outputs an error message.                                 | red          |
-| printBox           | Output message(s) in a box                                | custom       |
-| printErrorsAndExit | Output error message(s) and exit                          | red          |
+### Customizing Logger Output
-### Options
+```js
+// Initialize with options
+const log = new Logger({
+  boring: false, // Enable colors (default)
+  silent: false, // Enable logging (default)
+  prefix: "MyApp:", // Add a prefix to all logs
+  timestamp: true, // Add timestamps to logs
+  inMemory: false // Log to console (default)
+});
-#### Disabling logging
+// Log with different levels
+log.info("Starting application...");
+log.debug("Debug information");
+log.warn("Warning: configuration file not found");
+log.error("Error: failed to connect to database");
+// Output:
+// MyApp: [ Tue Mar 18 2025 10:30:00 AM ] Starting application...
+// MyApp: [ Tue Mar 18 2025 10:30:01 AM ] Debug information
+// MyApp: [ Tue Mar 18 2025 10:30:02 AM ] Warning: configuration file not found
+// MyApp: [ Tue Mar 18 2025 10:30:03 AM ] Error: failed to connect to database
+```
-You can disable logging with `silent`:
+### Dynamic Configuration
 ```js
-import { Logger } from "@node-cli/logger";
 const log = new Logger();
-log.info("this will be logged");
-// disabling logs in production for example
-log.silent = process.env.NODE_ENV === "production";
-log.info("but this will not");
-log.silent = false;
-log.info("this will be logged again!");
-```
+// Change configuration at runtime
+log.info("Normal colored output");
-This option can also be passed to the constructor:
+// Disable colors for test environments
+log.boring = process.env.NODE_ENV === "test";
+log.info("No colors in test environment");
-```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger({ silent: true });
+// Add a prefix for specific sections
+log.prefix = "[CONFIG]";
+log.info("Loading configuration..."); // Output: [CONFIG] Loading configuration...
-log.info("this will not be logged");
+// Add timestamps for debugging
+log.timestamp = true;
+log.debug("Detailed timing information"); // Output: [CONFIG] [ Tue Mar 18 2025 10:30:00 AM ] Detailed timing information
+// Silence logs temporarily
+log.silent = true;
+log.info("This won't be displayed");
+// Re-enable logs
 log.silent = false;
-log.info("this will be logged again!");
+log.info("Logging resumed");
 ```
-### Disabling colors
-You can disable colors with `boring`:
+### Printing Messages in a Box
 ```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger();
-log.info("this will be logged in the default [info] color");
-// disabling colors in test mode for example
-log.boring = process.env.NODE_ENV === "test";
-log.info("but this will not have any colors :/");
-log.boring = false;
-log.info("colors are back!");
+// Simple box with default options
+log.printBox("Important Message");
+/*
+┌─────────────────────┐
+│                     │
+│  Important Message  │
+│                     │
+└─────────────────────┘
+*/
+// Multiple messages in a box
+log.printBox(["Welcome to MyApp v1.2.3", "Copyright © 2025"]);
+/*
+┌──────────────────────────┐
+│                          │
+│  Welcome to MyApp v1.2.3 │
+│    Copyright © 2025      │
+│                          │
+└──────────────────────────┘
+*/
+// Customized box
+log.printBox("WARNING: Disk space low", {
+  borderColor: "red",
+  padding: 2,
+  textAlignment: "center",
+  title: "System Alert",
+  newLineAfter: true,
+  newLineBefore: true
+});
+/*
+┌─ System Alert ───────────────┐
+│                              │
+│                              │
+│    WARNING: Disk space low   │
+│                              │
+│                              │
+└──────────────────────────────┘
+*/
 ```
-This option can also be passed to the constructor:
+### Error Handling and Process Exit
 ```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger({ boring: true });
-log.info("this will not be logged in color");
-log.boring = false;
-log.info("this will be logged again!");
+// Display multiple errors and exit the process
+const errors = [
+  "Failed to connect to database",
+  "Configuration file is invalid",
+  "Required environment variables missing"
+];
+// Display errors and exit with code 1
+log.printErrorsAndExit(errors, 1);
+// Or just display errors without exiting
+log.printErrorsAndExit(errors);
 ```
-### Adding a prefix
-You can add a prefix to the logs with `prefix`:
+### In-Memory Logging
 ```js
-import { Logger } from "@node-cli/logger";
+// Create a logger that stores logs in memory instead of console
+const memoryLogger = new Logger({ inMemory: true });
+// Log messages that are stored in memory
+memoryLogger.info("Starting process");
+memoryLogger.warn("Resource usage high");
+memoryLogger.error("Process failed");
+// Retrieve all logs as a string
+const logs = memoryLogger.getMemoryLogs();
+console.log(logs);
+// Output:
+// Starting process
+// Resource usage high
+// Process failed
+// Clear memory logs when no longer needed
+memoryLogger.clearMemoryLogs();
+// Toggle between console and memory logging
 const log = new Logger();
+log.info("This goes to console");
-log.info("this will be logged with no prefix");
-log.prefix = "[INFO]";
-log.info("this will have a prefix!");
-```
+log.inMemory = true;
+log.info("This goes to memory only");
-The output of that last line would be:
+// Get only the in-memory logs
+const memLogs = log.getMemoryLogs(); // Contains only "This goes to memory only"
-```sh
-> [INFO] this will have a prefix!
+log.inMemory = false;
+log.info("Back to console logging");
 ```
-This option can also be passed to the constructor:
+## Advanced Spinner Examples
+### Spinner with Custom Options
 ```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger({ prefix: "Log:" });
+// Create a spinner with custom options
+const spinner = new Spinner({
+  text: "Processing...",
+  color: "blue",
+  spinner: "dots" // Use the 'dots' spinner pattern
+});
-log.info("this will be logged with a prefix");
-log.prefix = false;
-log.info("this will be NOT be logged with a prefix");
+spinner.start();
 ```
-### Adding a local timestamp
-You can add a timestamp to the logs with `timestamp`:
+### Spinner in Async Functions
 ```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger();
+import { Spinner } from "@node-cli/logger";
-log.info("this will be logged with no timestamp");
-log.timestamp = true;
-log.info("this will have a timestamp!");
+async function deployApplication() {
+  const spinner = new Spinner("Preparing deployment...");
+  spinner.start();
+  try {
+    // Building phase
+    spinner.text = "Building application...";
+    await buildApp();
+    // Testing phase
+    spinner.text = "Running tests...";
+    await runTests();
+    // Deployment phase
+    spinner.text = "Deploying to production...";
+    await deploy();
+    // Success
+    spinner.stop("Deployment completed successfully!");
+    return true;
+  } catch (error) {
+    // Handle failure
+    spinner.stop(`Deployment failed: ${error.message}`, Spinner.ERROR);
+    return false;
+  }
+}
 ```
-The output of that last line would look like:
+### Chaining Multiple Spinners
-```sh
-> [ Tue Feb 02 2021 8:32:58 PM ] this will have a timestamp!
+```js
+import { Spinner } from "@node-cli/logger";
+async function processWorkflow() {
+  // Step 1
+  const step1 = new Spinner("Step 1: Data validation");
+  step1.start();
+  await validateData();
+  step1.stop("Data validation complete", Spinner.SUCCESS);
+  // Step 2
+  const step2 = new Spinner("Step 2: Processing records");
+  step2.start();
+  await processRecords();
+  step2.stop("Records processed", Spinner.SUCCESS);
+  // Step 3
+  const step3 = new Spinner("Step 3: Generating report");
+  step3.start();
+  await generateReport();
+  step3.stop("Report generated", Spinner.SUCCESS);
+  console.log("Workflow completed successfully!");
+}
 ```
-This option can also be passed to the constructor:
+## API Reference
-```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger({ timestamp: true });
+### Logger Class
-log.info("this will be logged with a timestamp");
-log.timestamp = false;
-log.info("this will be NOT be logged with a timestamp");
-```
+#### Constructor Options
-### Log one or more messages in a box
+| Option      | Type    | Default | Description                             |
+| ----------- | ------- | ------- | --------------------------------------- |
+| `boring`    | boolean | `false` | Disable colors in output                |
+| `silent`    | boolean | `false` | Disable all logging                     |
+| `prefix`    | string  | `""`    | Add a prefix to all log messages        |
+| `timestamp` | boolean | `false` | Add timestamps to all log messages      |
+| `inMemory`  | boolean | `false` | Store logs in memory instead of console |
-The `printBox` method is a wrapper around the excellent [Boxen](https://github.com/sindresorhus/boxen), with sensible defaults.
+#### Methods
-```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger();
+| Method               | Arguments                                                   | Description                                            |
+| -------------------- | ----------------------------------------------------------- | ------------------------------------------------------ |
+| `log`                | `...args`                                                   | Standard log output (white)                            |
+| `info`               | `...args`                                                   | Informational log output (blue)                        |
+| `debug`              | `...args`                                                   | Debug log output (grey)                                |
+| `warn`               | `...args`                                                   | Warning log output (yellow)                            |
+| `error`              | `...args`                                                   | Error log output (red)                                 |
+| `printBox`           | `messages: string \| string[]`, `options?: PrintBoxOptions` | Display message(s) in a formatted box                  |
+| `printErrorsAndExit` | `errorMessages: string[]`, `exitStatus?: number`            | Display error messages and optionally exit the process |
+| `getMemoryLogs`      | none                                                        | Get all logs stored in memory as a string              |
+| `clearMemoryLogs`    | none                                                        | Clear all logs stored in memory                        |
-log.printBox(["Message One!", "Message Two!"]);
+#### Properties (Setters)
-┌──────────────────┐
-│                  │
-│   Message One!   │
-│   Message Two!   │
-│                  │
-└──────────────────┘
+| Property    | Type    | Description                      |
+| ----------- | ------- | -------------------------------- |
+| `silent`    | boolean | Enable/disable logging           |
+| `boring`    | boolean | Enable/disable colors            |
+| `prefix`    | string  | Set prefix for log messages      |
+| `timestamp` | boolean | Enable/disable timestamps        |
+| `inMemory`  | boolean | Enable/disable in-memory logging |
-```
+#### PrintBox Options
-`printBox` accepts the following options as a second argument:
+| Option          | Type    | Default     | Description                                      |
+| --------------- | ------- | ----------- | ------------------------------------------------ |
+| `newLineAfter`  | boolean | `true`      | Print a new line after the box                   |
+| `newLineBefore` | boolean | `true`      | Print a new line before the box                  |
+| `borderColor`   | string  | `"yellow"`  | Color of the box border                          |
+| `padding`       | number  | `1`         | Padding inside the box                           |
+| `textAlignment` | string  | `"center"`  | Text alignment (`"left"`, `"center"`, `"right"`) |
+| `title`         | string  | `undefined` | Optional title for the box                       |
-- `printLineAfter` (default to `true`)
-- `printLineBefore` (default to `true`)
-- As well as all the options available with [Boxen](https://github.com/sindresorhus/boxen)
+Plus all options from [Boxen](https://github.com/sindresorhus/boxen).
-Here is a custom example with:
+### Spinner Class
-- a red border color
-- no extra line after the box
-- no padding (no space between the border and the text)
-- text is justified to the right
-- there is a title injected at the top of the box
+#### Constructor Options
-```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger();
+Accepts all options from [ora](https://github.com/sindresorhus/ora).
-log.printBox(["Message One!", "Message Two!"], {
-	borderColor: "red",
-	newLineAfter: false,
-	padding: 0,
-	textAlignment: "right",
-	title: "Hello World Box Title",
-});
-```
+| Option    | Type             | Description                       |
+| --------- | ---------------- | --------------------------------- |
+| `text`    | string           | Text to display after the spinner |
+| `color`   | string           | Color of the spinner              |
+| `spinner` | string \| object | Spinner pattern to use            |
+| ...       | ...              | All other ora options             |
-### Log multiple errors and optionally exit the main program
+#### Methods
-The following will print 2 error messages and exit with error code 666.
-If the second parameter (a number) is not provided, the process does not exit.
+| Method  | Arguments                          | Description                                    |
+| ------- | ---------------------------------- | ---------------------------------------------- |
+| `start` | `text?: string`                    | Start the spinner with optional text           |
+| `stop`  | `text?: string`, `status?: string` | Stop the spinner with optional text and status |
-```js
-import { Logger } from "@node-cli/logger";
-const log = new Logger();
+#### Properties
-log.printErrorsAndExit(["Error One!", "Error Two!"], 666);
-```
+| Property | Type   | Description          |
+| -------- | ------ | -------------------- |
+| `text`   | string | Set the spinner text |
+#### Status Constants
+| Constant          | Value       | Description                         |
+| ----------------- | ----------- | ----------------------------------- |
+| `Spinner.SUCCESS` | `"success"` | Success status (green checkmark)    |
+| `Spinner.ERROR`   | `"fail"`    | Error status (red X)                |
+| `Spinner.WARNING` | `"warn"`    | Warning status (yellow exclamation) |
+| `Spinner.INFO`    | `"info"`    | Info status (blue i)                |
+## Environment Compatibility
+- Works with Node.js >=16
+- ESM module format
+- TypeScript definitions included
 ## License

package/dist/Logger.d.ts CHANGED Viewed

@@ -26,12 +26,12 @@ export declare class Logger {
     set timestamp(flag: boolean);
     set inMemory(flag: boolean);
     /**
-     * Get the accumulated logs as a string
+     * Get the accumulated logs as a string.
      * @returns {string} All logs joined by the separator
      */
     getMemoryLogs(): string;
     /**
-     * Clear all accumulated logs from memory
+     * Clear all accumulated logs from memory.
      */
     clearMemoryLogs(): void;
     info(...arguments_: any): void;
@@ -40,13 +40,14 @@ export declare class Logger {
     warn(...arguments_: any): void;
     error(...arguments_: any): void;
     /**
-     * Log multiple error messages at the prompt using `console.error` behind the scenes.
+     * Log multiple error messages at the prompt using `console.error` behind the
+     * scenes.
      * @param {string[]} errorMessages array of error message to display line by line
      * @param {number} [exitStatus] the process will exit with this value if provided
      */
     printErrorsAndExit(errorMessages: string[], exitStatus?: number): void;
     /**
-     * Print sets of logs in a box (wrapper to Boxen)
+     * Print sets of logs in a box (wrapper to Boxen).
      * @param messages Messages to print
      * @param options
      */

package/dist/Logger.js CHANGED Viewed

@@ -1,7 +1,7 @@
-import boxen from "boxen";
-import ora from "ora";
 import util from "node:util";
+import boxen from "boxen";
 import kleur from "kleur";
+import ora from "ora";
 export class Logger {
     #shouldLog;
     #globalPrefix;
@@ -15,7 +15,7 @@ export class Logger {
         this.#showTimestamp = timestamp;
         this.#inMemory = inMemory;
         this.#memoryLogs = [];
-        // When in memory mode, we disable colors
+        // When in memory mode, we disable colors.
         this.#printOptions = {
             colors: !boring && !inMemory,
             compact: false,
@@ -26,7 +26,7 @@ export class Logger {
         this.#shouldLog = !flag;
     }
     set boring(flag) {
-        // Only set colors if not in memory mode
+        // Only set colors if not in memory mode.
         if (!this.#inMemory) {
             this.#printOptions.colors = !flag;
         }
@@ -39,19 +39,19 @@ export class Logger {
     }
     set inMemory(flag) {
         this.#inMemory = flag;
-        // When enabling in-memory mode, disable colors
+        // When enabling in-memory mode, disable colors.
         if (flag) {
             this.#printOptions.colors = false;
         }
     }
     /**
-	 * Get the accumulated logs as a string
+	 * Get the accumulated logs as a string.
 	 * @returns {string} All logs joined by the separator
 	 */ getMemoryLogs() {
         return this.#memoryLogs.join("\n");
     }
     /**
-	 * Clear all accumulated logs from memory
+	 * Clear all accumulated logs from memory.
 	 */ clearMemoryLogs() {
         this.#memoryLogs = [];
     }
@@ -70,11 +70,11 @@ export class Logger {
                 }
                 message = util.formatWithOptions(this.#printOptions, prefix.join(" "), ...arguments_);
             }
-            // Store in memory if enabled
+            // Store in memory if enabled.
             if (this.#inMemory) {
                 this.#memoryLogs.push(message);
             }
-            // Still output to console if not in memory-only mode
+            // Still output to console if not in memory-only mode.
             if (!this.#inMemory) {
                 console[type.method](this.#printOptions.colors ? `${type.color(message)}` : message);
             }
@@ -111,7 +111,8 @@ export class Logger {
         }, ...arguments_);
     }
     /**
-	 * Log multiple error messages at the prompt using `console.error` behind the scenes.
+	 * Log multiple error messages at the prompt using `console.error` behind the
+	 * scenes.
 	 * @param {string[]} errorMessages array of error message to display line by line
 	 * @param {number} [exitStatus] the process will exit with this value if provided
 	 */ printErrorsAndExit(errorMessages, exitStatus) {
@@ -128,7 +129,7 @@ export class Logger {
         }
     }
     /**
-	 * Print sets of logs in a box (wrapper to Boxen)
+	 * Print sets of logs in a box (wrapper to Boxen).
 	 * @param messages Messages to print
 	 * @param options
 	 */ printBox(messages, options = {}) {
@@ -138,8 +139,7 @@ export class Logger {
             ...options
         };
         /**
-		 * Setting some sensible Boxen options if
-		 * not provided by the user.
+		 * Setting some sensible Boxen options if not provided by the user.
 		 */ const borderColor = options.borderColor || "yellow";
         const boxenOptions = {
             ...options,
@@ -158,7 +158,7 @@ export class Logger {
         this.#globalPrefix = oldPrefix;
     }
 }
-/* istanbul ignore next */ export class Spinner {
+/* v8 ignore next 48 */ export class Spinner {
     spinner;
     constructor(options){
         this.spinner = ora({

package/dist/Logger.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/Logger.ts"],"sourcesContent":["import boxen, { Options as BoxenOptions } from \"boxen\";\nimport ora, { Ora, Options as OraOptions } from \"ora\";\n\nimport util from \"node:util\";\nimport kleur from \"kleur\";\n\nexport type PrintBoxOptions = {\n\tnewLineAfter?: boolean;\n\tnewLineBefore?: boolean;\n} & BoxenOptions;\n\nexport type LoggerOptions = {\n\tboring?: boolean;\n\tsilent?: boolean;\n\tprefix?: string;\n\ttimestamp?: boolean;\n\tinMemory?: boolean;\n};\n\nexport class Logger {\n\t#shouldLog: boolean;\n\t#globalPrefix: string;\n\t#showTimestamp: boolean;\n\t#printOptions: { colors: boolean; compact: boolean; depth: number };\n\t#inMemory: boolean;\n\t#memoryLogs: string[];\n\n\tconstructor({\n\t\tboring = false,\n\t\tsilent = false,\n\t\tprefix = \"\",\n\t\ttimestamp = false,\n\t\tinMemory = false,\n\t} = {}) {\n\t\tthis.#shouldLog = !silent;\n\t\tthis.#globalPrefix = prefix;\n\t\tthis.#showTimestamp = timestamp;\n\t\tthis.#inMemory = inMemory;\n\t\tthis.#memoryLogs = [];\n\n\t\t// When in memory mode, we disable colors\n\t\tthis.#printOptions = {\n\t\t\tcolors: !boring && !inMemory,\n\t\t\tcompact: false,\n\t\t\tdepth: 5,\n\t\t};\n\t}\n\n\tset silent(flag: boolean) {\n\t\tthis.#shouldLog = !flag;\n\t}\n\n\tset boring(flag: boolean) {\n\t\t// Only set colors if not in memory mode\n\t\tif (!this.#inMemory) {\n\t\t\tthis.#printOptions.colors = !flag;\n\t\t}\n\t}\n\n\tset prefix(prefix: string) {\n\t\tthis.#globalPrefix = prefix;\n\t}\n\n\tset timestamp(flag: boolean) {\n\t\tthis.#showTimestamp = flag;\n\t}\n\n\tset inMemory(flag: boolean) {\n\t\tthis.#inMemory = flag;\n\t\t// When enabling in-memory mode, disable colors\n\t\tif (flag) {\n\t\t\tthis.#printOptions.colors = false;\n\t\t}\n\t}\n\n\t/*\n\t Get the accumulated logs as a string\n\t * @returns {string} All logs joined by the separator\n\t /\n\tgetMemoryLogs(): string {\n\t\treturn this.#memoryLogs.join(\"\\n\");\n\t}\n\n\t/\n\t Clear all accumulated logs from memory\n\t /\n\tclearMemoryLogs(): void {\n\t\tthis.#memoryLogs = [];\n\t}\n\n\t#_log(\n\t\ttype: { method: string \| number; color: (argument0: any) => any },\n\t\t...arguments_: string[]\n\t) {\n\t\tif (this.#shouldLog) {\n\t\t\tlet message: string;\n\t\t\tif (!this.#showTimestamp && !this.#globalPrefix) {\n\t\t\t\tmessage = util.formatWithOptions(this.#printOptions, ...arguments_);\n\t\t\t} else {\n\t\t\t\tconst prefix = this.#globalPrefix ? [this.#globalPrefix] : [];\n\t\t\t\tif (this.#showTimestamp) {\n\t\t\t\t\tconst now = new Date();\n\t\t\t\t\tprefix.push(\n\t\t\t\t\t\tthis.#printOptions.colors\n\t\t\t\t\t\t\t? `${kleur.grey(\n\t\t\t\t\t\t\t\t\t`[ ${now.toDateString()} ${now.toLocaleTimeString()} ]`,\n\t\t\t\t\t\t\t\t)}`\n\t\t\t\t\t\t\t: `[ ${now.toDateString()} ${now.toLocaleTimeString()} ]`,\n\t\t\t\t\t);\n\t\t\t\t}\n\n\t\t\t\tmessage = util.formatWithOptions(\n\t\t\t\t\tthis.#printOptions,\n\t\t\t\t\tprefix.join(\" \"),\n\t\t\t\t\t...arguments_,\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// Store in memory if enabled\n\t\t\tif (this.#inMemory) {\n\t\t\t\tthis.#memoryLogs.push(message);\n\t\t\t}\n\n\t\t\t// Still output to console if not in memory-only mode\n\t\t\tif (!this.#inMemory) {\n\t\t\t\tconsole[type.method](\n\t\t\t\t\tthis.#printOptions.colors ? `${type.color(message)}` : message,\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n\n\tinfo(...arguments_: any) {\n\t\tthis.#_log({ method: \"info\", color: kleur.blue }, ...arguments_);\n\t}\n\n\tlog(...arguments_: any) {\n\t\tthis.#_log({ method: \"log\", color: kleur.white }, ...arguments_);\n\t}\n\n\tdebug(...arguments_: any) {\n\t\tthis.#_log({ method: \"debug\", color: kleur.grey }, ...arguments_);\n\t}\n\n\twarn(...arguments_: any) {\n\t\tthis.#_log({ method: \"warn\", color: kleur.yellow }, ...arguments_);\n\t}\n\n\terror(...arguments_: any) {\n\t\tthis.#_log({ method: \"error\", color: kleur.red }, ...arguments_);\n\t}\n\n\t/\n\t Log multiple error messages at the prompt using `console.error` behind the scenes.\n\t * @param {string[]} errorMessages array of error message to display line by line\n\t * @param {number} [exitStatus] the process will exit with this value if provided\n\t /\n\tprintErrorsAndExit(errorMessages: string[], exitStatus?: number) {\n\t\tif (errorMessages && errorMessages.length > 0) {\n\t\t\tthis.log();\n\t\t\tfor (const message of errorMessages) {\n\t\t\t\tthis.error(message);\n\t\t\t}\n\t\t\tthis.log();\n\n\t\t\tif (typeof exitStatus === \"number\") {\n\t\t\t\t// eslint-disable-next-line unicorn/no-process-exit\n\t\t\t\tprocess.exit(exitStatus);\n\t\t\t}\n\t\t}\n\t}\n\n\t/\n\t Print sets of logs in a box (wrapper to Boxen)\n\t * @param messages Messages to print\n\t * @param options\n\t /\n\tprintBox(messages: string \| string[], options: PrintBoxOptions = {}) {\n\t\tconst { newLineAfter, newLineBefore } = {\n\t\t\tnewLineAfter: true,\n\t\t\tnewLineBefore: true,\n\t\t\t...options,\n\t\t};\n\n\t\t/\n\t\t Setting some sensible Boxen options if\n\t\t * not provided by the user.\n\t\t /\n\t\tconst borderColor = options.borderColor \|\| \"yellow\";\n\t\tconst boxenOptions: BoxenOptions = {\n\t\t\t...options,\n\t\t\tborderColor: this.#printOptions.colors ? borderColor : \"white\",\n\t\t\tpadding: typeof options.padding === \"number\" ? options.padding : 1,\n\t\t\ttextAlignment: options.textAlignment \|\| \"center\",\n\t\t};\n\n\t\tconst oldPrefix = this.#globalPrefix;\n\t\tconst oldTimestamp = this.#showTimestamp;\n\n\t\tthis.#globalPrefix = \"\";\n\t\tthis.#showTimestamp = false;\n\n\t\tnewLineBefore && this.log();\n\t\tthis.log(\n\t\t\tboxen(\n\t\t\t\ttypeof messages === \"string\" ? messages : messages.join(\"\\n\"),\n\t\t\t\tboxenOptions,\n\t\t\t),\n\t\t);\n\t\tnewLineAfter && this.log();\n\n\t\tthis.#showTimestamp = oldTimestamp;\n\t\tthis.#globalPrefix = oldPrefix;\n\t}\n}\n\n/ istanbul ignore next */\nexport class Spinner {\n\tspinner: Ora;\n\n\tconstructor(options?: OraOptions) {\n\t\tthis.spinner = ora({\n\t\t\t...options,\n\t\t\tisSilent: process.env.NODE_ENV === \"test\",\n\t\t});\n\t}\n\n\tset text(message: string) {\n\t\tthis.spinner.text = message;\n\t}\n\n\tstart(message?: string) {\n\t\tthis.spinner.start(message);\n\t}\n\n\tstop(message?: string, type?: string) {\n\t\tswitch (type) {\n\t\t\tcase Spinner.ERROR: {\n\t\t\t\tthis.spinner.fail(message);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase Spinner.WARNING: {\n\t\t\t\tthis.spinner.warn(message);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase Spinner.INFO: {\n\t\t\t\tthis.spinner.info(message);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tsetTimeout(() => {\n\t\t\t\t\tthis.spinner.succeed(message);\n\t\t\t\t}, 1000);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\tstatic SUCCESS = \"success\";\n\tstatic ERROR = \"fail\";\n\tstatic WARNING = \"warn\";\n\tstatic INFO = \"info\";\n}\n"],"names":["boxen","ora","util","kleur","Logger","constructor","boring","silent","prefix","timestamp","inMemory","colors","compact","depth","flag","getMemoryLogs","join","clearMemoryLogs","type","arguments_","message","formatWithOptions","now","Date","push","grey","toDateString","toLocaleTimeString","console","method","color","info","blue","log","white","debug","warn","yellow","error","red","printErrorsAndExit","errorMessages","exitStatus","length","process","exit","printBox","messages","options","newLineAfter","newLineBefore","borderColor","boxenOptions","padding","textAlignment","oldPrefix","oldTimestamp","Spinner","spinner","isSilent","env","NODE_ENV","text","start","stop","ERROR","fail","WARNING","INFO","setTimeout","succeed","SUCCESS"],"mappings":"AAAA,OAAOA,WAAwC,QAAQ;AACvD,OAAOC,SAAyC,MAAM;AAEtD,OAAOC,UAAU,YAAY;AAC7B,OAAOC,WAAW,QAAQ;AAe1B,OAAO,MAAMC;IACZ,CAAA,SAAU,CAAU;IACpB,CAAA,YAAa,CAAS;IACtB,CAAA,aAAc,CAAU;IACxB,CAAA,YAAa,CAAuD;IACpE,CAAA,QAAS,CAAU;IACnB,CAAA,UAAW,CAAW;IAEtBC,YAAY,EACXC,SAAS,KAAK,EACdC,SAAS,KAAK,EACdC,SAAS,EAAE,EACXC,YAAY,KAAK,EACjBC,WAAW,KAAK,EAChB,GAAG,CAAC,CAAC,CAAE;QACP,IAAI,CAAC,CAAA,SAAU,GAAG,CAACH;QACnB,IAAI,CAAC,CAAA,YAAa,GAAGC;QACrB,IAAI,CAAC,CAAA,aAAc,GAAGC;QACtB,IAAI,CAAC,CAAA,QAAS,GAAGC;QACjB,IAAI,CAAC,CAAA,UAAW,GAAG,EAAE;QAErB,yCAAyC;QACzC,IAAI,CAAC,CAAA,YAAa,GAAG;YACpBC,QAAQ,CAACL,UAAU,CAACI;YACpBE,SAAS;YACTC,OAAO;QACR;IACD;IAEA,IAAIN,OAAOO,IAAa,EAAE;QACzB,IAAI,CAAC,CAAA,SAAU,GAAG,CAACA;IACpB;IAEA,IAAIR,OAAOQ,IAAa,EAAE;QACzB,wCAAwC;QACxC,IAAI,CAAC,IAAI,CAAC,CAAA,QAAS,EAAE;YACpB,IAAI,CAAC,CAAA,YAAa,CAACH,MAAM,GAAG,CAACG;QAC9B;IACD;IAEA,IAAIN,OAAOA,MAAc,EAAE;QAC1B,IAAI,CAAC,CAAA,YAAa,GAAGA;IACtB;IAEA,IAAIC,UAAUK,IAAa,EAAE;QAC5B,IAAI,CAAC,CAAA,aAAc,GAAGA;IACvB;IAEA,IAAIJ,SAASI,IAAa,EAAE;QAC3B,IAAI,CAAC,CAAA,QAAS,GAAGA;QACjB,+CAA+C;QAC/C,IAAIA,MAAM;YACT,IAAI,CAAC,CAAA,YAAa,CAACH,MAAM,GAAG;QAC7B;IACD;IAEA;;;EAGC,GACDI,gBAAwB;QACvB,OAAO,IAAI,CAAC,CAAA,UAAW,CAACC,IAAI,CAAC;IAC9B;IAEA;;EAEC,GACDC,kBAAwB;QACvB,IAAI,CAAC,CAAA,UAAW,GAAG,EAAE;IACtB;IAEA,CAAA,IAAK,CACJC,IAAiE,EACjE,GAAGC,UAAoB;QAEvB,IAAI,IAAI,CAAC,CAAA,SAAU,EAAE;YACpB,IAAIC;YACJ,IAAI,CAAC,IAAI,CAAC,CAAA,aAAc,IAAI,CAAC,IAAI,CAAC,CAAA,YAAa,EAAE;gBAChDA,UAAUlB,KAAKmB,iBAAiB,CAAC,IAAI,CAAC,CAAA,YAAa,KAAKF;YACzD,OAAO;gBACN,MAAMX,SAAS,IAAI,CAAC,CAAA,YAAa,GAAG;oBAAC,IAAI,CAAC,CAAA,YAAa;iBAAC,GAAG,EAAE;gBAC7D,IAAI,IAAI,CAAC,CAAA,aAAc,EAAE;oBACxB,MAAMc,MAAM,IAAIC;oBAChBf,OAAOgB,IAAI,CACV,IAAI,CAAC,CAAA,YAAa,CAACb,MAAM,GACtB,GAAGR,MAAMsB,IAAI,CACb,CAAC,EAAE,EAAEH,IAAII,YAAY,GAAG,CAAC,EAAEJ,IAAIK,kBAAkB,GAAG,EAAE,CAAC,GACrD,GACF,CAAC,EAAE,EAAEL,IAAII,YAAY,GAAG,CAAC,EAAEJ,IAAIK,kBAAkB,GAAG,EAAE,CAAC;gBAE5D;gBAEAP,UAAUlB,KAAKmB,iBAAiB,CAC/B,IAAI,CAAC,CAAA,YAAa,EAClBb,OAAOQ,IAAI,CAAC,SACTG;YAEL;YAEA,6BAA6B;YAC7B,IAAI,IAAI,CAAC,CAAA,QAAS,EAAE;gBACnB,IAAI,CAAC,CAAA,UAAW,CAACK,IAAI,CAACJ;YACvB;YAEA,qDAAqD;YACrD,IAAI,CAAC,IAAI,CAAC,CAAA,QAAS,EAAE;gBACpBQ,OAAO,CAACV,KAAKW,MAAM,CAAC,CACnB,IAAI,CAAC,CAAA,YAAa,CAAClB,MAAM,GAAG,GAAGO,KAAKY,KAAK,CAACV,UAAU,GAAGA;YAEzD;QACD;IACD;IAEAW,KAAK,GAAGZ,UAAe,EAAE;QACxB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAAQC,OAAO3B,MAAM6B,IAAI;QAAC,MAAMb;IACtD;IAEAc,IAAI,GAAGd,UAAe,EAAE;QACvB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAAOC,OAAO3B,MAAM+B,KAAK;QAAC,MAAMf;IACtD;IAEAgB,MAAM,GAAGhB,UAAe,EAAE;QACzB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAASC,OAAO3B,MAAMsB,IAAI;QAAC,MAAMN;IACvD;IAEAiB,KAAK,GAAGjB,UAAe,EAAE;QACxB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAAQC,OAAO3B,MAAMkC,MAAM;QAAC,MAAMlB;IACxD;IAEAmB,MAAM,GAAGnB,UAAe,EAAE;QACzB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAASC,OAAO3B,MAAMoC,GAAG;QAAC,MAAMpB;IACtD;IAEA;;;;EAIC,GACDqB,mBAAmBC,aAAuB,EAAEC,UAAmB,EAAE;QAChE,IAAID,iBAAiBA,cAAcE,MAAM,GAAG,GAAG;YAC9C,IAAI,CAACV,GAAG;YACR,KAAK,MAAMb,WAAWqB,cAAe;gBACpC,IAAI,CAACH,KAAK,CAAClB;YACZ;YACA,IAAI,CAACa,GAAG;YAER,IAAI,OAAOS,eAAe,UAAU;gBACnC,mDAAmD;gBACnDE,QAAQC,IAAI,CAACH;YACd;QACD;IACD;IAEA;;;;EAIC,GACDI,SAASC,QAA2B,EAAEC,UAA2B,CAAC,CAAC,EAAE;QACpE,MAAM,EAAEC,YAAY,EAAEC,aAAa,EAAE,GAAG;YACvCD,cAAc;YACdC,eAAe;YACf,GAAGF,OAAO;QACX;QAEA;;;GAGC,GACD,MAAMG,cAAcH,QAAQG,WAAW,IAAI;QAC3C,MAAMC,eAA6B;YAClC,GAAGJ,OAAO;YACVG,aAAa,IAAI,CAAC,CAAA,YAAa,CAACxC,MAAM,GAAGwC,cAAc;YACvDE,SAAS,OAAOL,QAAQK,OAAO,KAAK,WAAWL,QAAQK,OAAO,GAAG;YACjEC,eAAeN,QAAQM,aAAa,IAAI;QACzC;QAEA,MAAMC,YAAY,IAAI,CAAC,CAAA,YAAa;QACpC,MAAMC,eAAe,IAAI,CAAC,CAAA,aAAc;QAExC,IAAI,CAAC,CAAA,YAAa,GAAG;QACrB,IAAI,CAAC,CAAA,aAAc,GAAG;QAEtBN,iBAAiB,IAAI,CAACjB,GAAG;QACzB,IAAI,CAACA,GAAG,CACPjC,MACC,OAAO+C,aAAa,WAAWA,WAAWA,SAAS/B,IAAI,CAAC,OACxDoC;QAGFH,gBAAgB,IAAI,CAAChB,GAAG;QAExB,IAAI,CAAC,CAAA,aAAc,GAAGuB;QACtB,IAAI,CAAC,CAAA,YAAa,GAAGD;IACtB;AACD;AAEA,wBAAwB,GACxB,OAAO,MAAME;IACZC,QAAa;IAEbrD,YAAY2C,OAAoB,CAAE;QACjC,IAAI,CAACU,OAAO,GAAGzD,IAAI;YAClB,GAAG+C,OAAO;YACVW,UAAUf,QAAQgB,GAAG,CAACC,QAAQ,KAAK;QACpC;IACD;IAEA,IAAIC,KAAK1C,OAAe,EAAE;QACzB,IAAI,CAACsC,OAAO,CAACI,IAAI,GAAG1C;IACrB;IAEA2C,MAAM3C,OAAgB,EAAE;QACvB,IAAI,CAACsC,OAAO,CAACK,KAAK,CAAC3C;IACpB;IAEA4C,KAAK5C,OAAgB,EAAEF,IAAa,EAAE;QACrC,OAAQA;YACP,KAAKuC,QAAQQ,KAAK;gBAAE;oBACnB,IAAI,CAACP,OAAO,CAACQ,IAAI,CAAC9C;oBAClB;gBACD;YACA,KAAKqC,QAAQU,OAAO;gBAAE;oBACrB,IAAI,CAACT,OAAO,CAACtB,IAAI,CAAChB;oBAClB;gBACD;YACA,KAAKqC,QAAQW,IAAI;gBAAE;oBAClB,IAAI,CAACV,OAAO,CAAC3B,IAAI,CAACX;oBAClB;gBACD;YACA;gBAAS;oBACRiD,WAAW;wBACV,IAAI,CAACX,OAAO,CAACY,OAAO,CAAClD;oBACtB,GAAG;oBACH;gBACD;QACD;IACD;IAEA,OAAOmD,UAAU,UAAU;IAC3B,OAAON,QAAQ,OAAO;IACtB,OAAOE,UAAU,OAAO;IACxB,OAAOC,OAAO,OAAO;AACtB"}
1	+ {"version":3,"sources":["../src/Logger.ts"],"sourcesContent":["import util from \"node:util\";\nimport boxen, { Options as BoxenOptions } from \"boxen\";\nimport kleur from \"kleur\";\nimport ora, { Ora, Options as OraOptions } from \"ora\";\n\nexport type PrintBoxOptions = {\n\tnewLineAfter?: boolean;\n\tnewLineBefore?: boolean;\n} & BoxenOptions;\n\nexport type LoggerOptions = {\n\tboring?: boolean;\n\tsilent?: boolean;\n\tprefix?: string;\n\ttimestamp?: boolean;\n\tinMemory?: boolean;\n};\n\nexport class Logger {\n\t#shouldLog: boolean;\n\t#globalPrefix: string;\n\t#showTimestamp: boolean;\n\t#printOptions: { colors: boolean; compact: boolean; depth: number };\n\t#inMemory: boolean;\n\t#memoryLogs: string[];\n\n\tconstructor({\n\t\tboring = false,\n\t\tsilent = false,\n\t\tprefix = \"\",\n\t\ttimestamp = false,\n\t\tinMemory = false,\n\t} = {}) {\n\t\tthis.#shouldLog = !silent;\n\t\tthis.#globalPrefix = prefix;\n\t\tthis.#showTimestamp = timestamp;\n\t\tthis.#inMemory = inMemory;\n\t\tthis.#memoryLogs = [];\n\n\t\t// When in memory mode, we disable colors.\n\t\tthis.#printOptions = {\n\t\t\tcolors: !boring && !inMemory,\n\t\t\tcompact: false,\n\t\t\tdepth: 5,\n\t\t};\n\t}\n\n\tset silent(flag: boolean) {\n\t\tthis.#shouldLog = !flag;\n\t}\n\n\tset boring(flag: boolean) {\n\t\t// Only set colors if not in memory mode.\n\t\tif (!this.#inMemory) {\n\t\t\tthis.#printOptions.colors = !flag;\n\t\t}\n\t}\n\n\tset prefix(prefix: string) {\n\t\tthis.#globalPrefix = prefix;\n\t}\n\n\tset timestamp(flag: boolean) {\n\t\tthis.#showTimestamp = flag;\n\t}\n\n\tset inMemory(flag: boolean) {\n\t\tthis.#inMemory = flag;\n\t\t// When enabling in-memory mode, disable colors.\n\t\tif (flag) {\n\t\t\tthis.#printOptions.colors = false;\n\t\t}\n\t}\n\n\t/*\n\t Get the accumulated logs as a string.\n\t * @returns {string} All logs joined by the separator\n\t /\n\tgetMemoryLogs(): string {\n\t\treturn this.#memoryLogs.join(\"\\n\");\n\t}\n\n\t/\n\t Clear all accumulated logs from memory.\n\t /\n\tclearMemoryLogs(): void {\n\t\tthis.#memoryLogs = [];\n\t}\n\n\t#_log(\n\t\ttype: { method: string \| number; color: (argument0: any) => any },\n\t\t...arguments_: string[]\n\t) {\n\t\tif (this.#shouldLog) {\n\t\t\tlet message: string;\n\t\t\tif (!this.#showTimestamp && !this.#globalPrefix) {\n\t\t\t\tmessage = util.formatWithOptions(this.#printOptions, ...arguments_);\n\t\t\t} else {\n\t\t\t\tconst prefix = this.#globalPrefix ? [this.#globalPrefix] : [];\n\t\t\t\tif (this.#showTimestamp) {\n\t\t\t\t\tconst now = new Date();\n\t\t\t\t\tprefix.push(\n\t\t\t\t\t\tthis.#printOptions.colors\n\t\t\t\t\t\t\t? `${kleur.grey(\n\t\t\t\t\t\t\t\t\t`[ ${now.toDateString()} ${now.toLocaleTimeString()} ]`,\n\t\t\t\t\t\t\t\t)}`\n\t\t\t\t\t\t\t: `[ ${now.toDateString()} ${now.toLocaleTimeString()} ]`,\n\t\t\t\t\t);\n\t\t\t\t}\n\n\t\t\t\tmessage = util.formatWithOptions(\n\t\t\t\t\tthis.#printOptions,\n\t\t\t\t\tprefix.join(\" \"),\n\t\t\t\t\t...arguments_,\n\t\t\t\t);\n\t\t\t}\n\n\t\t\t// Store in memory if enabled.\n\t\t\tif (this.#inMemory) {\n\t\t\t\tthis.#memoryLogs.push(message);\n\t\t\t}\n\n\t\t\t// Still output to console if not in memory-only mode.\n\t\t\tif (!this.#inMemory) {\n\t\t\t\tconsole[type.method](\n\t\t\t\t\tthis.#printOptions.colors ? `${type.color(message)}` : message,\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n\n\tinfo(...arguments_: any) {\n\t\tthis.#_log({ method: \"info\", color: kleur.blue }, ...arguments_);\n\t}\n\n\tlog(...arguments_: any) {\n\t\tthis.#_log({ method: \"log\", color: kleur.white }, ...arguments_);\n\t}\n\n\tdebug(...arguments_: any) {\n\t\tthis.#_log({ method: \"debug\", color: kleur.grey }, ...arguments_);\n\t}\n\n\twarn(...arguments_: any) {\n\t\tthis.#_log({ method: \"warn\", color: kleur.yellow }, ...arguments_);\n\t}\n\n\terror(...arguments_: any) {\n\t\tthis.#_log({ method: \"error\", color: kleur.red }, ...arguments_);\n\t}\n\n\t/\n\t Log multiple error messages at the prompt using `console.error` behind the\n\t * scenes.\n\t * @param {string[]} errorMessages array of error message to display line by line\n\t * @param {number} [exitStatus] the process will exit with this value if provided\n\t /\n\tprintErrorsAndExit(errorMessages: string[], exitStatus?: number) {\n\t\tif (errorMessages && errorMessages.length > 0) {\n\t\t\tthis.log();\n\t\t\tfor (const message of errorMessages) {\n\t\t\t\tthis.error(message);\n\t\t\t}\n\t\t\tthis.log();\n\n\t\t\tif (typeof exitStatus === \"number\") {\n\t\t\t\t// eslint-disable-next-line unicorn/no-process-exit\n\t\t\t\tprocess.exit(exitStatus);\n\t\t\t}\n\t\t}\n\t}\n\n\t/\n\t Print sets of logs in a box (wrapper to Boxen).\n\t * @param messages Messages to print\n\t * @param options\n\t /\n\tprintBox(messages: string \| string[], options: PrintBoxOptions = {}) {\n\t\tconst { newLineAfter, newLineBefore } = {\n\t\t\tnewLineAfter: true,\n\t\t\tnewLineBefore: true,\n\t\t\t...options,\n\t\t};\n\n\t\t/\n\t\t Setting some sensible Boxen options if not provided by the user.\n\t\t /\n\t\tconst borderColor = options.borderColor \|\| \"yellow\";\n\t\tconst boxenOptions: BoxenOptions = {\n\t\t\t...options,\n\t\t\tborderColor: this.#printOptions.colors ? borderColor : \"white\",\n\t\t\tpadding: typeof options.padding === \"number\" ? options.padding : 1,\n\t\t\ttextAlignment: options.textAlignment \|\| \"center\",\n\t\t};\n\n\t\tconst oldPrefix = this.#globalPrefix;\n\t\tconst oldTimestamp = this.#showTimestamp;\n\n\t\tthis.#globalPrefix = \"\";\n\t\tthis.#showTimestamp = false;\n\n\t\tnewLineBefore && this.log();\n\t\tthis.log(\n\t\t\tboxen(\n\t\t\t\ttypeof messages === \"string\" ? messages : messages.join(\"\\n\"),\n\t\t\t\tboxenOptions,\n\t\t\t),\n\t\t);\n\t\tnewLineAfter && this.log();\n\n\t\tthis.#showTimestamp = oldTimestamp;\n\t\tthis.#globalPrefix = oldPrefix;\n\t}\n}\n\n/ v8 ignore next 48 */\nexport class Spinner {\n\tspinner: Ora;\n\n\tconstructor(options?: OraOptions) {\n\t\tthis.spinner = ora({\n\t\t\t...options,\n\t\t\tisSilent: process.env.NODE_ENV === \"test\",\n\t\t});\n\t}\n\n\tset text(message: string) {\n\t\tthis.spinner.text = message;\n\t}\n\n\tstart(message?: string) {\n\t\tthis.spinner.start(message);\n\t}\n\n\tstop(message?: string, type?: string) {\n\t\tswitch (type) {\n\t\t\tcase Spinner.ERROR: {\n\t\t\t\tthis.spinner.fail(message);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase Spinner.WARNING: {\n\t\t\t\tthis.spinner.warn(message);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase Spinner.INFO: {\n\t\t\t\tthis.spinner.info(message);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tsetTimeout(() => {\n\t\t\t\t\tthis.spinner.succeed(message);\n\t\t\t\t}, 1000);\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\tstatic SUCCESS = \"success\";\n\tstatic ERROR = \"fail\";\n\tstatic WARNING = \"warn\";\n\tstatic INFO = \"info\";\n}\n"],"names":["util","boxen","kleur","ora","Logger","boring","silent","prefix","timestamp","inMemory","colors","compact","depth","flag","getMemoryLogs","join","clearMemoryLogs","type","arguments_","message","formatWithOptions","now","Date","push","grey","toDateString","toLocaleTimeString","console","method","color","info","blue","log","white","debug","warn","yellow","error","red","printErrorsAndExit","errorMessages","exitStatus","length","process","exit","printBox","messages","options","newLineAfter","newLineBefore","borderColor","boxenOptions","padding","textAlignment","oldPrefix","oldTimestamp","Spinner","spinner","isSilent","env","NODE_ENV","text","start","stop","ERROR","fail","WARNING","INFO","setTimeout","succeed","SUCCESS"],"mappings":"AAAA,OAAOA,UAAU,YAAY;AAC7B,OAAOC,WAAwC,QAAQ;AACvD,OAAOC,WAAW,QAAQ;AAC1B,OAAOC,SAAyC,MAAM;AAetD,OAAO,MAAMC;IACZ,CAAA,SAAU,CAAU;IACpB,CAAA,YAAa,CAAS;IACtB,CAAA,aAAc,CAAU;IACxB,CAAA,YAAa,CAAuD;IACpE,CAAA,QAAS,CAAU;IACnB,CAAA,UAAW,CAAW;IAEtB,YAAY,EACXC,SAAS,KAAK,EACdC,SAAS,KAAK,EACdC,SAAS,EAAE,EACXC,YAAY,KAAK,EACjBC,WAAW,KAAK,EAChB,GAAG,CAAC,CAAC,CAAE;QACP,IAAI,CAAC,CAAA,SAAU,GAAG,CAACH;QACnB,IAAI,CAAC,CAAA,YAAa,GAAGC;QACrB,IAAI,CAAC,CAAA,aAAc,GAAGC;QACtB,IAAI,CAAC,CAAA,QAAS,GAAGC;QACjB,IAAI,CAAC,CAAA,UAAW,GAAG,EAAE;QAErB,0CAA0C;QAC1C,IAAI,CAAC,CAAA,YAAa,GAAG;YACpBC,QAAQ,CAACL,UAAU,CAACI;YACpBE,SAAS;YACTC,OAAO;QACR;IACD;IAEA,IAAIN,OAAOO,IAAa,EAAE;QACzB,IAAI,CAAC,CAAA,SAAU,GAAG,CAACA;IACpB;IAEA,IAAIR,OAAOQ,IAAa,EAAE;QACzB,yCAAyC;QACzC,IAAI,CAAC,IAAI,CAAC,CAAA,QAAS,EAAE;YACpB,IAAI,CAAC,CAAA,YAAa,CAACH,MAAM,GAAG,CAACG;QAC9B;IACD;IAEA,IAAIN,OAAOA,MAAc,EAAE;QAC1B,IAAI,CAAC,CAAA,YAAa,GAAGA;IACtB;IAEA,IAAIC,UAAUK,IAAa,EAAE;QAC5B,IAAI,CAAC,CAAA,aAAc,GAAGA;IACvB;IAEA,IAAIJ,SAASI,IAAa,EAAE;QAC3B,IAAI,CAAC,CAAA,QAAS,GAAGA;QACjB,gDAAgD;QAChD,IAAIA,MAAM;YACT,IAAI,CAAC,CAAA,YAAa,CAACH,MAAM,GAAG;QAC7B;IACD;IAEA;;;EAGC,GACDI,gBAAwB;QACvB,OAAO,IAAI,CAAC,CAAA,UAAW,CAACC,IAAI,CAAC;IAC9B;IAEA;;EAEC,GACDC,kBAAwB;QACvB,IAAI,CAAC,CAAA,UAAW,GAAG,EAAE;IACtB;IAEA,CAAA,IAAK,CACJC,IAAiE,EACjE,GAAGC,UAAoB;QAEvB,IAAI,IAAI,CAAC,CAAA,SAAU,EAAE;YACpB,IAAIC;YACJ,IAAI,CAAC,IAAI,CAAC,CAAA,aAAc,IAAI,CAAC,IAAI,CAAC,CAAA,YAAa,EAAE;gBAChDA,UAAUnB,KAAKoB,iBAAiB,CAAC,IAAI,CAAC,CAAA,YAAa,KAAKF;YACzD,OAAO;gBACN,MAAMX,SAAS,IAAI,CAAC,CAAA,YAAa,GAAG;oBAAC,IAAI,CAAC,CAAA,YAAa;iBAAC,GAAG,EAAE;gBAC7D,IAAI,IAAI,CAAC,CAAA,aAAc,EAAE;oBACxB,MAAMc,MAAM,IAAIC;oBAChBf,OAAOgB,IAAI,CACV,IAAI,CAAC,CAAA,YAAa,CAACb,MAAM,GACtB,GAAGR,MAAMsB,IAAI,CACb,CAAC,EAAE,EAAEH,IAAII,YAAY,GAAG,CAAC,EAAEJ,IAAIK,kBAAkB,GAAG,EAAE,CAAC,GACrD,GACF,CAAC,EAAE,EAAEL,IAAII,YAAY,GAAG,CAAC,EAAEJ,IAAIK,kBAAkB,GAAG,EAAE,CAAC;gBAE5D;gBAEAP,UAAUnB,KAAKoB,iBAAiB,CAC/B,IAAI,CAAC,CAAA,YAAa,EAClBb,OAAOQ,IAAI,CAAC,SACTG;YAEL;YAEA,8BAA8B;YAC9B,IAAI,IAAI,CAAC,CAAA,QAAS,EAAE;gBACnB,IAAI,CAAC,CAAA,UAAW,CAACK,IAAI,CAACJ;YACvB;YAEA,sDAAsD;YACtD,IAAI,CAAC,IAAI,CAAC,CAAA,QAAS,EAAE;gBACpBQ,OAAO,CAACV,KAAKW,MAAM,CAAC,CACnB,IAAI,CAAC,CAAA,YAAa,CAAClB,MAAM,GAAG,GAAGO,KAAKY,KAAK,CAACV,UAAU,GAAGA;YAEzD;QACD;IACD;IAEAW,KAAK,GAAGZ,UAAe,EAAE;QACxB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAAQC,OAAO3B,MAAM6B,IAAI;QAAC,MAAMb;IACtD;IAEAc,IAAI,GAAGd,UAAe,EAAE;QACvB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAAOC,OAAO3B,MAAM+B,KAAK;QAAC,MAAMf;IACtD;IAEAgB,MAAM,GAAGhB,UAAe,EAAE;QACzB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAASC,OAAO3B,MAAMsB,IAAI;QAAC,MAAMN;IACvD;IAEAiB,KAAK,GAAGjB,UAAe,EAAE;QACxB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAAQC,OAAO3B,MAAMkC,MAAM;QAAC,MAAMlB;IACxD;IAEAmB,MAAM,GAAGnB,UAAe,EAAE;QACzB,IAAI,CAAC,CAAA,IAAK,CAAC;YAAEU,QAAQ;YAASC,OAAO3B,MAAMoC,GAAG;QAAC,MAAMpB;IACtD;IAEA;;;;;EAKC,GACDqB,mBAAmBC,aAAuB,EAAEC,UAAmB,EAAE;QAChE,IAAID,iBAAiBA,cAAcE,MAAM,GAAG,GAAG;YAC9C,IAAI,CAACV,GAAG;YACR,KAAK,MAAMb,WAAWqB,cAAe;gBACpC,IAAI,CAACH,KAAK,CAAClB;YACZ;YACA,IAAI,CAACa,GAAG;YAER,IAAI,OAAOS,eAAe,UAAU;gBACnC,mDAAmD;gBACnDE,QAAQC,IAAI,CAACH;YACd;QACD;IACD;IAEA;;;;EAIC,GACDI,SAASC,QAA2B,EAAEC,UAA2B,CAAC,CAAC,EAAE;QACpE,MAAM,EAAEC,YAAY,EAAEC,aAAa,EAAE,GAAG;YACvCD,cAAc;YACdC,eAAe;YACf,GAAGF,OAAO;QACX;QAEA;;GAEC,GACD,MAAMG,cAAcH,QAAQG,WAAW,IAAI;QAC3C,MAAMC,eAA6B;YAClC,GAAGJ,OAAO;YACVG,aAAa,IAAI,CAAC,CAAA,YAAa,CAACxC,MAAM,GAAGwC,cAAc;YACvDE,SAAS,OAAOL,QAAQK,OAAO,KAAK,WAAWL,QAAQK,OAAO,GAAG;YACjEC,eAAeN,QAAQM,aAAa,IAAI;QACzC;QAEA,MAAMC,YAAY,IAAI,CAAC,CAAA,YAAa;QACpC,MAAMC,eAAe,IAAI,CAAC,CAAA,aAAc;QAExC,IAAI,CAAC,CAAA,YAAa,GAAG;QACrB,IAAI,CAAC,CAAA,aAAc,GAAG;QAEtBN,iBAAiB,IAAI,CAACjB,GAAG;QACzB,IAAI,CAACA,GAAG,CACP/B,MACC,OAAO6C,aAAa,WAAWA,WAAWA,SAAS/B,IAAI,CAAC,OACxDoC;QAGFH,gBAAgB,IAAI,CAAChB,GAAG;QAExB,IAAI,CAAC,CAAA,aAAc,GAAGuB;QACtB,IAAI,CAAC,CAAA,YAAa,GAAGD;IACtB;AACD;AAEA,qBAAqB,GACrB,OAAO,MAAME;IACZC,QAAa;IAEb,YAAYV,OAAoB,CAAE;QACjC,IAAI,CAACU,OAAO,GAAGtD,IAAI;YAClB,GAAG4C,OAAO;YACVW,UAAUf,QAAQgB,GAAG,CAACC,QAAQ,KAAK;QACpC;IACD;IAEA,IAAIC,KAAK1C,OAAe,EAAE;QACzB,IAAI,CAACsC,OAAO,CAACI,IAAI,GAAG1C;IACrB;IAEA2C,MAAM3C,OAAgB,EAAE;QACvB,IAAI,CAACsC,OAAO,CAACK,KAAK,CAAC3C;IACpB;IAEA4C,KAAK5C,OAAgB,EAAEF,IAAa,EAAE;QACrC,OAAQA;YACP,KAAKuC,QAAQQ,KAAK;gBAAE;oBACnB,IAAI,CAACP,OAAO,CAACQ,IAAI,CAAC9C;oBAClB;gBACD;YACA,KAAKqC,QAAQU,OAAO;gBAAE;oBACrB,IAAI,CAACT,OAAO,CAACtB,IAAI,CAAChB;oBAClB;gBACD;YACA,KAAKqC,QAAQW,IAAI;gBAAE;oBAClB,IAAI,CAACV,OAAO,CAAC3B,IAAI,CAACX;oBAClB;gBACD;YACA;gBAAS;oBACRiD,WAAW;wBACV,IAAI,CAACX,OAAO,CAACY,OAAO,CAAClD;oBACtB,GAAG;oBACH;gBACD;QACD;IACD;IAEA,OAAOmD,UAAU,UAAU;IAC3B,OAAON,QAAQ,OAAO;IACtB,OAAOE,UAAU,OAAO;IACxB,OAAOC,OAAO,OAAO;AACtB"}

package/package.json CHANGED Viewed

@@ -1,13 +1,14 @@
 {
 	"name": "@node-cli/logger",
-	"version": "1.3.0",
+	"version": "1.3.2",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "A tiny console logger for nodejs CLI apps",
 	"type": "module",
 	"exports": "./dist/Logger.js",
 	"files": [
-		"dist"
+		"dist",
+		"README.md"
 	],
 	"node": ">=16",
 	"dependencies": {
@@ -21,14 +22,21 @@
 		"build:js": "swc --strip-leading-paths --source-maps --out-dir dist src",
 		"build:types": "tsc",
 		"clean": "rimraf dist types coverage",
+		"comments:fix": "comments --merge-line-comments 'src/**/*.ts'",
 		"lint": "biome lint src",
-		"test": "cross-env-shell NODE_OPTIONS=--experimental-vm-modules jest",
-		"test:coverage": "npm run test -- --coverage",
-		"test:watch": "npm run test -- --watch",
+		"lint:fix": "biome check src --write --no-errors-on-unmatched",
+		"test": "vitest run --globals",
+		"test:coverage": "vitest run --coverage --globals",
+		"test:watch": "vitest --globals",
 		"watch": "swc --strip-leading-paths --watch --out-dir dist src"
 	},
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "92d48ec7a2e19ad36b077d9e219d91f782dd4a0a"
+	"devDependencies": {
+		"@node-cli/comments": "0.2.0",
+		"@vitest/coverage-v8": "3.2.4",
+		"vitest": "3.2.4"
+	},
+	"gitHead": "d90392dcb766dd605bc3eeabc7c7a7ab0c8e6da6"
 }