bananass-utils-console 0.8.0 → 0.9.1

package/build/theme.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @fileoverview Console theme.
+ * @module bananass-utils-console/theme
+ */
+/**
+ * Returns a green-colored success message prefixed with an icon.
+ *
+ * @param str The success message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a green-colored success message prefixed with an icon.
+ *
+ * @example
+ * console.log(complete('Operation successful.'));
+ * // Output: (icon?) Operation successful. (displayed in green text in the terminal.)
+ */
+export declare function success(str: string, showIcon?: boolean): string;
+/**
+ * Returns a red-colored error message prefixed with an icon.
+ *
+ * @param str The error message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a red-colored error message prefixed with an icon.
+ *
+ * @example
+ * console.log(error('Something went wrong.'));
+ * // Output: (icon?) Something went wrong. (displayed in red text in the terminal.)
+ */
+export declare function error(str: string, showIcon?: boolean): string;
+/**
+ * Returns a yellow-colored warning message prefixed with an icon.
+ *
+ * @param str The warning message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a yellow-colored warning message prefixed with an icon.
+ *
+ * @example
+ * console.log(warning('This is a warning.'));
+ * // Output: (icon?) This is a warning. (displayed in yellow text in the terminal.)
+ */
+export declare function warning(str: string, showIcon?: boolean): string;
+/**
+ * Returns a blue-colored info message prefixed with an icon.
+ *
+ * @param str The info message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a blue-colored info message prefixed with an icon.
+ *
+ * @example
+ * console.log(info('Informational message.'));
+ * // Output: (icon?) Informational message. (displayed in blue text in the terminal.)
+ */
+export declare function info(str: string, showIcon?: boolean): string;
+/**
+ * Returns a yellow-colored bananass message prefixed with an icon.
+ *
+ * @param str The bananass message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a yellow-colored bananass message prefixed with an icon.
+ *
+ * @example
+ * console.log(bananass('Hello, Bananass.'));
+ * // Output: (icon?) Hello, Bananass. (displayed in yellow text in the terminal.)
+ */
+export declare function bananass(str: string, showIcon?: boolean): string;

package/{src/theme → build}/theme.js

@@ -2,111 +2,96 @@
  * @fileoverview Console theme.
  * @module bananass-utils-console/theme
  */
-
 // --------------------------------------------------------------------------------
 // Import
 // --------------------------------------------------------------------------------
-
 import { styleText } from 'node:util';
-import {
-  successText,
-  errorText,
-  warningText,
-  infoText,
-  bananassIcon,
-} from '../icons/index.js';
-
+import { successText, errorText, warningText, infoText, bananassIcon } from "./icons.js";
 // --------------------------------------------------------------------------------
-// Helpers
+// Helper
 // --------------------------------------------------------------------------------
-
 /**
  * Formats a string with an optional color and icon.
- * @param {string} str The string to format.
- * @param {boolean} showIcon Whether to show the icon.
- * @param {'green'|'red'|'yellow'|'blue'} color The color to apply to the string.
- * @param {string} icon The icon to prepend to the string if `showIcon` is true.
- * @returns {string} The formatted string with the optional icon and color applied.
+ * @param str The string to format.
+ * @param showIcon Whether to show the icon.
+ * @param color The color to apply to the string.
+ * @param icon The icon to prepend to the string if `showIcon` is true.
+ * @returns The formatted string with the optional icon and color applied.
  * @private
  */
-const format = (str, showIcon, color, icon) =>
-  `${showIcon ? `${icon} ` : ''}${styleText(color, str)}`;
-
+function format(str, showIcon, color, icon) {
+    return `${showIcon ? `${icon} ` : ''}${styleText(color, str)}`;
+}
 // --------------------------------------------------------------------------------
 // Export
 // --------------------------------------------------------------------------------
-
 /**
  * Returns a green-colored success message prefixed with an icon.
  *
- * @param {string} str The success message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a green-colored success message prefixed with an icon.
+ * @param str The success message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a green-colored success message prefixed with an icon.
  *
  * @example
  * console.log(complete('Operation successful.'));
  * // Output: (icon?) Operation successful. (displayed in green text in the terminal.)
  */
 export function success(str, showIcon = false) {
-  return format(str, showIcon, 'green', successText);
+    return format(str, showIcon, 'green', successText);
 }
