bananass-utils-console 0.1.0-canary.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2024-present 루밀LuMir(lumirlumir)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,146 @@
+# bananass
+
+<kbd>한국어</kbd> | <kbd>[English](README.en.md)</kbd>
+
+바나나<sup>Bananass, 🍌🍌🍌🍌</sup>: <kbd>명사</kbd> 자바스크립트를 위한 백준 프레임워크.
+
+> [!IMPORTANT]
+>
+> ```js
+> const whyBananass = {
+>   banana: '🍌',
+>   bananas: '🍌🍌',
+>   bananass: '🍌🍌🍌🍌',
+> }
+> ```
+>
+> ```js
+> console.log(('b' + 'a' + +'a' + 'a').toLowerCase() + (!(1/0) + [])[3].repeat(2));
+> ```
+
+<!-- markdownlint-disable-next-line md026 -->
+## 안녕, 바나나!
+
+바나나<sup>Bananass, 🍌🍌🍌🍌</sup> 프레임워크에 오신 것을 환영합니다.🎉
+
+바나나 프레임워크는 [루밀<sup>LuMir</sup>](https://github.com/lumirlumir)이 제작한 **자바스크립트<sup>JavaScript</sup>를 위한 백준 프레임워크**로, 백준 Node.js 환경에서의 보다 편리한 문제풀이를 위해 설계되었습니다.
+
+이제 더 이상 `readline` 혹은 `fs` 모듈을 이용한 템플릿<sup>Template</sup> 코드를 작성한 후, 일일이 복사 붙여넣기할 필요가 없습니다! 바나나 프레임워크를 통해 [**프로그래머스**](https://programmers.co.kr/)에서 하나의 솔루션 함수<sup>`function solution() {}`</sup>를 작성하듯 더욱 간편한 문제 풀이를 경험해보세요.
+
+그런데, 백준 문제 풀이를 하는데 굳이 프레임워크까지 알아야 할까요? 아래에서 그 이유를 찾아보죠!
+
+## 왜 바나나일까요?
+
+왜 자바스크립트<sup>JavaScript</sup> 생태계의 수 많은 프레임워크 중 문제 풀이에 특화된 프레임워크는 없었을까요? 함께 자바스크립트를 이용한 [백준 1000번: A+B](https://www.acmicpc.net/problem/1000) 문제 풀이 예제를 살펴보죠!
+
+- 전<sup>Before</sup>: 기존 방법을 통한 문제 풀이.
+
+    ```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(inputStr) {
+      const input = inputStr
+        .trim()
+        .split(' ')
+        .map(val => Number(val));
+
+      const [a, b] = input;
+
+      return a + b;
+    }
+    ```
+
+- 후<sup>After</sup>: 바나나 프레임워크를 이용한 문제 풀이.
+
+    ```js
+    function solution(input) {
+      const [a, b] = input
+        .trim()
+        .split(' ')
+        .map(Number);
+
+      console.log(a + b);
+    }
+
+    module.exports = solution;
+    ```
+
+와우!😲 놀랍지 않나요? 이제 여러분들은 단순해진 코드와 더불어 알고리즘 로직에만 집중할 수 있습니다.
+
+근데, 이게 전부냐고요? 물론 아닙니다!
+
+- 백준 Node.js 환경에 구애받지 않는 ES2025 등 최신 문법의 사용
+- 사용자 정의 모듈 및 `lodash` 등 외부 라이브러리의 사용
+- ESLint 및 Prettier 자체 지원
+- 풍부한 문서 및 커뮤니티 지원
+- ...
+
+어떤가요? 바나나 프레임워크를 통해 더욱 편리한 문제 풀이를 경험해보고 싶지 않으신가요?🤔
+
+## 바나나로 시작하기
+
+React의 `create-react-app`, Next.js의 `create-next-app` 처럼,
+
+**바나나 프레임워크에서 제공하는 `create-bananass-app`으로 지금 바로 새로운 문제 풀이 패러다임을 경험해보세요!**
+
+바나나 프레임워크는 `create-bananass-app`을 통해 즉시 설치하고 사용할 수 있습니다! (사실 앱<sup>App</sup>은 아니지만, 그건 중요한게 아닙니다...🤔)
+
+```sh
+npx create-bananass-app my-bananass-app --no-install
+```
+
+더욱 자세한 사용법은 [바나나 프레임워크 문서](https://bananass.lumir.page)를 참고해주세요.
+
+## 바나나 프레임워크 문서
+
+> <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> 등을 환영합니다.
+
+다만, 올바른 커뮤니티 환경을 준수하고 더 나은 오픈소스를 만들기 위해, 바나나 프레임워크에 기여하기 전 반드시 아래 내용들을 확인해주세요.
+
+- [기여자 행동 강령 규약](CODE_OF_CONDUCT.md)
+- [기여하기](CONTRIBUTING.md)
+
+## 버전 정책<sup>Versioning</sup>
+
+바나나 프레임워크는 [유의적 버전 정책<sup>Sementic Versioning</sup>](https://semver.org/lang/ko/)을 따릅니다. 모든 릴리즈 버전은 `주(MAJOR).부(MINOR).수(PATCH)` 형식을 따릅니다.
+
+## 기여자 행동 강령 규약<sup>Code of Conduct</sup>
+
+커뮤니티에 기여하기 전, [기여자 행동 강령 규약](CODE_OF_CONDUCT.md)을 참고해주세요.
+
+## 변경 사항<sup>Change Log</sup>
+
+변경 사항에 대한 상세한 내용을 확인하려면, [변경 사항](CHANGELOG.md)을 참고해주세요.
+
+## 보안<sup>Security</sup>
+
+보안 문제를 발견하셨나요? [보안](SECURITY.md) 문서를 참고해주세요.
+
+## 라이센스<sup>License</sup>
+
+바나나 프레임워크는 MIT 라이센스를 따릅니다. [라이센스](LICENSE.md) 문서를 참고해주세요.

package/build/icons/icons.d.ts

@@ -0,0 +1,24 @@
+/** @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} */
+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

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

package/build/logger/index.d.ts

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

package/build/logger/logger.d.ts

@@ -0,0 +1,97 @@
+/**
+ * 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: Options): Logger;
+/**
+ * Logger options.
+ */
+export type Options = {
+    /**
+     * Enable debug mode.
+     */
+    debug?: boolean;
+    /**
+     * Enable quiet mode.
+     */
+    quiet?: boolean;
+    /**
+     * Text prefix.
+     */
+    textPrefix?: string | boolean;
+};
+/**
+ * @typedef {object} Options Logger options.
+ * @property {boolean} [debug] Enable debug mode.
+ * @property {boolean} [quiet] Enable quiet mode.
+ * @property {string | boolean} [textPrefix] Text prefix.
+ */
+declare class Logger {
+    /** @param {Options} options */
+    constructor(options?: Options);
+    /**
+     * 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 {...any} params
+     * @returns {Logger}
+     */
+    log(...params: any[]): Logger;
+    /**
+     * 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 {...any} params
+     * @returns {Logger}
+     */
+    debug(...params: any[]): Logger;
+    /**
+     * 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(): Logger;
+    /**
+     * Get the last method called.
+     *
+     * @returns {'log' | 'debug'}
+     */
+    get lastMethodCalled(): "log" | "debug";
+    #private;
+}
+export {};

package/build/spinner/index.d.ts

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

package/build/spinner/spinner.d.ts

@@ -0,0 +1,173 @@
+/**
+ * Create a new spinner instance.
+ *
+ * @param {Options} [options]
+ * @returns {Spinner} A new spinner instance.
+ *
+ * @example
+ * import createSpinner from 'bananass-utils-console/spinner';
+ *
+ * const spinner = createSpinner({
+ *   text: 'Loading…'
+ *   color: 'yellow',
+ *   stream: process.stderr,
+ *   spinner: {
+ *     frames: ['-', '\\', '|', '/'],
+ *     interval: 100,
+ *   },
+ * }).start();
+ *
+ * setTimeout(() => {
+ *   spinner.success('Success!');
+ * }, 2000);
+ */
+export default function createSpinner(options?: Options): Spinner;
+export type ForegroundColorName = import("chalk").ForegroundColorName;
+export type SpinnerStyle = {
+    frames: string[];
+    interval?: number;
+};
+/**
+ * Spinner options.
+ */
+export type Options = {
+    /**
+     * Text to display next to the spinner. (default: `''`)
+     */
+    text?: string;
+    /**
+     * The color of the spinner. (default: `'yellow'`)
+     */
+    color?: ForegroundColorName;
+    /**
+     * The stream to which the spinner is written. (default: `process.stderr`)
+     */
+    stream?: NodeJS.WriteStream;
+    /**
+     * Whether the spinner should be interactive. (default: Auto-detected)
+     */
+    isInteractive?: boolean;
+    /**
+     * Customize the spinner animation with a custom set of frames and interval.
+     *
+     * ```
+     * {
+     * frames: ['-', '\\', '|', '/'],
+     * interval: 100,
+     * }
+     * ```
+     *
+     * Pass in any spinner from [`cli-spinners`](https://github.com/sindresorhus/cli-spinners).
+     */
+    spinner?: SpinnerStyle;
+};
+/**
+ * @typedef {import('chalk').ForegroundColorName} ForegroundColorName
+ */
+/**
+ * @typedef {object} SpinnerStyle
+ * @property {string[]} frames
+ * @property {number} [interval]
+ */
+/**
+ * @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 {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]
+ * Customize the spinner animation with a custom set of frames and interval.
+ *
+ * ```
+ * {
+ *    frames: ['-', '\\', '|', '/'],
+ *    interval: 100,
+ * }
+ * ```
+ *
+ * Pass in any spinner from [`cli-spinners`](https://github.com/sindresorhus/cli-spinners).
+ */
+declare class Spinner {
+    /** @param {Options} options */
+    constructor(options?: Options);
+    /**
+     * Starts the spinner.
+     *
+     * Optionally, updates the text.
+     *
+     * @param {string} [text] The text to display next to the spinner.
+     * @returns The spinner instance.
+     */
+    start(text?: string): this;
+    /**
+     * Stops the spinner.
+     *
+     * Optionally displays a final message.
+     *
+     * @param {string} [finalText] The final text to display after stopping the spinner.
+     * @returns The spinner instance.
+     */
+    stop(finalText?: string): this;
+    /**
+     * Stops the spinner and displays a success symbol with the message.
+     *
+     * @param {string} [text] The success message to display.
+     * @returns The spinner instance.
+     */
+    success(text?: string): this;
+    /**
+     * Stops the spinner and displays an error symbol with the message.
+     *
+     * @param {string} [text] The error message to display.
+     * @returns The spinner instance.
+     */
+    error(text?: string): this;
+    /**
+     * Stops the spinner and displays a warning symbol with the message.
+     *
+     * @param {string} [text] The warning message to display.
+     * @returns The spinner instance.
+     */
+    warning(text?: string): this;
+    /**
+     * Stops the spinner and displays an info symbol with the message.
+     *
+     * @param {string} [text] The info message to display.
+     * @returns The spinner instance.
+     */
+    info(text?: string): this;
+    /**
+     * Clears the spinner.
+     *
+     * @returns The spinner instance.
+     */
+    clear(): this;
+    /**
+     * Change the text displayed next to the spinner.
+     *
+     * @example
+     * spinner.text = 'New text';
+     */
+    set text(value: string);
+    /**
+     * Change the text displayed next to the spinner.
+     *
+     * @example
+     * spinner.text = 'New text';
+     */
+    get text(): string;
+    /**
+     * Change the spinner color.
+     */
+    set color(value: keyof import("chalk/source/vendor/ansi-styles/index.js").ForegroundColor);
+    /**
+     * Change the spinner color.
+     */
+    get color(): keyof import("chalk/source/vendor/ansi-styles/index.js").ForegroundColor;
+    /**
+     * Returns whether the spinner is currently spinning.
+     */
+    get isSpinning(): boolean;
+    #private;
+}
+export {};

package/build/theme/index.d.ts

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

package/build/theme/theme.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "bananass-utils-console",
+  "version": "0.1.0-canary.0",
+  "type": "module",
+  "description": "Console Utilities for Bananass Framework.🍌",
+  "exports": {
+    "./icons": {
+      "types": "./build/icons/index.d.ts",
+      "default": "./src/icons/index.js"
+    },
+    "./logger": {
+      "types": "./build/logger/index.d.ts",
+      "default": "./src/logger/index.js"
+    },
+    "./spinner": {
+      "types": "./build/spinner/index.d.ts",
+      "default": "./src/spinner/index.js"
+    },
+    "./theme": {
+      "types": "./build/theme/index.d.ts",
+      "default": "./src/theme/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./build/*"
+      ],
+      "icons": [
+        "./build/icons/index.d.ts"
+      ],
+      "logger": [
+        "./build/logger/index.d.ts"
+      ],
+      "spinner": [
+        "./build/spinner/index.d.ts"
+      ],
+      "theme": [
+        "./build/theme/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "build",
+    "LICENSE.md",
+    "README.md",
+    "!src/**/*.test.js",
+    "!**/fixtures/**"
+  ],
+  "keywords": [
+    "bananass",
+    "baekjoon",
+    "framework",
+    "javascript",
+    "utils",
+    "console",
+    "icon",
+    "logger",
+    "spinner",
+    "theme"
+  ],
+  "author": "루밀LuMir <rpfos@naver.com> (https://github.com/lumirlumir)",
+  "license": "MIT",
+  "homepage": "https://bananass.lumir.page",
+  "repository": {
+    "type": "github",
+    "url": "git+https://github.com/lumirlumir/npm-bananass.git",
+    "directory": "packages/bananass-utils-console"
+  },
+  "bugs": {
+    "url": "https://github.com/lumirlumir/npm-bananass/issues"
+  },
+  "engines": {
+    "node": ">=20.18.0"
+  },
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "build": "npx tsc && shx cp ../../LICENSE.md ../../README.md .",
+    "test": "node --test"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "is-interactive": "^2.0.0",
+    "is-unicode-supported": "^2.1.0"
+  }
+}