@reliverse/relinka 1.2.4 → 1.2.6

package/dist-npm/utils/box.d.ts

@@ -1,24 +1,114 @@
 export type BoxBorderStyle = {
-        tl: string;
-        tr: string;
-        bl: string;
-        br: string;
-        h: string;
-        v: string;
+    /**
+     * Top left corner
+     * @example `┌`
+     * @example `╔`
+     * @example `╓`
+     */
+    tl: string;
+    /**
+     * Top right corner
+     * @example `┐`
+     * @example `╗`
+     * @example `╖`
+     */
+    tr: string;
+    /**
+     * Bottom left corner
+     * @example `└`
+     * @example `╚`
+     * @example `╙`
+     */
+    bl: string;
+    /**
+     * Bottom right corner
+     * @example `┘`
+     * @example `╝`
+     * @example `╜`
+     */
+    br: string;
+    /**
+     * Horizontal line
+     * @example `─`
+     * @example `═`
+     * @example `─`
+     */
+    h: string;
+    /**
+     * Vertical line
+     * @example `│`
+     * @example `║`
+     * @example `║`
+     */
+    v: string;
 };
 declare const boxStylePresets: Record<string, BoxBorderStyle>;
 export type BoxStyle = {
-        borderColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
-        borderStyle: BoxBorderStyle | keyof typeof boxStylePresets;
-        valign: "top" | "center" | "bottom";
-        padding: number;
-        marginLeft: number;
-        marginTop: number;
-        marginBottom: number;
+    /**
+     * The border color
+     * @default 'white'
+     */
+    borderColor: "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright";
+    /**
+     * The border style
+     * @default 'solid'
+     * @example 'single-double-rounded'
+     * @example
+     * ```ts
+     * {
+     *   tl: '┌',
+     *   tr: '┐',
+     *   bl: '└',
+     *   br: '┘',
+     *   h: '─',
+     *   v: '│',
+     * }
+     * ```
+     */
+    borderStyle: BoxBorderStyle | keyof typeof boxStylePresets;
+    /**
+     * The vertical alignment of the text
+     * @default 'center'
+     */
+    valign: "top" | "center" | "bottom";
+    /**
+     * The padding of the box
+     * @default 2
+     */
+    padding: number;
+    /**
+     * The left margin of the box
+     * @default 1
+     */
+    marginLeft: number;
+    /**
+     * The top margin of the box
+     * @default 1
+     */
+    marginTop: number;
+    /**
+     * The top margin of the box
+     * @default 1
+     */
+    marginBottom: number;
 };
+/**
+ * The border options of the box
+ */
 export type BoxOpts = {
-        title?: string;
+    /**
+     * Title that will be displayed on top of the box
+     * @example 'Hello World'
+     * @example 'Hello {name}'
+     */
+    title?: string;
     style?: Partial<BoxStyle>;
 };
+/**
+ * Creates a styled box with text content, customizable via options.
+ * @param {string} text - The text to display in the box.
+ * @param {BoxOpts} [_opts={}] - Optional settings for the appearance and behavior of the box. See {@link BoxOpts}.
+ * @returns {string} The formatted box as a string, ready for printing or logging.
+ */
 export declare function box(text: string, _opts?: BoxOpts): string;
 export {};

package/dist-npm/utils/box.js

