bananass-utils-console 0.8.0 → 0.9.1

package/README.md

@@ -1,160 +1,18 @@
-# 바나나<sup>Bananass</sup>
+# `bananass-utils-console`
 
-[![ci](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-bananass/ci.yml?label=ci&color=fff478&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-bananass/actions/workflows/ci.yml)
-[![test](https://img.shields.io/github/actions/workflow/status/lumirlumir/npm-bananass/test.yml?label=test&color=fff478&labelColor=333333&logo=github)](https://github.com/lumirlumir/npm-bananass/actions/workflows/test.yml)
-[![Codecov](https://img.shields.io/codecov/c/gh/lumirlumir/npm-bananass?token=2zUCHlMFT3&label=Codecov&color=fff478&labelColor=333333&logo=codecov)](https://codecov.io/gh/lumirlumir/npm-bananass)
-![Node Current](https://img.shields.io/node/v/bananass?label=Node&color=fff478&labelColor=333333&logo=node.js)
+Console Utilities for Bananass Framework.🍌
 
-[![npm package bananass latest version](https://img.shields.io/npm/v/bananass?label=bananass@latest&color=fff478&labelColor=333333&logo=npm)](https://www.npmjs.com/package/bananass)
-[![npm package bananass next version](https://img.shields.io/npm/v/bananass/next?label=bananass@next&color=fff478&labelColor=333333&logo=npm)](https://www.npmjs.com/package/bananass)
+## Documentation
 
-<kbd>한국어</kbd> | <kbd>[English](README.en.md)</kbd>
+- [English](https://bananass.lumir.page/en/)
+- [Korean](https://bananass.lumir.page/)
 
-백준 자바스크립트 프레임워크.
+## Repository
 
-자바스크립트 알고리즘 문제 풀이의 새로운 패러다임.
+- [`bananass-utils-console` monorepo](https://github.com/lumirlumir/npm-bananass)
+- [`bananass-utils-console` package](https://github.com/lumirlumir/npm-bananass/tree/main/packages/bananass-utils-console)
 
-> [!IMPORTANT]
->
-> ```js
-> const whyBananass = {
->   banana: '🍌',
->   bananas: '🍌🍌',
->   bananass: '🍌🍌🍌🍌',
-> }
-> ```
->
-> ```js
-> console.log(('b' + 'a' + +'a' + 'a').toLowerCase() + (!(1/0) + [])[3].repeat(2));
-> ```
+## npm
 
-<!-- markdownlint-disable-next-line md026 -->
-## 안녕, 바나나!
-
-바나나<sup>Bananass</sup> 프레임워크에 오신 것을 환영합니다!
-
-바나나는 **자바스크립트<sup>JavaScript</sup> 및 타입스크립트<sup>TypeScript</sup> 기반의 알고리즘 문제 풀이를 위한 프레임워크**로, [백준](https://www.acmicpc.net/)ㆍ[코드포스](https://codeforces.com/) 등 다양한 문제 풀이 플랫폼들의 Node.js 환경에서 반복적으로 마주치는 문제점들을 해결하며, 간결하고 편리한 사용자 경험을 제공합니다.
-
-- 타입스크립트<sup>TypeScript</sup> 지원이 필요하시다고요?
-- ES16<sup>ES2025</sup> 등 자바스크립트 최신 문법을 쓰고 싶은데 막히셨나요?
-- 외부 라이브러리를 사용하고 싶으신가요?
-- 매번 `readline` / `fs` 템플릿 코드 복붙하기 지치셨나요?
-
-이제 걱정하지 마세요! 바나나 프레임워크는 이런 문제점들을 모두 해결합니다.
-
-## 왜 바나나일까요?
-
-함께 자바스크립트를 이용한 [백준 1000번: A+B](https://www.acmicpc.net/problem/1000) 문제 풀이 예제를 살펴봅시다!
-
-- 기존 방법을 통한 문제 풀이.
-
-    ```js
-    const readline = require('node:readline');
-    const { EOL } = require('node:os');
-
-    let inputStr = '';
-
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    rl.on('line', line => {
-      inputStr = `${inputStr}${line}${EOL}`;
-    }).on('close', () => {
-      console.log(solution(inputStr));
-
-      process.exit(0);
-    });
-
-    function solution(input) {
-      const [a, b] = input
-        .trim()
-        .split(' ')
-        .map(val => Number(val));
-
-      return a + b;
-    }
-    ```
-
-- 바나나 프레임워크를 이용한 문제 풀이.
-
-    ```js
-    function solution(input) {
-      const [a, b] = input
-        .trim()
-        .split(' ')
-        .map(Number);
-
-      return a + b;
-    }
-
-    export default { solution };
-    ```
-
-더 간결하고, 더 직관적인 코드! 입력 처리에 들이던 시간은 줄이고, 오직 알고리즘에만 집중할 수 있습니다.
-
-## 이게 전부인가요?
-
-물론, 아닙니다!
-
-- 자바스크립트<sup>JavaScript</sup> 및 타입스크립트<sup>TypeScript</sup> 지원.
-- ESM<sup>ECMAScript Module</sup> 및 CommonJS 모듈 시스템 지원.
-- 백준 Node.js 환경에 구애받지 않는 ES16<sup>ES2025</sup> 등 최신 문법 지원.
-- 사용자 정의 모듈 및 `lodash` 등 외부 라이브러리 불러오기 지원.
-- 프로그래머스처럼 `solution` 함수 하나로 시작하기 지원.
-- 테스트 케이스 작성 및 실행 지원.
-- `create-bananass`로 시작하기 지원.
-- `fs` 모듈을 사용한 더욱 빠른 입출력 지원.
-- 편의를 위한 다양한 CLI 명령어 지원.
-- 풍부하고 상세한 문서 지원.
-- ESLint 및 Prettier 설정 지원.
-
-어떤가요? 바나나 프레임워크를 통해 더욱 편리한 문제 풀이를 경험해보고 싶지 않으신가요?
-
-## 바나나로 시작하기
-
-[React](https://ko.react.dev)의 `create-react-app`, [Next.js](https://nextjs.org)의 `create-next-app` 처럼, 바나나 프레임워크에서 제공하는 `create-bananass`로 지금 바로 새로운 문제 풀이 패러다임을 경험해보세요!
-
-바나나 프레임워크는 `create-bananass`를 통해 즉시 설치하고 사용할 수 있습니다.
-
-```sh
-npm create bananass@latest
-```
-
-더 자세한 사용법은 [바나나 프레임워크 문서](https://bananass.lumir.page)를 참고해주세요.
-
-## 바나나 프레임워크 문서
-
-바나나 프레임워크는 문서화를 가장 큰 가치로 여깁니다. 바나나 프레임워크의 모든 사용법과 기능은 [바나나 프레임워크 문서](https://bananass.lumir.page)에서 확인하실 수 있습니다.
-
-## 기여(이슈<sup>Issue</sup>, 끌어오기 요청<sup>Pull Request</sup>, 토론<sup>Discussion</sup>)
-
-바나나 프레임워크 기여에 관심을 가져주셔서 감사합니다!
-
-버그<sup>Bug</sup> 및 제안<sup>Suggestion</sup> 등 여러 주제에 대한 이슈<sup>Issue</sup>, 끌어오기 요청<sup>Pull Request</sup>, 토론<sup>Discussion</sup> 등을 모두 환영합니다.
-
-다만, 올바른 커뮤니티 환경을 준수하고 더 나은 오픈 소스를 만들기 위해, 바나나 프레임워크에 기여하기 전 반드시 아래 내용들을 확인해주세요.
-
-- [기여자 행동 강령 규약](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>Semantic Versioning</sup>](https://semver.org/lang/ko/)을 따릅니다. 모든 릴리즈 버전은 `주(MAJOR).부(MINOR).수(PATCH)` 형식을 따릅니다.
-
-## 기여자 행동 강령 규약<sup>Code of Conduct</sup>
-
-커뮤니티에 기여하기 전, [기여자 행동 강령 규약](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>
-
-변경 사항에 대한 상세한 내용을 확인하려면, [변경 사항](CHANGELOG.md)을 참고해주세요.
-
-## 보안<sup>Security</sup>
-
-보안 문제를 발견하셨나요? [보안](https://github.com/lumirlumir/.github/blob/main/SECURITY_KO.md#%EB%B3%B4%EC%95%88) 문서를 참고해주세요.
-
-## 라이선스<sup>License</sup>
-
-바나나 프레임워크는 MIT 라이선스를 따릅니다. [라이선스](LICENSE.md) 문서를 참고해주세요.
+- [`npm`](https://www.npmjs.com/package/bananass-utils-console)
+- [`npmx`](https://npmx.dev/package/bananass-utils-console)

package/build/icons.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @fileoverview Console icons.
+ */
+/**
+ * Defines the frames and interval of a spinner.
+ */
+export interface SpinnerStyle {
+    /**
+     * The frames displayed sequentially to animate the spinner.
+     */
+    frames: string[];
+    /**
+     * The interval between frames, in milliseconds.
+     */
+    interval: number;
+}
+export declare const successIcon: string;
+export declare const errorIcon: string;
+export declare const warningIcon: string;
+export declare const infoIcon: string;
+export declare const bananassIcon: string;
+export declare const bulletIcon: string;
+export declare const boxDrawingsLightHorizontalIcon: string;
+export declare const successText: string;
+export declare const errorText: string;
+export declare const warningText: string;
+export declare const infoText: string;
+export declare const defaultSpinner: {
+    frames: string[];
+    interval: 80;
+};

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

@@ -1,79 +1,38 @@
 /**
  * @fileoverview Console icons.
  */
-
 // --------------------------------------------------------------------------------
 // Import
 // --------------------------------------------------------------------------------
-
 import { styleText } from 'node:util';
-import isUnicodeSupported from '../is-unicode-supported/index.js';
-
-// --------------------------------------------------------------------------------
-// Typedef
-// --------------------------------------------------------------------------------
-
-/**
- * @typedef {object} SpinnerStyle
- * @property {string[]} frames
- * @property {number} interval
- */
-
+import isUnicodeSupported from "./is-unicode-supported.js";
 // --------------------------------------------------------------------------------
 // Helpers
 // --------------------------------------------------------------------------------
-
 /**
- * @template {string | string[]} T
- * @param {T} unicode Used when Unicode is supported.
- * @param {T} ascii Used when Unicode is not supported.
- * @returns {T}
+ * @param unicode Used when Unicode is supported.
+ * @param ascii Used when Unicode is not supported.
  */
-const choose = (unicode, ascii) => (isUnicodeSupported() ? unicode : ascii);
-
+function choose(unicode, ascii) {
+    return isUnicodeSupported() ? unicode : ascii;
+}
 // --------------------------------------------------------------------------------
 // Export
 // --------------------------------------------------------------------------------
-
-/** @type {string} */
 export const successIcon = styleText(['green', 'bold'], choose('✓', 'V'));
-/** @type {string} */
 export const errorIcon = styleText(['red', 'bold'], choose('✕', 'X'));
-/** @type {string} */
 export const warningIcon = styleText(['yellow', 'bold'], choose('⚠', '!'));
-/** @type {string} */
 export const infoIcon = styleText(['blue', 'bold'], choose('✦', 'i'));
-/** @type {string} */
 export const bananassIcon = choose('🍌', '');
-/** @type {string} U+2022: "Bullet" (•) */
 export const bulletIcon = choose('\u2022', '*');
-/** @type {string} U+2500: "Box Drawings Light Horizontal" (─) */
 export const boxDrawingsLightHorizontalIcon = choose('\u2500', '-');
-
 // --------------------------------------------------------------------------------
-
-/** @type {string} */
-export const successText = styleText(
-  ['white', 'bgGreen', 'bold'],
-  ` ${successIcon} SUCCESS `,
-);
-/** @type {string} */
+export const successText = styleText(['white', 'bgGreen', 'bold'], ` ${successIcon} SUCCESS `);
 export const errorText = styleText(['white', 'bgRed', 'bold'], ` ${errorIcon} ERROR `);
-/** @type {string} */
-export const warningText = styleText(
-  ['white', 'bgYellow', 'bold'],
-  ` ${warningIcon} WARN `,
-);
-/** @type {string} */
+export const warningText = styleText(['white', 'bgYellow', 'bold'], ` ${warningIcon} WARN `);
 export const infoText = styleText(['white', 'bgBlue', 'bold'], ` ${infoIcon} INFO `);
-
 // --------------------------------------------------------------------------------
-
-/** @type {SpinnerStyle} */
 export const defaultSpinner = {
-  frames: choose(
-    ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],
-    ['-', '\\', '|', '/'],
-  ),
-  interval: 80,
+    frames: choose(['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'], ['-', '\\', '|', '/']),
+    interval: 80,
 };

package/build/{is-interactive/is-interactive.d.ts → is-interactive.d.ts}

@@ -3,19 +3,20 @@
  * @module bananass-utils-console/is-interactive
  * @license MIT Portions of this code were borrowed from [`is-interactive`](https://github.com/sindresorhus/is-interactive).
  */
+import type { WriteStream } from 'node:tty';
 /**
  * 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}
+ * @param stream The stream to check. (default: `process.stdout`)
+ * @returns `true` if the stream is interactive, `false` otherwise.
  * @example
- * ```
+ * ```js
  * import isInteractive from 'bananass-utils-console/is-interactive';
  *
  * isInteractive(); // true
  * ```
  */
-export default function isInteractive(stream?: NodeJS.WriteStream): boolean;
+export default function isInteractive(stream?: WriteStream): boolean;

package/{src/is-interactive → build}/is-interactive.js

@@ -3,28 +3,24 @@
  * @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}
+ * @param stream The stream to check. (default: `process.stdout`)
+ * @returns `true` if the stream is interactive, `false` otherwise.
  * @example
- * ```
+ * ```js
  * 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),
-  );
+    return Boolean(stream && stream.isTTY && process.env.TERM !== 'dumb' && !('CI' in process.env));
 }

package/build/{is-unicode-supported/is-unicode-supported.d.ts → is-unicode-supported.d.ts}

@@ -1,3 +1,8 @@
+/**
+ * @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).
+ */
 /**
  * Detect whether the terminal supports Unicode.
  *
@@ -9,7 +14,7 @@
  * 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.
+ * @returns Returns a `boolean` for whether the terminal supports Unicode.
  * @example
  * ```
  * import isUnicodeSupported from 'bananass-utils-console/is-unicode-supported';

package/{src/is-unicode-supported → build}/is-unicode-supported.js

@@ -3,17 +3,13 @@
  * @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.
  *
@@ -25,7 +21,7 @@ import process from 'node:process';
  * 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.
+ * @returns Returns a `boolean` for whether the terminal supports Unicode.
  * @example
  * ```
  * import isUnicodeSupported from 'bananass-utils-console/is-unicode-supported';
@@ -34,23 +30,19 @@ import process from 'node:process';
  * ```
  */
 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'
-  );
+    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/build/{logger/logger.d.ts → logger.d.ts}

@@ -1,28 +1,11 @@
 /**
- * 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();
+ * @fileoverview Console logger.
+ * @module bananass-utils-console/logger
  */
-export default function createLogger(options?: Options): Logger;
 /**
  * Logger options.
  */
-export type Options = {
+interface Options {
     /**
      * Enable debug mode.
      */
@@ -35,15 +18,9 @@ export type Options = {
      * Text prefix.
      */
     textPrefix?: string | boolean | undefined;
-};
-/**
- * @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.
- */
+}
 declare class Logger {
-    /** @param {Options} options */
+    #private;
     constructor(options?: Options);
     /**
      * Log a message or executes a callback.
@@ -56,8 +33,8 @@ declare class Logger {
      * - `quiet === true`: output X
      * - `quiet === false`: output O
      *
-     * @param {...unknown} params
-     * @returns {Logger}
+     * @param params The message or callback function, followed by any additional arguments.
+     * @returns The current `Logger` instance for chaining.
      */
     log(...params: unknown[]): Logger;
     /**
@@ -72,8 +49,8 @@ declare class Logger {
      * - `quiet === false && debug === true`: output O
      * - `quiet === false && debug === false`: output X
      *
-     * @param {...unknown} params
-     * @returns {Logger}
+     * @param params The message or callback function, followed by any additional arguments.
+     * @returns The current `Logger` instance for chaining.
      */
     debug(...params: unknown[]): Logger;
     /**
@@ -83,14 +60,34 @@ declare class Logger {
      * then invokes either `log()` or `debug()` depending on the previously method called.
      * After logging, it restores the original text prefix.
      *
-     * @returns {Logger}
+     * @returns The current `Logger` instance for chaining.
      */
     eol(): Logger;
     /**
      * Get the last method called.
      * @returns {'log' | 'debug'}
      */
-    get lastMethodCalled(): "log" | "debug";
-    #private;
+    get lastMethodCalled(): 'log' | 'debug';
 }
+/**
+ * Create a new `Logger` instance.
+ *
+ * @param options The logger options.
+ * @returns 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?: Options): Logger;
 export {};