-
 /**
  * Returns a red-colored error message prefixed with an icon.
  *
- * @param {string} str The error message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a red-colored error message prefixed with an icon.
+ * @param str The error message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a red-colored error message prefixed with an icon.
  *
  * @example
  * console.log(error('Something went wrong.'));
  * // Output: (icon?) Something went wrong. (displayed in red text in the terminal.)
  */
 export function error(str, showIcon = false) {
-  return format(str, showIcon, 'red', errorText);
+    return format(str, showIcon, 'red', errorText);
 }
-
 /**
  * Returns a yellow-colored warning message prefixed with an icon.
  *
- * @param {string} str The warning message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a yellow-colored warning message prefixed with an icon.
+ * @param str The warning message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a yellow-colored warning message prefixed with an icon.
  *
  * @example
  * console.log(warning('This is a warning.'));
  * // Output: (icon?) This is a warning. (displayed in yellow text in the terminal.)
  */
 export function warning(str, showIcon = false) {
-  return format(str, showIcon, 'yellow', warningText);
+    return format(str, showIcon, 'yellow', warningText);
 }
-
 /**
  * Returns a blue-colored info message prefixed with an icon.
  *
- * @param {string} str The info message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a blue-colored info message prefixed with an icon.
+ * @param str The info message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a blue-colored info message prefixed with an icon.
  *
  * @example
  * console.log(info('Informational message.'));
  * // Output: (icon?) Informational message. (displayed in blue text in the terminal.)
  */
 export function info(str, showIcon = false) {
-  return format(str, showIcon, 'blue', infoText);
+    return format(str, showIcon, 'blue', infoText);
 }
-
 /**
- * Returns a yellow-colored error message prefixed with an icon.
+ * Returns a yellow-colored bananass message prefixed with an icon.
  *
- * @param {string} str The bananass message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns Returns a yellow-colored error message prefixed with an icon.
+ * @param str The bananass message to format.
+ * @param showIcon Whether to show the icon. Defaults to `false`.
+ * @returns Returns a yellow-colored bananass message prefixed with an icon.
  *
  * @example
  * console.log(bananass('Hello, Bananass.'));
  * // Output: (icon?) Hello, Bananass. (displayed in yellow text in the terminal.)
  */
 export function bananass(str, showIcon = false) {
-  return format(str, showIcon, 'yellow', bananassIcon);
+    return format(str, showIcon, 'yellow', bananassIcon);
 }

package/package.json