@@ -87,7 +87,7 @@ export function box(text, _opts = {}) {
   const boxLines = [];
   const _color = getColor(opts.style.borderColor);
   const borderStyle = {
-    ...typeof opts.style.borderStyle === "string" ? boxStylePresets[opts.style.borderStyle] || boxStylePresets.solid : opts.style.borderStyle
+    ...typeof opts.style.borderStyle === "string" ? boxStylePresets[opts.style.borderStyle] || boxStylePresets["solid"] : opts.style.borderStyle
   };
   if (_color) {
     for (const key in borderStyle) {

package/dist-npm/utils/color.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Based on https://github.com/jorgebucaran/colorette
+ * Read LICENSE file for more information
+ * https://github.com/jorgebucaran/colorette/blob/20fc196d07d0f87c61e0256eadd7831c79b24108/index.js
+ */
 declare const colorDefs: {
     reset: (string: string) => string;
     bold: (string: string) => string;
@@ -43,7 +48,22 @@ declare const colorDefs: {
 };
 export type ColorName = keyof typeof colorDefs;
 export type ColorFunction = (text: string | number) => string;
+/**
+ * An object containing functions for coloring text. Each function corresponds to a terminal color. See {@link ColorName} for available colors.
+ */
 export declare const colors: Record<ColorName, ColorFunction>;
+/**
+ * Gets a color function by name, with an option for a fallback color if the requested color is not found.
+ * @param {ColorName} color - The name of the color function to get. See {@link ColorName}.
+ * @param {ColorName} [fallback="reset"] - The name of the fallback color function if the requested color is not found. See {@link ColorName}.
+ * @returns {ColorFunction} The color function that corresponds to the requested color, or the fallback color function. See {@link ColorFunction}.
+ */
 export declare function getColor(color: ColorName, fallback?: ColorName): ColorFunction;
+/**
+ * Applies a specified color to a given text string or number.
+ * @param {ColorName} color - The color to apply. See {@link ColorName}.
+ * @param {string | number} text - The text to color.
+ * @returns {string} The colored text.
+ */
 export declare function colorize(color: ColorName, text: string | number): string;
 export {};

package/dist-npm/utils/color.js

@@ -7,10 +7,10 @@ const {
 const isDisabled = "NO_COLOR" in env || argv.includes("--no-color");
 const isForced = "FORCE_COLOR" in env || argv.includes("--color");
 const isWindows = platform === "win32";
-const isDumbTerminal = env.TERM === "dumb";
+const isDumbTerminal = env["TERM"] === "dumb";
 const isCompatibleTerminal = (
-  
-  tty && tty.isatty && tty.isatty(1) && env.TERM && !isDumbTerminal
+  // eslint-disable-next-line @typescript-eslint/prefer-optional-chain
+  tty && tty.isatty && tty.isatty(1) && env["TERM"] && !isDumbTerminal
 );
 const isCI = "CI" in env && ("GITHUB_ACTIONS" in env || "GITLAB_CI" in env || "CIRCLECI" in env);
 const isColorSupported = !isDisabled && (isForced || isWindows && !isDumbTerminal || isCompatibleTerminal || isCI);

package/dist-npm/utils/error.d.ts

@@ -1 +1,6 @@
+/**
+ * Parses a stack trace string and normalizes its paths by removing the current working directory and the "file://" protocol.
+ * @param {string} stack - The stack trace string.
+ * @returns {string[]} An array of stack trace lines with normalized paths.
+ */
 export declare function parseStack(stack: string): string[];

package/dist-npm/utils/format.d.ts

@@ -1,2 +1,14 @@
+/**
+ * Compiles a format string by replacing placeholders with appropriate position indices.
+ * Caches compiled formats for efficiency.
+ * @param {string} format - The format string containing the placeholders to replace.
+ * @returns {string} The compiled format string with placeholders replaced by positional indices.
+ */
 export declare function compileFormat(format: string): any;
+/**
+ * Formats a string according to a custom format, using vsprintf for string formatting.
+ * @param {string} format - The custom format string.
+ * @param {any[]} argv - The arguments to format into the string.
+ * @returns {string} The formatted string.
+ */
 export declare function formatString(format: string, argv: any): string;

package/dist-npm/utils/log.d.ts

@@ -1,2 +1,13 @@
+/**
+ * Checks if the given argument is a simple JavaScript object.
+ * @param {any} obj - The object to test.
+ * @returns {boolean} `true` if the argument is a plain object, otherwise `false`.
+ */
 export declare function isPlainObject(obj: any): boolean;
+/**
+ * Determines whether the given argument is a protocol object. A log object must be a simple object and
+ * must contain either a 'message' or 'args' field, but not a 'stack' field.
+ * @param {any} arg - The argument to check.
+ * @returns {boolean} `true` if the argument is a log object according to the specified criteria, otherwise `false`.
+ */
 export declare function isLogObj(arg: any): boolean;

package/dist-npm/utils/stream.d.ts

@@ -1 +1,14 @@
+/**
+ * Writes data to a specified NodeJS writable stream. This function supports streams that have a custom
+ * `__write' method, and will fall back to the default `write' method if `__write' is not present.
+ *
+ * @param {any} data - The data to write to the stream. This can be a string, a buffer, or any data type
+ * supported by the stream's `write' or `__write' method.
+ * @param {NodeJS.WriteStream} stream - The writable stream to write the data to. This stream
+ * must implement the `write' method, and can optionally implement a custom `__write' method.
+ * @returns {boolean} `true` if the data has been completely processed by the write operation,
+ * indicating that further writes can be performed immediately. Returns `false` if the data is
+ * buffered by the stream, indicating that the `drain` event should be waited for before writing
+ * more data.
+ */
 export declare function writeStream(data: any, stream: NodeJS.WriteStream): any;

package/dist-npm/utils/string.d.ts

@@ -1,5 +1,50 @@
+/**
+ * Removes ANSI escape codes from a given string. This is particularly useful for
+ * processing text that contains formatting codes, such as colors or styles, so that the
+ * the raw text without any visual formatting.
+ *
+ * @param {string} text - The text string from which to strip the ANSI escape codes.
+ * @returns {string} The text without ANSI escape codes.
+ */
 export declare function stripAnsi(text: string): string;
+/**
+ * Centers a string within a specified total width, padding it with spaces or another specified character.
+ * If the string is longer than the total width, it is returned as is.
+ *
+ * @param {string} str - The string to centre.
+ * @param {number} len - The total width in which to centre the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The centred string.
+ */
 export declare function centerAlign(str: string, len: number, space?: string): string;
+/**
+ * Right-justifies a string within a given total width, padding it with whitespace or another specified character.
+ * If the string is longer than the total width, it is returned as is.
+ *
+ * @param {string} str - The string to right-justify.
+ * @param {number} len - The total width to align the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The right-justified string.
+ */
 export declare function rightAlign(str: string, len: number, space?: string): string;
+/**
+ * Left-aligns a string within a given total width, padding it with whitespace or another specified character on the right.
+ * If the string is longer than the total width, it is returned as is.
+ *
+ * @param {string} str - The string to align left.
+ * @param {number} len - The total width to align the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The left-justified string.
+ */
 export declare function leftAlign(str: string, len: number, space?: string): string;
+/**
+ * Aligns a string (left, right, or centre) within a given total width, padding it with spaces or another specified character.
+ * If the string is longer than the total width, it is returned as is. This function acts as a wrapper for individual alignment functions.
+ *
+ * @param {"left" | "right" | "centre"} alignment - The desired alignment of the string.
+ * @param {string} str - The string to align.
+ * @param {number} len - The total width in which to align the string.
+ * @param {string} [space=" "] - The character to use for padding. Defaults to a space.
+ * @returns {string} The aligned string, according to the given alignment.
+ */
 export declare function align(alignment: "left" | "right" | "center", str: string, len: number, space?: string): string;

package/dist-npm/utils/tree.d.ts

@@ -1,12 +1,41 @@
 import { type ColorName } from "./color.js";
 export type TreeItemObject = {
-        text: string;
-        children?: TreeItem[];
-        color?: ColorName;
+    /**
+     * Text of the item
+     */
+    text: string;
+    /**
+     * Children of the item
+     */
+    children?: TreeItem[];
+    /**
+     * Color of the item
+     */
+    color?: ColorName;
 };
 export type TreeItem = string | TreeItemObject;
 export type TreeOptions = {
-        color?: ColorName;
-        prefix?: string;
+    /**
+     * Color of the tree
+     */
+    color?: ColorName;
+    /**
+     * Prefix of the tree
+     *
+     * @default "  "
+     */
+    prefix?: string;
 };
+/**
+ * Formats a hierarchical list of items into a string representing a tree structure.
+ * Each item in the tree can be a simple string or an object defining the text of the item,
+ * optional children, and color. The tree structure can be customized with options
+ * Specify the overall color and the prefix used for indentation and tree lines.
+ *
+ * @param {TreeItem[]} items - An array of items to include in the tree. Each item can be
+ * either a string or an object with `text', `children' and `color' properties.
+ * @param {TreeOptions} [options] - Optional settings to customize the appearance of the tree, including
+ * the color of the tree text and the prefix for branches. See {@link TreeOptions}.
+ * @returns {string} The formatted tree as a string, ready for printing to the console or elsewhere.
+ */
 export declare function formatTree(items: TreeItem[], options?: TreeOptions): string;

package/package.json

@@ -1,29 +1,28 @@
 {
   "name": "@reliverse/relinka",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "author": "blefnk",
   "type": "module",
   "description": "@reliverse/relinka is a powerful logger for your terminal.",
   "scripts": {
-    "dev": "tsx examples/main.ts",
-    "check": "redrun typecheck lint format attw",
-    "release": "bumpp && bun check && bun pub",
-    "build:jsr": "tsx build.optim.ts --jsr",
-    "build:npm": "unbuild && tsx build.optim.ts",
-    "build": "redrun build:jsr build:npm optimize",
-    "pub:jsr": "tsx build.publish.ts --jsr",
-    "pub:npm": "tsx build.publish.ts",
-    "pub:dry": "tsx build.publish.ts --dry-run",
-    "pub": "redrun pub:npm pub:jsr",
+    "dev": "bun examples/main.ts",
+    "check": "bun typecheck && bun lint && bun format",
+    "build:npm": "unbuild && bun build.optim.ts",
+    "build:jsr": "bun build.optim.ts --jsr",
+    "build": "bun build:npm && bun build:jsr",
+    "pub:npm": "bun build.publish.ts",
+    "pub:jsr": "bun build.publish.ts --jsr",
+    "pub:dry": "bun build.publish.ts --dry-run",
+    "pub": "bun publish.ts",
     "typecheck": "tsc --noEmit",
     "lint": "eslint --cache --fix .",
     "lint:i": "eslint --inspect-config",
     "format": "biome check --write .",
-    "optimize": "putout dist-npm --fix",
     "attw": "bunx @arethetypeswrong/cli",
     "unpub": "npm unpublish",
     "test": "vitest",
-    "knip": "knip"
+    "knip": "knip",
+    "latest": "bun update --latest"
   },
   "publishConfig": {
     "access": "public"
@@ -43,35 +42,44 @@
     "url": "https://github.com/reliverse/relinka/issues",
     "email": "blefnk@gmail.com"
   },
-  "files": ["package.json", "README.md", "LICENSE.md", "dist-npm"],
+  "files": [
+    "package.json",
+    "README.md",
+    "LICENSE.md",
+    "dist-npm"
+  ],
   "homepage": "https://github.com/reliverse/relinka",
-  "keywords": ["cli", "reliverse"],
+  "keywords": [
+    "cli",
+    "reliverse"
+  ],
   "license": "MIT",
   "dependencies": {
     "@figliolia/chalk-animation": "^1.0.4",
-    "@sinclair/typebox": "^0.34.9",
+    "@sinclair/typebox": "^0.34.13",
     "ansi-diff-stream": "^1.2.1",
     "ansi-escapes": "^7.0.0",
-    "chalk": "^5.3.0",
+    "chalk": "^5.4.1",
     "cli-spinners": "^3.2.0",
     "cli-styles": "^1.0.0",
     "cli-width": "^4.1.0",
     "defu": "^6.1.4",
     "detect-package-manager": "^3.0.2",
     "external-editor": "^3.1.0",
-    "fast-glob": "^3.3.2",
+    "fast-glob": "^3.3.3",
     "figlet": "^1.8.0",
     "fs-extra": "^11.2.0",
     "get-pixels": "^3.3.3",
+    "globby": "^14.0.2",
     "gradient-string": "^3.0.0",
     "is-unicode-supported": "^2.1.0",
     "kleur": "^4.1.5",
     "log-update": "^6.1.0",
     "mute-stream": "^2.0.0",
-    "node-emoji": "^2.1.3",
-    "nypm": "^0.4.0",
+    "node-emoji": "^2.2.0",
+    "nypm": "^0.4.1",
     "ora": "^8.1.1",
-    "pathe": "^1.1.2",
+    "pathe": "^2.0.1",
     "picocolors": "^1.1.1",
     "precision": "^1.0.1",
     "seventh": "^0.9.2",
@@ -80,44 +88,46 @@
     "std-env": "^3.8.0",
     "string-width": "^7.2.0",
     "strip-ansi": "^7.1.0",
+    "terminal-size": "^4.0.0",
     "ts-regex-builder": "^1.8.2",
     "window-size": "^1.1.1",
     "wrap-ansi": "^9.0.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.0",
+    "@arethetypeswrong/cli": "^0.17.3",
     "@biomejs/biome": "1.9.4",
-    "@cspell/dict-npm": "^5.1.14",
-    "@eslint/js": "^9.15.0",
+    "@cspell/dict-npm": "^5.1.22",
+    "@eslint/js": "^9.18.0",
+    "@eslint/json": "^0.9.0",
+    "@eslint/markdown": "^6.2.1",
+    "@stylistic/eslint-plugin": "^2.13.0",
     "@types/ansi-diff-stream": "^1.2.3",
-    "@types/bun": "^1.1.14",
+    "@types/bun": "^1.1.16",
     "@types/chalk-animation": "^1.6.3",
     "@types/eslint__js": "^8.42.3",
     "@types/figlet": "^1.7.0",
     "@types/fs-extra": "^11.0.4",
     "@types/mute-stream": "^0.0.4",
-    "@types/node": "^22.10.0",
+    "@types/node": "^22.10.6",
     "@types/sentencer": "^0.2.3",
     "@types/signal-exit": "^3.0.4",
     "@types/strip-comments": "^2.0.4",
     "@types/window-size": "^1.1.4",
-    "bumpp": "^9.8.1",
     "c12": "^2.0.1",
-    "eslint": "^9.15.0",
-    "eslint-plugin-perfectionist": "^4.1.2",
-    "execa": "^9.5.1",
-    "jiti": "^2.4.0",
-    "knip": "^5.38.1",
+    "citty": "^0.1.6",
+    "eslint": "^9.18.0",
+    "eslint-plugin-perfectionist": "^4.6.0",
+    "execa": "^9.5.2",
+    "jiti": "^2.4.2",
+    "knip": "^5.42.0",
     "mock-stdin": "^1.0.0",
     "printj": "^1.3.1",
-    "putout": "^36.14.0",
-    "redrun": "^11.0.5",
     "sentencer": "^0.2.1",
     "strip-comments": "^2.0.1",
     "tsx": "^4.19.2",
-    "typescript": "^5.7.2",
-    "typescript-eslint": "^8.16.0",
-    "unbuild": "^2.0.0",
-    "vitest": "^2.1.6"
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.20.0",
+    "unbuild": "^3.3.1",
+    "vitest": "^2.1.8"
   }
-}
+}

package/LICENSE.md

@@ -1,21 +0,0 @@
-# MIT License
-
-Copyright (c) 2024 Nazarii Korniienko
-
-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.