bananass-utils-console 0.3.0 → 0.4.0

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

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

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

@@ -0,0 +1,21 @@
+/**
+ * @fileoverview Check if stdout or stderr is interactive.
+ * @module bananass-utils-console/is-interactive
+ * @license MIT Portions of this code were borrowed from [`is-interactive`](https://github.com/sindresorhus/is-interactive).
+ */
+/**
+ * Check if stdout or stderr is [interactive](https://unix.stackexchange.com/a/43389/7678).
+ *
+ * It checks that the stream is [TTY](https://jameshfisher.com/2017/12/09/what-is-a-tty/), not a dumb terminal, and not running in a CI.
+ *
+ * This can be useful to decide whether to present interactive UI or animations in the terminal.
+ * @param {NodeJS.WriteStream} [stream] The stream to check. (default: `process.stdout`)
+ * @returns {boolean}
+ * @example
+ * ```
+ * import isInteractive from 'bananass-utils-console/is-interactive';
+ *
+ * isInteractive(); // true
+ * ```
+ */
+export default function isInteractive(stream?: NodeJS.WriteStream): boolean;

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

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

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

@@ -0,0 +1,20 @@
+/**
+ * Detect whether the terminal supports Unicode.
+ *
+ * This can be useful to decide whether to use Unicode characters or
+ * fallback ASCII characters in command-line output.
+ *
+ * Note that the check is quite naive.
+ * It just assumes all non-Windows terminals support Unicode and hard-codes
+ * which Windows terminals that do support Unicode.
+ * However, I have been using this logic in some popular packages for years without problems.
+ *
+ * @returns {boolean} Returns a `boolean` for whether the terminal supports Unicode.
+ * @example
+ * ```
+ * import isUnicodeSupported from 'bananass-utils-console/is-unicode-supported';
+ *
+ * isUnicodeSupported(); // true
+ * ```
+ */
+export default function isUnicodeSupported(): boolean;

package/build/spinner/spinner.d.ts

@@ -22,7 +22,7 @@
  * }, 2000);
  */
 export default function createSpinner(options?: Options): Spinner;