@@ -1,32 +1,32 @@
 {
   "name": "bananass-utils-console",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "type": "module",
   "description": "Console Utilities for Bananass Framework.🍌",
   "exports": {
     "./icons": {
-      "types": "./build/icons/index.d.ts",
-      "default": "./src/icons/index.js"
+      "types": "./build/icons.d.ts",
+      "default": "./build/icons.js"
     },
     "./is-interactive": {
-      "types": "./build/is-interactive/index.d.ts",
-      "default": "./src/is-interactive/index.js"
+      "types": "./build/is-interactive.d.ts",
+      "default": "./build/is-interactive.js"
     },
     "./is-unicode-supported": {
-      "types": "./build/is-unicode-supported/index.d.ts",
-      "default": "./src/is-unicode-supported/index.js"
+      "types": "./build/is-unicode-supported.d.ts",
+      "default": "./build/is-unicode-supported.js"
     },
     "./logger": {
-      "types": "./build/logger/index.d.ts",
-      "default": "./src/logger/index.js"
+      "types": "./build/logger.d.ts",
+      "default": "./build/logger.js"
     },
     "./spinner": {
-      "types": "./build/spinner/index.d.ts",
-      "default": "./src/spinner/index.js"
+      "types": "./build/spinner.d.ts",
+      "default": "./build/spinner.js"
     },
     "./theme": {
-      "types": "./build/theme/index.d.ts",
-      "default": "./src/theme/index.js"
+      "types": "./build/theme.d.ts",
+      "default": "./build/theme.js"
     },
     "./package.json": "./package.json"
   },
@@ -36,32 +36,29 @@
         "./build/*"
       ],
       "icons": [
-        "./build/icons/index.d.ts"
+        "./build/icons.d.ts"
       ],
       "is-interactive": [
-        "./build/is-interactive/index.d.ts"
+        "./build/is-interactive.d.ts"
       ],
       "is-unicode-supported": [
-        "./build/is-unicode-supported/index.d.ts"
+        "./build/is-unicode-supported.d.ts"
       ],
       "logger": [
-        "./build/logger/index.d.ts"
+        "./build/logger.d.ts"
       ],
       "spinner": [
-        "./build/spinner/index.d.ts"
+        "./build/spinner.d.ts"
       ],
       "theme": [
-        "./build/theme/index.d.ts"
+        "./build/theme.d.ts"
       ]
     }
   },
   "files": [
-    "src",
     "build",
     "LICENSE.md",
-    "README.md",
-    "!src/**/*.test.{js,ts}",
-    "!**/fixtures/**"
+    "README.md"
   ],
   "keywords": [
     "bananass",
@@ -96,7 +93,9 @@
   },
   "scripts": {
     "prepublishOnly": "npm run build",
-    "build": "tsc && node ../../scripts/cp.js ../../LICENSE.md LICENSE.md ../../README.md README.md",
-    "test": "node --test"
+    "build": "tsc -b tsconfig.build.json",
+    "test": "npm run test:types && npm run test:unit",
+    "test:types": "tsc -b tsconfig.json",
+    "test:unit": "node --test"
   }
 }

package/build/icons/icons.d.ts

@@ -1,28 +0,0 @@
-/** @type {string} */
-export const successIcon: string;
-/** @type {string} */
-export const errorIcon: string;
-/** @type {string} */
-export const warningIcon: string;
-/** @type {string} */
-export const infoIcon: string;
-/** @type {string} */
-export const bananassIcon: string;
-/** @type {string} U+2022: "Bullet" (•) */
-export const bulletIcon: string;
-/** @type {string} U+2500: "Box Drawings Light Horizontal" (─) */
-export const boxDrawingsLightHorizontalIcon: string;
-/** @type {string} */
-export const successText: string;
-/** @type {string} */
-export const errorText: string;
-/** @type {string} */
-export const warningText: string;
-/** @type {string} */
-export const infoText: string;
-/** @type {SpinnerStyle} */
-export const defaultSpinner: SpinnerStyle;
-export type SpinnerStyle = {
-    frames: string[];
-    interval: number;
-};

package/build/icons/index.d.ts

@@ -1 +0,0 @@
-export * from "./icons.js";

package/build/is-interactive/index.d.ts

@@ -1,2 +0,0 @@
-export default isInteractive;
-import isInteractive from './is-interactive.js';

package/build/is-unicode-supported/index.d.ts

@@ -1,2 +0,0 @@
-export default isUnicodeSupported;
-import isUnicodeSupported from './is-unicode-supported.js';

package/build/logger/index.d.ts

@@ -1,2 +0,0 @@
-export default createLogger;
-import createLogger from './logger.js';

package/build/spinner/index.d.ts

@@ -1,2 +0,0 @@
-export default createSpinner;
-import createSpinner from './spinner.js';

package/build/theme/index.d.ts

@@ -1 +0,0 @@
-export * from "./theme.js";

package/build/theme/theme.d.ts

