termark 2.0.0 → 3.0.0

package/package.json

@@ -1,39 +1,51 @@
 {
-    "name": "termark",
-    "version": "2.0.0",
-    "main": "./dist/index.cjs",
-    "module": "./dist/index.mjs",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.mjs",
-            "require": "./dist/index.cjs"
-        }
-    },
-    "scripts": {
-        "build": "rollup -c",
-        "test": "node dist/index.mjs"
-    },
-    "keywords": [
-        "utility",
-        "console",
-        "node",
-        "output",
-        "formatting"
-    ],
-    "author": "Miyazaki \"Q\" Hashimoto",
-    "license": "Apache-2.0",
-    "description": "A basic library to format console output to the standard non-browser terminal.",
-    "homepage": "https://genesis.q-file.com/projects/termark",
-    "repository": {
-        "type": "git",
-        "url": "https://codeberg.org/Genesis_Software/termark.git"
-    },
-    "devDependencies": {
-        "@rollup/plugin-terser": "^0.4.4",
-        "@types/node": "^24.3.0",
-        "rollup": "^4.49.0",
-        "rollup-plugin-typescript2": "^0.36.0",
-        "typescript": "^5.9.2"
+  "name": "termark",
+  "version": "3.0.0",
+  "description": "A basic library to format console output to the standard non-browser terminal.",
+  "keywords": [
+    "console",
+    "formatting",
+    "node",
+    "output",
+    "utility"
+  ],
+  "homepage": "https://genesis.q-file.com/projects/termark",
+  "license": "Apache-2.0",
+  "author": "Miyazaki \"Q\" Hashimoto",
+  "repository": {
+    "type": "git",
+    "url": "https://codeberg.org/Genesis_Software/termark.git"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     }
-}
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "oxfmt": "^0.50.0",
+    "oxlint": "^1.65.0",
+    "tsdown": "^0.22.0",
+    "tsx": "^4.22.0",
+    "typescript": "^5.9.2",
+    "vitest": "^4.1.6"
+  },
+  "readme": "README.npm.md",
+  "scripts": {
+    "build": "tsdown --config .config/tsdown.config.ts",
+    "format": "oxfmt --config .config/oxfmt.config.ts",
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "test": "vitest --config .config/vitest.config.ts",
+    "demo:truecolor": "tsx examples/truecolor.ts",
+    "demo:box": "tsx examples/box.ts",
+    "demo:basic": "tsx examples/basic.ts",
+    "demo:link": "tsx examples/link.ts"
+  }
+}

package/dist/index.d.ts