-export type ForegroundColorName = "black" | "red" | "green" | "yellow" | "blue" | "cyan" | "magenta" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "cyanBright" | "magentaBright" | "whiteBright";
+export type ForegroundColors = "black" | "blackBright" | "blue" | "blueBright" | "cyan" | "cyanBright" | "gray" | "green" | "greenBright" | "grey" | "magenta" | "magentaBright" | "red" | "redBright" | "white" | "whiteBright" | "yellow" | "yellowBright";
 export type SpinnerStyle = {
     frames: string[];
     interval?: number;
@@ -38,7 +38,7 @@ export type Options = {
     /**
      * The color of the spinner. (default: `'yellow'`)
      */
-    color?: ForegroundColorName;
+    color?: ForegroundColors;
     /**
      * The stream to which the spinner is written. (default: `process.stderr`)
      */
@@ -62,7 +62,7 @@ export type Options = {
     spinner?: SpinnerStyle;
 };
 /**
- * @typedef {'black'|'red'|'green'|'yellow'|'blue'|'cyan'|'magenta'|'white'|'gray'|'grey'|'blackBright'|'redBright'|'greenBright'|'yellowBright'|'blueBright'|'cyanBright'|'magentaBright'|'whiteBright'} ForegroundColorName
+ * @typedef {"black"|"blackBright"|"blue"|"blueBright"|"cyan"|"cyanBright"|"gray"|"green"|"greenBright"|"grey"|"magenta"|"magentaBright"|"red"|"redBright"|"white"|"whiteBright"|"yellow"|"yellowBright"} ForegroundColors
  */
 /**
  * @typedef {object} SpinnerStyle
@@ -72,7 +72,7 @@ export type Options = {
 /**
  * @typedef {object} Options Spinner options.
  * @property {string} [text] Text to display next to the spinner. (default: `''`)
- * @property {ForegroundColorName} [color] The color of the spinner. (default: `'yellow'`)
+ * @property {ForegroundColors} [color] The color of the spinner. (default: `'yellow'`)
  * @property {NodeJS.WriteStream} [stream] The stream to which the spinner is written. (default: `process.stderr`)
  * @property {boolean} [isInteractive] Whether the spinner should be interactive. (default: Auto-detected)
  * @property {SpinnerStyle} [spinner]
@@ -159,11 +159,11 @@ declare class Spinner {
     /**
      * Change the spinner color.
      */
-    set color(value: ForegroundColorName);
+    set color(value: ForegroundColors);
     /**
      * Change the spinner color.
      */
-    get color(): ForegroundColorName;
+    get color(): ForegroundColors;
     /**
      * Returns whether the spinner is currently spinning.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bananass-utils-console",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Console Utilities for Bananass Framework.🍌",
   "exports": {
@@ -8,6 +8,14 @@
       "types": "./build/icons/index.d.ts",
       "default": "./src/icons/index.js"
     },
+    "./is-interactive": {
+      "types": "./build/is-interactive/index.d.ts",
+      "default": "./src/is-interactive/index.js"
+    },
+    "./is-unicode-supported": {
+      "types": "./build/is-unicode-supported/index.d.ts",
+      "default": "./src/is-unicode-supported/index.js"
+    },
     "./logger": {
       "types": "./build/logger/index.d.ts",
       "default": "./src/logger/index.js"
@@ -30,6 +38,12 @@
       "icons": [
         "./build/icons/index.d.ts"
       ],
+      "is-interactive": [
+        "./build/is-interactive/index.d.ts"
+      ],
+      "is-unicode-supported": [
+        "./build/is-unicode-supported/index.d.ts"
+      ],
       "logger": [
         "./build/logger/index.d.ts"
       ],
@@ -84,10 +98,5 @@
     "build": "npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
     "test": "node --test"
   },
-  "dependencies": {
-    "chalk": "^5.4.1",
-    "is-interactive": "^2.0.0",
-    "is-unicode-supported": "^2.1.0"
-  },
-  "gitHead": "7fea6da59ab3a9d9fba47425878281ea91486e5f"
+  "gitHead": "9ef4b5d85c599fd179cd90de4619668d6ee6867f"
 }

package/src/icons/icons.js

@@ -6,8 +6,8 @@
 // Import
 // --------------------------------------------------------------------------------
 
-import c from 'chalk';
-import isUnicodeSupported from 'is-unicode-supported';
+import { styleText } from 'node:util';
+import isUnicodeSupported from '../is-unicode-supported/index.js';
 
 // --------------------------------------------------------------------------------
 // Typedef
@@ -35,13 +35,13 @@ const choose = (unicode, ascii) => (isUnicodeSupported() ? unicode : ascii);
 // --------------------------------------------------------------------------------
 
 /** @type {string} */
-export const successIcon = c.green.bold(choose('✓', 'V'));
+export const successIcon = styleText(['green', 'bold'], choose('✓', 'V'));
 /** @type {string} */
-export const errorIcon = c.red.bold(choose('✕', 'X'));
+export const errorIcon = styleText(['red', 'bold'], choose('✕', 'X'));
 /** @type {string} */
-export const warningIcon = c.yellow.bold(choose('⚠', '!'));
+export const warningIcon = styleText(['yellow', 'bold'], choose('⚠', '!'));
 /** @type {string} */
-export const infoIcon = c.blue.bold(choose('✦', 'i'));
+export const infoIcon = styleText(['blue', 'bold'], choose('✦', 'i'));
 /** @type {string} */
 export const bananassIcon = choose('🍌', '');
 /** @type {string} U+2022: "Bullet" (•) */
@@ -52,13 +52,19 @@ export const boxDrawingsLightHorizontalIcon = choose('\u2500', '-');
 // --------------------------------------------------------------------------------
 
 /** @type {string} */
-export const successText = c.white.bgGreen.bold(` ${successIcon} SUCCESS `);
+export const successText = styleText(
+  ['white', 'bgGreen', 'bold'],
+  ` ${successIcon} SUCCESS `,
+);
 /** @type {string} */
-export const errorText = c.white.bgRed.bold(` ${errorIcon} ERROR `);
+export const errorText = styleText(['white', 'bgRed', 'bold'], ` ${errorIcon} ERROR `);
 /** @type {string} */
-export const warningText = c.white.bgYellow.bold(` ${warningIcon} WARN `);
+export const warningText = styleText(
+  ['white', 'bgYellow', 'bold'],
+  ` ${warningIcon} WARN `,
+);
 /** @type {string} */
-export const infoText = c.white.bgBlue.bold(` ${infoIcon} INFO `);
+export const infoText = styleText(['white', 'bgBlue', 'bold'], ` ${infoIcon} INFO `);
 
 // --------------------------------------------------------------------------------
 

package/src/is-interactive/index.js

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

package/src/is-interactive/is-interactive.js

@@ -0,0 +1,30 @@
+/**
+ * @fileoverview Check if stdout or stderr is interactive.
+ * @module bananass-utils-console/is-interactive
+ * @license MIT Portions of this code were borrowed from [`is-interactive`](https://github.com/sindresorhus/is-interactive).
+ */
+
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+
+/**
+ * Check if stdout or stderr is [interactive](https://unix.stackexchange.com/a/43389/7678).
+ *
+ * It checks that the stream is [TTY](https://jameshfisher.com/2017/12/09/what-is-a-tty/), not a dumb terminal, and not running in a CI.
+ *
+ * This can be useful to decide whether to present interactive UI or animations in the terminal.
+ * @param {NodeJS.WriteStream} [stream] The stream to check. (default: `process.stdout`)
+ * @returns {boolean}
+ * @example
+ * ```
+ * import isInteractive from 'bananass-utils-console/is-interactive';
+ *
+ * isInteractive(); // true
+ * ```
+ */
+export default function isInteractive(stream = process.stdout) {
+  return Boolean(
+    stream && stream.isTTY && process.env.TERM !== 'dumb' && !('CI' in process.env),
+  );
+}

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

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

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

@@ -0,0 +1,56 @@
+/**
+ * @fileoverview Detect whether the terminal supports Unicode.
+ * @module bananass-utils-console/is-unicode-supported
+ * @license MIT Portions of this code were borrowed from [`is-unicode-supported`](https://github.com/sindresorhus/is-unicode-supported).
+ */
+
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+
+import process from 'node:process';
+
+// --------------------------------------------------------------------------------
+// Export
+// --------------------------------------------------------------------------------
+
+/**
+ * Detect whether the terminal supports Unicode.
+ *
+ * This can be useful to decide whether to use Unicode characters or
+ * fallback ASCII characters in command-line output.
+ *
+ * Note that the check is quite naive.
+ * It just assumes all non-Windows terminals support Unicode and hard-codes
+ * which Windows terminals that do support Unicode.
+ * However, I have been using this logic in some popular packages for years without problems.
+ *
+ * @returns {boolean} Returns a `boolean` for whether the terminal supports Unicode.
+ * @example
+ * ```
+ * import isUnicodeSupported from 'bananass-utils-console/is-unicode-supported';
+ *
+ * isUnicodeSupported(); // true
+ * ```
+ */
+export default function isUnicodeSupported() {
+  const { env } = process;
+  const { TERM, TERM_PROGRAM } = env;
+
+  if (process.platform !== 'win32') {
+    return TERM !== 'linux'; // Linux console (kernel)
+  }
+
+  return (
+    Boolean(env.WT_SESSION) || // Windows Terminal
+    Boolean(env.TERMINUS_SUBLIME) || // Terminus (<0.2.27)
+    env.ConEmuTask === '{cmd::Cmder}' || // ConEmu and cmder
+    TERM_PROGRAM === 'Terminus-Sublime' ||
+    TERM_PROGRAM === 'vscode' ||
+    TERM === 'xterm-256color' ||
+    TERM === 'alacritty' ||
+    TERM === 'rxvt-unicode' ||
+    TERM === 'rxvt-unicode-256color' ||
+    env.TERMINAL_EMULATOR === 'JetBrains-JediTerm'
+  );
+}

package/src/logger/logger.js

@@ -7,7 +7,7 @@
 // Import
 // --------------------------------------------------------------------------------
 
-import c from 'chalk';
+import { styleText } from 'node:util';
 
 // --------------------------------------------------------------------------------
 // Typedefs
@@ -135,7 +135,7 @@ class Logger {
       console.log(
         ...[this.#textPrefix, textOrCallback, ...args]
           .filter(arg => arg !== this.#undeclaredValue)
-          .map(arg => (typeof arg === 'string' ? c.gray(arg) : arg)),
+          .map(arg => (typeof arg === 'string' ? styleText('gray', arg) : arg)),
       );
     }
 

package/src/spinner/spinner.js

@@ -1,16 +1,15 @@
 /**
  * @fileoverview Console spinner.
  * @module bananass-utils-console/spinner
- * @see https://github.com/sindresorhus/yocto-spinner/tree/v0.1.2 `yocto-spinner` package `v0.1.2`.
+ * @license MIT Portions of this code were borrowed from [`yocto-spinner`](https://github.com/sindresorhus/yocto-spinner).
  */
 
 // --------------------------------------------------------------------------------
 // Import
 // --------------------------------------------------------------------------------
 
-import c from 'chalk';
-import isInteractive from 'is-interactive';
-
+import { styleText } from 'node:util';
+import isInteractive from '../is-interactive/index.js';
 import {
   successIcon,
   errorIcon,
@@ -24,7 +23,7 @@ import {
 // --------------------------------------------------------------------------------
 
 /**
- * @typedef {'black'|'red'|'green'|'yellow'|'blue'|'cyan'|'magenta'|'white'|'gray'|'grey'|'blackBright'|'redBright'|'greenBright'|'yellowBright'|'blueBright'|'cyanBright'|'magentaBright'|'whiteBright'} ForegroundColorName
+ * @typedef {"black"|"blackBright"|"blue"|"blueBright"|"cyan"|"cyanBright"|"gray"|"green"|"greenBright"|"grey"|"magenta"|"magentaBright"|"red"|"redBright"|"white"|"whiteBright"|"yellow"|"yellowBright"} ForegroundColors
  */
 
 /**
@@ -36,7 +35,7 @@ import {
 /**
  * @typedef {object} Options Spinner options.
  * @property {string} [text] Text to display next to the spinner. (default: `''`)
- * @property {ForegroundColorName} [color] The color of the spinner. (default: `'yellow'`)
+ * @property {ForegroundColors} [color] The color of the spinner. (default: `'yellow'`)
  * @property {NodeJS.WriteStream} [stream] The stream to which the spinner is written. (default: `process.stderr`)
  * @property {boolean} [isInteractive] Whether the spinner should be interactive. (default: Auto-detected)
  * @property {SpinnerStyle} [spinner]
@@ -73,7 +72,7 @@ class Spinner {
   #text;
   /** @type {NodeJS.WriteStream} */
   #stream;
-  /** @type {ForegroundColorName} */
+  /** @type {ForegroundColors} */
   #color;
   /** @type {number} */
   #lines = 0;
@@ -93,8 +92,7 @@ class Spinner {
     this.#text = options.text ?? '';
     this.#stream = options.stream ?? process.stderr;
     this.#color = options.color ?? 'yellow';
-    this.#isInteractive =
-      options.isInteractive ?? isInteractive({ stream: this.#stream });
+    this.#isInteractive = options.isInteractive ?? isInteractive(this.#stream);
     this.#exitHandlerBound = this.#exitHandler.bind(this);
   }
 
@@ -119,9 +117,9 @@ class Spinner {
       this.#lastSpinnerFrameTime = currentTime;
     }
 
-    const applyColor = c[this.#color] ?? c.yellow;
+    const color = this.#color ?? 'yellow';
     const frame = this.#frames[this.#currentFrame];
-    let string = `${applyColor(frame)} ${this.#text}`;
+    let string = `${styleText(color, frame)} ${this.#text}`;
 
     if (!this.#isInteractive) {
       string += '\n';

package/src/theme/theme.js

@@ -7,7 +7,7 @@
 // Import
 // --------------------------------------------------------------------------------
 
-import c from 'chalk';
+import { styleText } from 'node:util';
 import {
   successText,
   errorText,
@@ -22,16 +22,15 @@ import {
 
 /**
  * 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 {function} color The function to apply color to the string.
+ * @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.
  * @private
  */
 const format = (str, showIcon, color, icon) =>
-  `${showIcon ? `${icon} ` : ''}${color(str)}`;
+  `${showIcon ? `${icon} ` : ''}${styleText(color, str)}`;
 
 // --------------------------------------------------------------------------------
 // Export
@@ -49,7 +48,7 @@ const format = (str, showIcon, color, icon) =>
  * // Output: (icon?) Operation successful. (displayed in green text in the terminal.)
  */
 export function success(str, showIcon = false) {
-  return format(str, showIcon, c.green, successText);
+  return format(str, showIcon, 'green', successText);
 }
 
 /**
@@ -64,7 +63,7 @@ export function success(str, showIcon = false) {
  * // Output: (icon?) Something went wrong. (displayed in red text in the terminal.)
  */
 export function error(str, showIcon = false) {
-  return format(str, showIcon, c.red, errorText);
+  return format(str, showIcon, 'red', errorText);
 }
 
 /**
@@ -79,7 +78,7 @@ export function error(str, showIcon = false) {
  * // Output: (icon?) This is a warning. (displayed in yellow text in the terminal.)
  */
 export function warning(str, showIcon = false) {
-  return format(str, showIcon, c.yellow, warningText);
+  return format(str, showIcon, 'yellow', warningText);
 }
 
 /**
@@ -94,7 +93,7 @@ export function warning(str, showIcon = false) {
  * // Output: (icon?) Informational message. (displayed in blue text in the terminal.)
  */
 export function info(str, showIcon = false) {
-  return format(str, showIcon, c.blue, infoText);
+  return format(str, showIcon, 'blue', infoText);
 }
 
 /**
@@ -109,5 +108,5 @@ export function info(str, showIcon = false) {
  * // Output: (icon?) Hello, Bananass. (displayed in yellow text in the terminal.)
  */
 export function bananass(str, showIcon = false) {
-  return format(str, showIcon, c.yellow, bananassIcon);
+  return format(str, showIcon, 'yellow', bananassIcon);
 }