bananass-utils-console 0.4.0 → 0.5.0

package/README.md

@@ -137,16 +137,16 @@ npm create bananass@latest
 
 다만, 올바른 커뮤니티 환경을 준수하고 더 나은 오픈 소스를 만들기 위해, 바나나 프레임워크에 기여하기 전 반드시 아래 내용들을 확인해주세요.
 
-- [기여자 행동 강령 규약](CODE_OF_CONDUCT.md)
+- [기여자 행동 강령 규약](https://github.com/lumirlumir/.github/blob/main/CODE_OF_CONDUCT_KO.md#%EA%B8%B0%EC%97%AC%EC%9E%90-%ED%96%89%EB%8F%99-%EA%B0%95%EB%A0%B9-%EA%B7%9C%EC%95%BD)
 - [기여하기](CONTRIBUTING.md)
 
 ## 버전 정책<sup>Versioning</sup>
 
-바나나 프레임워크는 [유의적 버전 정책<sup>Sementic Versioning</sup>](https://semver.org/lang/ko/)을 따릅니다. 모든 릴리즈 버전은 `주(MAJOR).부(MINOR).수(PATCH)` 형식을 따릅니다.
+바나나 프레임워크는 [유의적 버전 정책<sup>Semantic Versioning</sup>](https://semver.org/lang/ko/)을 따릅니다. 모든 릴리즈 버전은 `주(MAJOR).부(MINOR).수(PATCH)` 형식을 따릅니다.
 
 ## 기여자 행동 강령 규약<sup>Code of Conduct</sup>
 
-커뮤니티에 기여하기 전, [기여자 행동 강령 규약](CODE_OF_CONDUCT.md)을 참고해주세요.
+커뮤니티에 기여하기 전, [기여자 행동 강령 규약](https://github.com/lumirlumir/.github/blob/main/CODE_OF_CONDUCT_KO.md#%EA%B8%B0%EC%97%AC%EC%9E%90-%ED%96%89%EB%8F%99-%EA%B0%95%EB%A0%B9-%EA%B7%9C%EC%95%BD)을 참고해주세요.
 
 ## 변경 사항<sup>Change Log</sup>
 

package/build/icons/icons.d.ts

@@ -24,5 +24,5 @@ export const infoText: string;
 export const defaultSpinner: SpinnerStyle;
 export type SpinnerStyle = {
     frames: string[];
-    interval?: number;
+    interval: number;
 };

package/build/logger/logger.d.ts

@@ -1,7 +1,7 @@
 /**
  * Create a new `Logger` instance.
  *
- * @param {Options} options
+ * @param {Options} [options]
  * @returns {Logger} A new `Logger` instance.
  *
  * @example
@@ -18,7 +18,7 @@
  *   .debug('Hello, debug!');
  *   .eol();
  */
-export default function createLogger(options: Options): Logger;
+export default function createLogger(options?: Options): Logger;
 /**
  * Logger options.
  */
@@ -26,21 +26,21 @@ export type Options = {
     /**
      * Enable debug mode.
      */
-    debug?: boolean;
+    debug?: boolean | undefined;
     /**
      * Enable quiet mode.
      */
-    quiet?: boolean;
+    quiet?: boolean | undefined;
     /**
      * Text prefix.
      */
-    textPrefix?: string | boolean;
+    textPrefix?: string | boolean | undefined;
 };
 /**
  * @typedef {object} Options Logger options.
- * @property {boolean} [debug] Enable debug mode.
- * @property {boolean} [quiet] Enable quiet mode.
- * @property {string | boolean} [textPrefix] Text prefix.
+ * @property {boolean | undefined} [debug] Enable debug mode.
+ * @property {boolean | undefined} [quiet] Enable quiet mode.
+ * @property {string | boolean | undefined} [textPrefix] Text prefix.
  */
 declare class Logger {
     /** @param {Options} options */
@@ -56,10 +56,10 @@ declare class Logger {
      * - `quiet === true`: output X
      * - `quiet === false`: output O
      *
-     * @param {...any} params
+     * @param {...unknown} params
      * @returns {Logger}
      */
-    log(...params: any[]): Logger;
+    log(...params: unknown[]): Logger;
     /**
      * Log a message or executes a callback in debug mode.
      *
@@ -72,10 +72,10 @@ declare class Logger {
      * - `quiet === false && debug === true`: output O
      * - `quiet === false && debug === false`: output X
      *
-     * @param {...any} params
+     * @param {...unknown} params
      * @returns {Logger}
      */
-    debug(...params: any[]): Logger;
+    debug(...params: unknown[]): Logger;
     /**
      * Ends the current line by logging an empty line using the last method called.
      *
@@ -88,7 +88,6 @@ declare class Logger {
     eol(): Logger;
     /**
      * Get the last method called.
-     *
      * @returns {'log' | 'debug'}
      */
     get lastMethodCalled(): "log" | "debug";

package/build/spinner/spinner.d.ts

@@ -25,7 +25,7 @@ export default function createSpinner(options?: Options): Spinner;
 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;
+    interval: number;
 };
 /**
  * Spinner options.
@@ -34,19 +34,19 @@ export type Options = {
     /**
      * Text to display next to the spinner. (default: `''`)
      */
-    text?: string;
+    text?: string | undefined;
     /**
      * The color of the spinner. (default: `'yellow'`)
      */
-    color?: ForegroundColors;
+    color?: ForegroundColors | undefined;
     /**
      * The stream to which the spinner is written. (default: `process.stderr`)
      */
-    stream?: NodeJS.WriteStream;
+    stream?: NodeJS.WriteStream | undefined;
     /**
      * Whether the spinner should be interactive. (default: Auto-detected)
      */
-    isInteractive?: boolean;
+    isInteractive?: boolean | undefined;
     /**
      * Customize the spinner animation with a custom set of frames and interval.
      *
@@ -59,7 +59,7 @@ export type Options = {
      *
      * Pass in any spinner from [`cli-spinners`](https://github.com/sindresorhus/cli-spinners).
      */
-    spinner?: SpinnerStyle;
+    spinner?: SpinnerStyle | undefined;
 };
 /**
  * @typedef {"black"|"blackBright"|"blue"|"blueBright"|"cyan"|"cyanBright"|"gray"|"green"|"greenBright"|"grey"|"magenta"|"magentaBright"|"red"|"redBright"|"white"|"whiteBright"|"yellow"|"yellowBright"} ForegroundColors
@@ -67,15 +67,15 @@ export type Options = {
 /**
  * @typedef {object} SpinnerStyle
  * @property {string[]} frames
- * @property {number} [interval]
+ * @property {number} interval
  */
 /**
  * @typedef {object} Options Spinner options.
- * @property {string} [text] Text to display next to the spinner. (default: `''`)
- * @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]
+ * @property {string | undefined} [text] Text to display next to the spinner. (default: `''`)
+ * @property {ForegroundColors | undefined} [color] The color of the spinner. (default: `'yellow'`)
+ * @property {NodeJS.WriteStream | undefined} [stream] The stream to which the spinner is written. (default: `process.stderr`)
+ * @property {boolean | undefined} [isInteractive] Whether the spinner should be interactive. (default: Auto-detected)
+ * @property {SpinnerStyle | undefined} [spinner]
  * Customize the spinner animation with a custom set of frames and interval.
  *
  * ```

package/build/theme/theme.d.ts

@@ -2,7 +2,7 @@
  * 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a green-colored success message prefixed with an icon.
  *
  * @example
@@ -14,7 +14,7 @@ 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a red-colored error message prefixed with an icon.
  *
  * @example
@@ -26,7 +26,7 @@ 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a yellow-colored warning message prefixed with an icon.
  *
  * @example
@@ -38,7 +38,7 @@ 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a blue-colored info message prefixed with an icon.
  *
  * @example
@@ -50,7 +50,7 @@ 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns Returns a yellow-colored error message prefixed with an icon.
  *
  * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bananass-utils-console",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "module",
   "description": "Console Utilities for Bananass Framework.🍌",
   "exports": {
@@ -88,7 +88,7 @@
     "url": "https://github.com/lumirlumir/npm-bananass/issues"
   },
   "engines": {
-    "node": "^20.18.0 || ^22.3.0 || >= 24.0.0"
+    "node": "^20.19.0 || ^22.13.0 || >=24.0.0"
   },
   "publishConfig": {
     "provenance": true
@@ -98,5 +98,5 @@
     "build": "npx tsc && node ../../scripts/cp.mjs ../../LICENSE.md LICENSE.md ../../README.md README.md",
     "test": "node --test"
   },
-  "gitHead": "9ef4b5d85c599fd179cd90de4619668d6ee6867f"
+  "gitHead": "fb88d1af9375f2f49f56402a17216a7a217a6ac0"
 }

package/src/icons/icons.js

@@ -16,7 +16,7 @@ import isUnicodeSupported from '../is-unicode-supported/index.js';
 /**
  * @typedef {object} SpinnerStyle
  * @property {string[]} frames
- * @property {number} [interval]
+ * @property {number} interval
  */
 
 // --------------------------------------------------------------------------------
@@ -24,9 +24,10 @@ import isUnicodeSupported from '../is-unicode-supported/index.js';
 // --------------------------------------------------------------------------------
 
 /**
- * @param {string | string[]} unicode Used when Unicode is supported.
- * @param {string | string[]} ascii Used when Unicode is not supported.
- * @returns {any}
+ * @template {string | string[]} T
+ * @param {T} unicode Used when Unicode is supported.
+ * @param {T} ascii Used when Unicode is not supported.
+ * @returns {T}
  */
 const choose = (unicode, ascii) => (isUnicodeSupported() ? unicode : ascii);
 

package/src/logger/logger.js

@@ -15,9 +15,9 @@ import { styleText } from 'node:util';
 
 /**
  * @typedef {object} Options Logger options.
- * @property {boolean} [debug] Enable debug mode.
- * @property {boolean} [quiet] Enable quiet mode.
- * @property {string | boolean} [textPrefix] Text prefix.
+ * @property {boolean | undefined} [debug] Enable debug mode.
+ * @property {boolean | undefined} [quiet] Enable quiet mode.
+ * @property {string | boolean | undefined} [textPrefix] Text prefix.
  */
 
 // --------------------------------------------------------------------------------
@@ -69,7 +69,7 @@ class Logger {
    * - `quiet === true`: output X
    * - `quiet === false`: output O
    *
-   * @param {...any} params
+   * @param {...unknown} params
    * @returns {Logger}
    */
   log(...params) {
@@ -111,7 +111,7 @@ class Logger {
    * - `quiet === false && debug === true`: output O
    * - `quiet === false && debug === false`: output X
    *
-   * @param {...any} params
+   * @param {...unknown} params
    * @returns {Logger}
    */
   debug(...params) {
@@ -172,7 +172,6 @@ class Logger {
 
   /**
    * Get the last method called.
-   *
    * @returns {'log' | 'debug'}
    */
   get lastMethodCalled() {
@@ -187,7 +186,7 @@ class Logger {
 /**
  * Create a new `Logger` instance.
  *
- * @param {Options} options
+ * @param {Options} [options]
  * @returns {Logger} A new `Logger` instance.
  *
  * @example

package/src/spinner/spinner.js

@@ -29,16 +29,16 @@ import {
 /**
  * @typedef {object} SpinnerStyle
  * @property {string[]} frames
- * @property {number} [interval]
+ * @property {number} interval
  */
 
 /**
  * @typedef {object} Options Spinner options.
- * @property {string} [text] Text to display next to the spinner. (default: `''`)
- * @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]
+ * @property {string | undefined} [text] Text to display next to the spinner. (default: `''`)
+ * @property {ForegroundColors | undefined} [color] The color of the spinner. (default: `'yellow'`)
+ * @property {NodeJS.WriteStream | undefined} [stream] The stream to which the spinner is written. (default: `process.stderr`)
+ * @property {boolean | undefined} [isInteractive] Whether the spinner should be interactive. (default: Auto-detected)
+ * @property {SpinnerStyle | undefined} [spinner]
  * Customize the spinner animation with a custom set of frames and interval.
  *
  * ```
@@ -66,8 +66,8 @@ class Spinner {
   #interval;
   /** @type {number} */
   #currentFrame = -1;
-  /** @type {NodeJS.Timeout} */
-  #timer;
+  /** @type {NodeJS.Timeout | undefined} */
+  #timer = undefined;
   /** @type {string} */
   #text;
   /** @type {NodeJS.WriteStream} */
@@ -100,9 +100,9 @@ class Spinner {
   // Private Methods
   // ------------------------------------------------------------------------------
 
-  /** @param {string} symbol @param {string} text */
-  #symbolStop(symbol, text) {
-    return this.stop(`${symbol} ${text ?? this.#text}`);
+  /** @param {string} symbol @param {string} [text] */
+  #symbolStop(symbol, text = this.#text) {
+    return this.stop(`${symbol} ${text}`);
   }
 
   #render() {

package/src/theme/theme.js

@@ -40,7 +40,7 @@ const format = (str, showIcon, color, icon) =>
  * 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a green-colored success message prefixed with an icon.
  *
  * @example
@@ -55,7 +55,7 @@ export function success(str, showIcon = false) {
  * 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a red-colored error message prefixed with an icon.
  *
  * @example
@@ -70,7 +70,7 @@ export function error(str, showIcon = false) {
  * 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a yellow-colored warning message prefixed with an icon.
  *
  * @example
@@ -85,7 +85,7 @@ export function warning(str, showIcon = false) {
  * 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns {string} Returns a blue-colored info message prefixed with an icon.
  *
  * @example
@@ -100,7 +100,7 @@ export function info(str, showIcon = false) {
  * 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`.
+ * @param {boolean} [showIcon] Whether to show the icon. Defaults to `false`.
  * @returns Returns a yellow-colored error message prefixed with an icon.
  *
  * @example