@@ -1,60 +0,0 @@
-/**
- * Returns a green-colored success message prefixed with an icon.
- *
- * @param {string} str The success message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a green-colored success message prefixed with an icon.
- *
- * @example
- * console.log(complete('Operation successful.'));
- * // Output: (icon?) Operation successful. (displayed in green text in the terminal.)
- */
-export function success(str: string, showIcon?: boolean): string;
-/**
- * Returns a red-colored error message prefixed with an icon.
- *
- * @param {string} str The error message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a red-colored error message prefixed with an icon.
- *
- * @example
- * console.log(error('Something went wrong.'));
- * // Output: (icon?) Something went wrong. (displayed in red text in the terminal.)
- */
-export function error(str: string, showIcon?: boolean): string;
-/**
- * Returns a yellow-colored warning message prefixed with an icon.
- *
- * @param {string} str The warning message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a yellow-colored warning message prefixed with an icon.
- *
- * @example
- * console.log(warning('This is a warning.'));
- * // Output: (icon?) This is a warning. (displayed in yellow text in the terminal.)
- */
-export function warning(str: string, showIcon?: boolean): string;
-/**
- * Returns a blue-colored info message prefixed with an icon.
- *
- * @param {string} str The info message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns {string} Returns a blue-colored info message prefixed with an icon.
- *
- * @example
- * console.log(info('Informational message.'));
- * // Output: (icon?) Informational message. (displayed in blue text in the terminal.)
- */
-export function info(str: string, showIcon?: boolean): string;
-/**
- * Returns a yellow-colored error message prefixed with an icon.
- *
- * @param {string} str The bananass message to format.
- * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
- * @returns Returns a yellow-colored error message prefixed with an icon.
- *
- * @example
- * console.log(bananass('Hello, Bananass.'));
- * // Output: (icon?) Hello, Bananass. (displayed in yellow text in the terminal.)
- */
-export function bananass(str: string, showIcon?: boolean): string;

package/src/icons/index.js

@@ -1 +0,0 @@
-export * from './icons.js';

package/src/is-interactive/index.js

@@ -1,3 +0,0 @@
-import isInteractive from './is-interactive.js';
-
-export default isInteractive;

package/src/is-unicode-supported/index.js

@@ -1,3 +0,0 @@
-import isUnicodeSupported from './is-unicode-supported.js';
-
-export default isUnicodeSupported;

package/src/logger/index.js

@@ -1,3 +0,0 @@
-import createLogger from './logger.js';
-
-export default createLogger;

package/src/logger/logger.js