@@ -1,338 +0,0 @@
-import { ANSIStyleType, RGB } from './util';
-/**
- * The `Termark` class is almost the same as the {@linkcode termark} object and by using `Termark.init`, it effectively does become the same.
- *
- * However, it is nonetheless useful as it enables type-safety,
- *
- * You use this class the same way as you would the {@linkcode termark} object.
- *
- * @example
- * ```typescript
- * import { Termark } from 'termark';
- *
- * const termark = new Termark(); // This is the same as if you'd import the `termark` object.
- * termark.success('Termark is working!');
- *
- * // Alternatively, you could do:
- * Termark.init.success('This works, too!');
- * ```
- *
- * @see The {@linkcode termark} object.
- */
-export declare class Termark {
-    /**
-     * A reference to a Termark instance.
-     *
-     * This is an object that holds the properties defined below.
-     */
-    private static termarkInstance;
-    /**
-     * A static getter function that returns a Termark reference object.
-     *
-     * With this method, it's possible to use the `Termark` class like an object.
-     *
-     * @example
-     * ```typescript
-     * import { Termark } from 'termark';
-     * Termark.init.success('...');
-     *
-     * // ...is the same as:
-     *
-     * import termark from 'termark';
-     * termark.success('...');
-     * ```
-     */
-    static get init(): Termark;
-    /** Check whether terminal colours are enabled. */
-    areColorsEnabled: boolean;
-    /** Check whether 8-bit colours are enabled. */
-    is8bitEnabled: boolean;
-    /** Check whether 24-bit colours are enabled. */
-    is24bitEnabled: boolean;
-    /** Reset all styles. */
-    reset: (input: string | TemplateStringsArray) => string;
-    /** Make some text bold. */
-    bold: (input: string | TemplateStringsArray) => string;
-    /** Make some text thin. */
-    dim: (input: string | TemplateStringsArray) => string;
-    /** Make some text italic. May not be widely supported. */
-    italic: (input: string | TemplateStringsArray) => string;
-    /** Underline some text. */
-    underline: (input: string | TemplateStringsArray) => string;
-    /** Make some text blink slowly. */
-    blink: (input: string | TemplateStringsArray) => string;
-    /** Invert some text (foreground colour becomes background colour, background colour becomes foreground colour). */
-    inverse: (input: string | TemplateStringsArray) => string;
-    /** Add a line above some text. May not be widely supported. */
-    overline: (input: string | TemplateStringsArray) => string;
-    /** Visually hide some text. */
-    hidden: (input: string | TemplateStringsArray) => string;
-    /** Add a line through (strike) some text. */
-    strike: (input: string | TemplateStringsArray) => string;
-    /** Colour some text black. */
-    black: (input: string | TemplateStringsArray) => string;
-    /** Colour some text red. */
-    red: (input: string | TemplateStringsArray) => string;
-    /** Colour some text green. */
-    green: (input: string | TemplateStringsArray) => string;
-    /** Colour some text yellow. */
-    yellow: (input: string | TemplateStringsArray) => string;
-    /** Colour some text blue. */
-    blue: (input: string | TemplateStringsArray) => string;
-    /** Colour some text magenta. */
-    magenta: (input: string | TemplateStringsArray) => string;
-    /** Colour some text cyan. */
-    cyan: (input: string | TemplateStringsArray) => string;
-    /** Colour some text white. */
-    white: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright black (grey). */
-    blackBright: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright red. */
-    redBright: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright green. */
-    greenBright: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright yellow. */
-    yellowBright: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright blue. */
-    blueBright: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright magenta. */
-    magentaBright: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright cyan. */
-    cyanBright: (input: string | TemplateStringsArray) => string;
-    /** Colour some text bright white. */
-    whiteBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text black. */
-    bgBlack: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text red. */
-    bgRed: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text green. */
-    bgGreen: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text yellow. */
-    bgYellow: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text blue. */
-    bgBlue: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text magenta. */
-    bgMagenta: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text cyan. */
-    bgCyan: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text white. */
-    bgWhite: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright black (grey). */
-    bgBlackBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright red. */
-    bgRedBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright green. */
-    bgGreenBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright yellow. */
-    bgYellowBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright blue. */
-    bgBlueBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright magenta. */
-    bgMagentaBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright cyan. */
-    bgCyanBright: (input: string | TemplateStringsArray) => string;
-    /** Colour the background of some text bright white. */
-    bgWhiteBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text or its background one of 256 colours.
-     * If `color` is bigger than 255 or smaller than 0, it automatically rounds to 255 or 0 respectively.
-     *
-     * @param type Whether the styling should be applied to the text itself or the background.
-     * @param color A number between 0 and 255 that specifies the colour.
-     * @param content The string that should be styled.
-     * @returns If terminal colours are enabled and [8-bit colours](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) are supported, the stylized text. If either is false, it returns the plain string.
-     * @see https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
-     */
-    ansi256(type: ANSIStyleType, color: number): (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text or its background using custom RGB values.
-     *
-     * @param type Whether to apply the colour to the text itself or its background.
-     * @param rgb A list of `red`, `green`, and `blue` values.
-     * @returns A function to specify an input, which returns the stylized text, assuming colours are enabled, *and* `truecolor` is enabled as well.
-     *
-     * @example
-     * ```typescript
-     * import termark from 'termark';
-     *
-     * termark.rgb('background', 128, 84, 249)('...');
-     * termark.rgb('text', [85, 222, 124])('...');
-     * ```
-     */
-    rgb(type: ANSIStyleType, ...rgb: RGB | [RGB]): (input: string | TemplateStringsArray) => string;
-    /**
-     * Apply a gradient to some text or its background.
-     *
-     * @param type Whether to apply the gradient to the text itself or its background.
-     * @param colors An array of RGB values
-     * @returns A function to specify an input, which returns the stylized input, assuming colours are enabled, *and* `truecolor` is enabled as well.
-     * @see https://htmlcolorcodes.com/ For colour conversions.
-     *
-     * @example
-     * ```typescript
-     * import termark from 'termark';
-     *
-     * termark.gradient('text', [[53, 72, 172], [200, 230, 121]])('...');
-     * termark.gradient('background', [[222, 111, 0], [93, 255, 68], [0, 224, 110]])('...');
-     * ```
-     */
-    gradient(type: ANSIStyleType, colors: RGB[]): (input: string | TemplateStringsArray) => string;
-    /**
-     * Logs a `message` to the console on the `info` level.
-     *
-     * **Note:** Since there is no dedicated '`success`' method, we have to print to the same level
-     * as `info()`.
-     *
-     * @param message The message to be logged in green as a success (info).
-     * @param prefix An optional brand prefix.
-     *
-     * @example
-     * ```typescript
-     * import termark from 'termark';
-     *
-     * termark.success('...'); // Logs "..." in green as a success (info).
-     * ```
-     */
-    success(message: string, prefix?: string): void;
-    /**
-     * Logs a `message` to the console on the `info` level.
-     *
-     * @param message The message to be logged in blue as an info.
-     * @param prefix An optional brand prefix.
-     *
-     * @example
-     * ```typescript
-     * import termark from 'termark';
-     *
-     * termark.info('...'); // Logs "..." in blue as an info.
-     * ```
-     */
-    info(message: string, prefix?: string): void;
-    /**
-     * Logs a `message` to the console on the `error` level.
-     *
-     * **Note:** In Node, `console.warn` and `console.error` print to the *same* level (`error`),
-     * and are therefore interchangeable. As such, this method only exists to provide a different look
-     * for an error message (e.g., for non-fatal errors).
-     *
-     * @param message The message to be logged in yellow as a warning (error).
-     * @param prefix An optional brand prefix.
-     *
-     * @example
-     * ```typescript
-     * import termark from 'termark';
-     *
-     * termark.warn('...'); // Logs "..." in yellow as a warning (error).
-     * ```
-     */
-    warn(message: string, prefix?: string): void;
-    /**
-     * Logs a `message` to the console on the `error` level.
-     *
-     * @param message The message to be logged in red as an error.
-     * @param prefix An optional brand prefix.
-     *
-     * @example
-     * ```typescript
-     * import termark from 'termark';
-     *
-     * termark.error('...'); // Logs "..." in red as an error.
-     * ```
-     */
-    error(message: string, prefix?: string): void;
-    /**
-     * Style some text using entirely custom settings.
-     *
-     * Please not that this method will not return any errors by itself.
-     * As such, it's advised that you're familiar with [the ANSI escape code](https://en.wikipedia.org/wiki/ANSI_escape_code) if you plan to use this method.
-     * However, this method will still return the plain text if the styling you want to apply doesn't exist.
-     *
-     * Also note that you **mustn't include the actual escape sequence (e.g., `\x1b[`), nor the symbol at the end of the code (e.g., `m`)**, only the parameters themselves.
-     *
-     * @param opener The code that should be prepended to the text. This is for styling your input itself.
-     * @param closer The code that should be appended to the text. This is for styling what comes after your input. It's best if this is either `0`, or the code to set the default style of something (e.g., `39` to reset to the default text colour).
-     * @param type Whether the formatting should be viewed as applying colour, or performing simple styling.If it is the former, styling won't be applied if terminal colours are disabled.
-     * @returns The text stylized using `opener`.
-     *
-     * @example
-     * ```typescript
-     * import termark from 'termark';
-     *
-     * termark.custom('58;2;33', 59)('...'); // This should result in a string with a blue underline.
-     * ```
-     */
-    custom(opener: string | number, closer: string | number, type: 'asColor' | 'asFormat'): (input: string | TemplateStringsArray) => string;
-}
-/**
- * The `termark` object enables accessing all features of Termark:
- *
- * - Properties (retrieve information)
- * - Methods (commands)
- *
- * For info regarding ANSI styling:
- * @see https://en.wikipedia.org/wiki/ANSI_escape_code
- *
- * ---
- *
- * With properties, you're able to use features of Termark that don't execute
- * any command per se, but simply to retrieve information; you don't perform
- * any operation with these.
- *
- * @example
- * ```typescript
- * import termark from 'termark';
- *
- * // All properties provided by Termark:
- *
- * termark.areColorsEnabled; // Check whether colours are enabled
- * termark.is8bitEnabled; // Check whether 8-bit (256) colours are enabled
- * termark.is24bitEnabled; // Check whether 24-bit (truecolor) colours are enabled
- * ```
- *
- * In addition, properties on the `Termark` class are static-ish, i.e., they only do one thing, and you have no input on it.
- *
- * ---
- *
- * With methods on the other hand, you *do* perform commands and operations.
- * Methods are dynamic, meaning that you *do* specify how they work.
- *
- * @example
- * ```typescript
- * import termark from 'termark';
- *
- * termark.red('...'); // Returns "..." in red.
- * termark.rgb('background', [255, 255, 255])('...'); // Returns "..." with a white background.
- * ```
- *
- * With all methods, you **must** append either `('...')` or ``` `...` ```, and replace "`...`"
- * with a string of your choosing. This is made possible by the fact that most of (see below) Termark's
- * methods return a function where you specify your input.
- *
- * @example
- * ```typescript
- * import termark from 'termark';
- *
- * termark.ansi256('text', 33)('This is blue text');
- * termark.ansi256('text', 33)`This is also blue text`;
- * ```
- *
- * ### Exceptions
- *
- * There are some exceptions to the above, however; not *all* of Termark's methods return
- * a function to specify your input. These ones are:
- *
- * ```typescript
- * import termark from 'termark';
- *
- * termark.success('...');
- * termark.info('...');
- * termark.warn('...');
- * termark.error('...');
- * ```
- *
- * This is because the above three methods handle console outputs for you. Therefore, they needn't
- * return a function where you specify your input.
- */
-declare const termark: Termark;
-export default termark;
-export declare const areColorsEnabled: boolean, is8bitEnabled: boolean, is24bitEnabled: boolean, reset: (input: string | TemplateStringsArray) => string, bold: (input: string | TemplateStringsArray) => string, dim: (input: string | TemplateStringsArray) => string, italic: (input: string | TemplateStringsArray) => string, underline: (input: string | TemplateStringsArray) => string, blink: (input: string | TemplateStringsArray) => string, inverse: (input: string | TemplateStringsArray) => string, overline: (input: string | TemplateStringsArray) => string, hidden: (input: string | TemplateStringsArray) => string, strike: (input: string | TemplateStringsArray) => string, black: (input: string | TemplateStringsArray) => string, red: (input: string | TemplateStringsArray) => string, green: (input: string | TemplateStringsArray) => string, yellow: (input: string | TemplateStringsArray) => string, blue: (input: string | TemplateStringsArray) => string, magenta: (input: string | TemplateStringsArray) => string, cyan: (input: string | TemplateStringsArray) => string, white: (input: string | TemplateStringsArray) => string, blackBright: (input: string | TemplateStringsArray) => string, redBright: (input: string | TemplateStringsArray) => string, greenBright: (input: string | TemplateStringsArray) => string, yellowBright: (input: string | TemplateStringsArray) => string, blueBright: (input: string | TemplateStringsArray) => string, magentaBright: (input: string | TemplateStringsArray) => string, cyanBright: (input: string | TemplateStringsArray) => string, whiteBright: (input: string | TemplateStringsArray) => string, bgBlack: (input: string | TemplateStringsArray) => string, bgRed: (input: string | TemplateStringsArray) => string, bgGreen: (input: string | TemplateStringsArray) => string, bgYellow: (input: string | TemplateStringsArray) => string, bgBlue: (input: string | TemplateStringsArray) => string, bgMagenta: (input: string | TemplateStringsArray) => string, bgCyan: (input: string | TemplateStringsArray) => string, bgWhite: (input: string | TemplateStringsArray) => string, bgBlackBright: (input: string | TemplateStringsArray) => string, bgRedBright: (input: string | TemplateStringsArray) => string, bgGreenBright: (input: string | TemplateStringsArray) => string, bgYellowBright: (input: string | TemplateStringsArray) => string, bgBlueBright: (input: string | TemplateStringsArray) => string, bgMagentaBright: (input: string | TemplateStringsArray) => string, bgCyanBright: (input: string | TemplateStringsArray) => string, bgWhiteBright: (input: string | TemplateStringsArray) => string, ansi256: (type: ANSIStyleType, color: number) => (input: string | TemplateStringsArray) => string, rgb: (type: ANSIStyleType, ...rgb: RGB | [RGB]) => (input: string | TemplateStringsArray) => string, gradient: (type: ANSIStyleType, colors: RGB[]) => (input: string | TemplateStringsArray) => string, success: (message: string, prefix?: string) => void, info: (message: string, prefix?: string) => void, warn: (message: string, prefix?: string) => void, error: (message: string, prefix?: string) => void, custom: (opener: string | number, closer: string | number, type: "asColor" | "asFormat") => (input: string | TemplateStringsArray) => string;

package/dist/util.d.ts

@@ -1,51 +0,0 @@
-export type ANSIStyleType = 'text' | 'background';
-export type RGB = [number, number, number];
-/**
- * Check whether terminal colours are supported/enabled.
- *
- * @returns If the `NO_COLOR` environment variable is undefined, true. If it has any value, it returns false, as per the [specifications](https://no-color.org/).
- */
-export declare const areColoursEnabled: () => boolean;
-/**
- * Check whether a colour level is supported.
- *
- * @returns A property that is used to check the colour level support.
- */
-export declare const getColourSupport: () => {
-    is16bit: boolean;
-    is256: boolean;
-    isTrueColor: boolean;
-};
-/**
- * Format some text using ANSI codes.
- *
- * @param open The code prepended to the text. This is used to style the text itself.
- * @param close The code appended to the text. This is used to style what comes immediately after the text, and should ideally be a reset code.
- * @param type Whether the styling applies basic formatting, or colours the text.
- * @returns If terminal colours are enabled and `type` is set to `'color'`, some coloured text. If `type` is set to `'format'`, the formatted text.
- */
-export declare function format(open: number | string, close: number | string, type: 'format' | 'color'): (input: string | TemplateStringsArray) => string;
-/**
- * Calculate an intermediate colour between two colours.
- *
- * This is done as follows:
- * We have two colours: `C1 = (R1,G1,B1)`, and `C2 = (R2,G2,B2)`, and we need to generate a gradient over a string of length `L`.
- * For each character at index `i` (from 0 to `L-1`), we need to find an interpolated colour `Ci`.
- *
- * For that, we can do the following:
- * ```txt
- * t = i/(L-1)
- *
- * Ri = R1 + t * (R2 - R1)
- * Gi = G1 + t * (G2 - G1)
- * Bi = B1 + t * (B2 - B1)
- * ```
- *
- * We then apply `Ci` to each character `i` to get our (mostly) smooth gradient.
- *
- * @param color1 The starting colour.
- * @param color2 The ending colour.
- * @param factor How to calculate the colour.
- * @returns An RGB value that is the colour between `color1` and `color2` at `factor`.
- */
-export declare function interpolate(color1: RGB, color2: RGB, factor: number): RGB;