@@ -1,208 +0,0 @@
-/**
- * @fileoverview Console logger.
- * @module bananass-utils-console/logger
- */
-
-// --------------------------------------------------------------------------------
-// Import
-// --------------------------------------------------------------------------------
-
-import { styleText } from 'node:util';
-
-// --------------------------------------------------------------------------------
-// Typedefs
-// --------------------------------------------------------------------------------
-
-/**
- * @typedef {object} Options Logger options.
- * @property {boolean | undefined} [debug] Enable debug mode.
- * @property {boolean | undefined} [quiet] Enable quiet mode.
- * @property {string | boolean | undefined} [textPrefix] Text prefix.
- */
-
-// --------------------------------------------------------------------------------
-// Class
-// --------------------------------------------------------------------------------
-
-class Logger {
-  // ------------------------------------------------------------------------------
-  // Private Properties
-  // ------------------------------------------------------------------------------
-
-  /** @type {boolean} */
-  #debug;
-  /** @type {boolean} */
-  #quiet;
-  /** @type {string | symbol} */
-  #textPrefix;
-  /** @type {string} */
-  #textPrefixDefault = '>';
-  /** @type {'log' | 'debug'} */
-  #lastMethodCalled = 'log';
-  /** @type {symbol} */
-  #undeclaredValue = Symbol('undeclared-value');
-
-  /** @param {Options} options */
-  constructor(options = {}) {
-    this.#debug = options.debug ?? false;
-    this.#quiet = options.quiet ?? false;
-    this.#textPrefix =
-      typeof options.textPrefix === 'boolean'
-        ? options.textPrefix
-          ? this.#textPrefixDefault
-          : this.#undeclaredValue
-        : (options.textPrefix ?? this.#textPrefixDefault);
-  }
-
-  // ------------------------------------------------------------------------------
-  // Public Methods
-  // ------------------------------------------------------------------------------
-
-  /**
-   * Log a message or executes a callback.
-   *
-   * The first parameter can be a message or a callback function.
-   * - If it's a function, it's invoked with subsequent arguments.
-   * - Otherwise, the message (with a configured text prefix) and additional arguments are logged.
-   *
-   * Behavior based on `quiet` option:
-   * - `quiet === true`: output X
-   * - `quiet === false`: output O
-   *
-   * @param {...unknown} params
-   * @returns {Logger}
-   */
-  log(...params) {
-    const textOrCallback =
-      typeof params[0] !== 'undefined' // Same with default parameter implemetation using `arguments`
-        ? params[0]
-        : params.length > 0
-          ? undefined
-          : this.#undeclaredValue;
-    const args = params.slice(1);
-
-    this.#lastMethodCalled = 'log';
-
-    if (this.#quiet) return this;
-
-    if (typeof textOrCallback === 'function') {
-      textOrCallback(...args);
-    } else {
-      // eslint-disable-next-line no-console -- Needed for logging.
-      console.log(
-        ...[this.#textPrefix, textOrCallback, ...args].filter(
-          arg => arg !== this.#undeclaredValue,
-        ),
-      );
-    }
-
-    return this;
-  }
-
-  /**
-   * Log a message or executes a callback in debug mode.
-   *
-   * The first parameter can be a message or a callback function.
-   * - If it's a function, it's invoked with subsequent arguments.
-   * - Otherwise, the message (with a configured text prefix) and additional arguments are logged in debug mode.
-   *
-   * Behavior based on `debug` and `quiet` options:
-   * - `quiet === true`: output X
-   * - `quiet === false && debug === true`: output O
-   * - `quiet === false && debug === false`: output X
-   *
-   * @param {...unknown} params
-   * @returns {Logger}
-   */
-  debug(...params) {
-    const textOrCallback =
-      typeof params[0] !== 'undefined'
-        ? params[0]
-        : params.length > 0
-          ? undefined
-          : this.#undeclaredValue;
-    const args = params.slice(1);
-
-    this.#lastMethodCalled = 'debug';
-
-    if (this.#quiet) return this;
-    if (!this.#debug) return this;
-
-    if (typeof textOrCallback === 'function') {
-      textOrCallback(...args);
-    } else {
-      // eslint-disable-next-line no-console -- Needed for logging.
-      console.log(
-        ...[this.#textPrefix, textOrCallback, ...args]
-          .filter(arg => arg !== this.#undeclaredValue)
-          .map(arg => (typeof arg === 'string' ? styleText('gray', arg) : arg)),
-      );
-    }
-
-    return this;
-  }
-
-  /**
-   * Ends the current line by logging an empty line using the last method called.
-   *
-   * This method temporarily sets the text prefix to an undeclared value,
-   * then invokes either `log()` or `debug()` depending on the previously method called.
-   * After logging, it restores the original text prefix.
-   *
-   * @returns {Logger}
-   */
-  eol() {
-    const prevTextPrefix = this.#textPrefix;
-    this.#textPrefix = this.#undeclaredValue;
-
-    if (this.#lastMethodCalled === 'log') {
-      this.log();
-    } else {
-      this.debug();
-    }
-
-    this.#textPrefix = prevTextPrefix;
-
-    return this;
-  }
-
-  // ------------------------------------------------------------------------------
-  // Getters and Setters
-  // ------------------------------------------------------------------------------
-
-  /**
-   * Get the last method called.
-   * @returns {'log' | 'debug'}
-   */
-  get lastMethodCalled() {
-    return this.#lastMethodCalled;
-  }
-}
-
-// --------------------------------------------------------------------------------
-// Export
-// --------------------------------------------------------------------------------
-
-/**
- * Create a new `Logger` instance.
- *
- * @param {Options} [options]
- * @returns {Logger} A new `Logger` instance.
- *
- * @example
- * import createLogger from 'bananass-utils-console/logger';
- *
- * const logger = createLogger({
- *   debug: false,
- *   quiet: false,
- *   textPrefix: '>',
- * })
- *
- * logger
- *   .log('Hello, log!');
- *   .debug('Hello, debug!');
- *   .eol();
- */
-export default function createLogger(options) {
-  return new Logger(options);
-}

package/src/spinner/index.js

@@ -1,3 +0,0 @@
-import createSpinner from './spinner.js';
-
-export default createSpinner;