termark 1.0.0 → 1.1.0

package/README.md

@@ -28,10 +28,13 @@ Termark is compatible with both ECMAScript modules (`import`/`export` syntax), a
 
 ```js
 // CJS:
-const termark = require('termark');
+const Termark = require('termark');
 
 // ESM:
-import termark from 'termark';
+import Termark from 'termark';
+
+// for both, you'd then likely do this for convenience:
+const termark = new Termark();
 ```
 
 ## Usage
@@ -39,7 +42,9 @@ import termark from 'termark';
 Here's a quick reference for every feature Termark provides:
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 console.log(
     termark.red('This is red text.'),
@@ -57,7 +62,9 @@ console.log(
 ### Basic ANSI styling
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 termark.reset('...');
 termark.bold('...');
@@ -74,7 +81,9 @@ termark.strike('...');
 ### 4-bit colours
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 termark.black('...');
 termark.red('...');
@@ -112,7 +121,9 @@ termark.bgWhiteBright('...');
 ### 8-bit colours
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 termark.ansi256('text', 33)('...');
 termark.ansi256('background', 200)('...');
@@ -121,7 +132,9 @@ termark.ansi256('background', 200)('...');
 ### 24-bit colours
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 // You can specify your RGB values as an array:
 termark.rgb('text', [182, 22, 234])('...');
@@ -141,7 +154,9 @@ termark.rgb('text', convert.hex.rgb('008330'))('...');
 ### Gradients
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 termark.gradient('text', [[200, 123, 0], [0, 255, 255], [177, 209, 10]])('...');
 termark.gradient('background', [[123, 75, 204], [255, 255, 255], [0, 44, 55]])('...');
@@ -169,7 +184,9 @@ We then apply $C_i$ to each character $i$ to get our (mostly) smooth gradient.
 ### Built-in terminal logging methods
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 termark.success('...'); // Logs some message in green as an info message.
 termark.info('...'); // Logs some message in blue as an info message.
@@ -186,7 +203,9 @@ termark.error('File not found', brandPrefix);
 ### Template strings
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 // Instead of using this:
 termark.blue('...');
@@ -198,7 +217,9 @@ termark.blue`...`;
 ### Nested styles
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 termark.blue(
     'This is some blue text ' +
@@ -210,7 +231,9 @@ termark.blue(
 ### Colour-detection utilities
 
 ```ts
-import termark from 'termark';
+import Termark from 'termark';
+
+const termark = new Termark();
 
 termark.areColorsEnabled; // Check whether terminal colours are enabled.
 termark.is8bitEnabled; // Check whether 8-bit (256) colours are enabled.

package/dist/index.cjs

@@ -1,181 +1 @@
-/*
-Copyright 2025 Q
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-'use strict';
-
-const areColoursEnabled = () => {
-    const noColour = process.env.NO_COLOR;
-    return noColour ? false : true;
-};
-const getColourSupport = () => {
-    const colourTerm = process.env.COLORTERM;
-    const is16bit = colourTerm ? (colourTerm.includes('ansi') && !(colourTerm.includes('256'))) : false;
-    const is256 = colourTerm ? colourTerm.includes('ansi256') : false;
-    const isTrueColor = colourTerm ? (colourTerm.includes('truecolor') || colourTerm.includes('24bit')) : false;
-    return {
-        is16bit,
-        is256,
-        isTrueColor
-    };
-};
-function format(open, close, type) {
-    if (type === 'color' && !areColoursEnabled())
-        return (input) => input.toString();
-    const opener = `\x1b[${open}m`;
-    const closer = `\x1b[${close}m`;
-    return (input$1) => {
-        const input = input$1.toString().trim();
-        const index = input.indexOf(closer);
-        if (index === -1)
-            return `${opener}${input}${closer}`;
-        return `${opener}${input.replaceAll(closer, closer + opener)}${closer}`;
-    };
-}
-function interpolate(color1, color2, factor) {
-    return [
-        Math.round(color1[0] + factor * (color2[0] - color1[0])),
-        Math.round(color1[1] + factor * (color2[1] - color1[1])),
-        Math.round(color1[2] + factor * (color2[2] - color1[2])),
-    ];
-}
-
-const termark = {
-    areColorsEnabled: areColoursEnabled(),
-    is8bitEnabled: getColourSupport().is256,
-    is24bitEnabled: getColourSupport().isTrueColor,
-    reset: format(0, 0, 'format'),
-    bold: format(1, 22, 'format'),
-    dim: format(2, 22, 'format'),
-    italic: format(3, 23, 'format'),
-    underline: format(4, 24, 'format'),
-    blink: format(5, 25, 'format'),
-    inverse: format(7, 27, 'format'),
-    overline: format(53, 55, 'format'),
-    hidden: format(8, 28, 'format'),
-    strike: format(9, 29, 'format'),
-    black: format(30, 39, 'color'),
-    red: format(31, 39, 'color'),
-    green: format(32, 39, 'color'),
-    yellow: format(33, 39, 'color'),
-    blue: format(34, 39, 'color'),
-    magenta: format(35, 39, 'color'),
-    cyan: format(36, 39, 'color'),
-    white: format(37, 39, 'color'),
-    blackBright: format(90, 39, 'color'),
-    redBright: format(91, 39, 'color'),
-    greenBright: format(92, 39, 'color'),
-    yellowBright: format(93, 39, 'color'),
-    blueBright: format(94, 39, 'color'),
-    magentaBright: format(95, 39, 'color'),
-    cyanBright: format(96, 39, 'color'),
-    whiteBright: format(97, 39, 'color'),
-    bgBlack: format(40, 49, 'color'),
-    bgRed: format(41, 49, 'color'),
-    bgGreen: format(42, 49, 'color'),
-    bgYellow: format(43, 49, 'color'),
-    bgBlue: format(44, 49, 'color'),
-    bgMagenta: format(45, 49, 'color'),
-    bgCyan: format(46, 49, 'color'),
-    bgWhite: format(47, 49, 'color'),
-    bgBlackBright: format(100, 49, 'color'),
-    bgRedBright: format(101, 49, 'color'),
-    bgGreenBright: format(102, 49, 'color'),
-    bgYellowBright: format(103, 49, 'color'),
-    bgBlueBright: format(104, 49, 'color'),
-    bgMagentaBright: format(105, 49, 'color'),
-    bgCyanBright: format(106, 49, 'color'),
-    bgWhiteBright: format(107, 49, 'color'),
-    ansi256(type, color) {
-        if (color < 0 || color > 255)
-            throw new Error(termark.red('Value `color` is out of range! The value must be a number between 0 and 255!'));
-        if (!getColourSupport().is256 || !areColoursEnabled())
-            return (input) => input.toString();
-        const textFormat = `38;5;${color}`;
-        const bgFormat = `48;5;${color}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    rgb(type, ...rgb) {
-        let red;
-        let green;
-        let blue;
-        if (Array.isArray(rgb[0])) {
-            red = rgb[0][0];
-            green = rgb[0][1];
-            blue = rgb[0][2];
-        }
-        else {
-            red = rgb[0];
-            green = rgb[1];
-            blue = rgb[2];
-        }
-        if (((typeof red === 'number') && (red < 0 || red > 255)) ||
-            ((typeof green === 'number') && (green < 0 || green > 255)) ||
-            ((typeof blue === 'number') && (blue < 0 || blue > 255)))
-            throw new Error(termark.red('One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!'));
-        if (!getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;${red};${green};${blue}`;
-        const bgFormat = `48;2;${red};${green};${blue}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    gradient(type, colors) {
-        if (!areColoursEnabled() || !getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;`;
-        const bgFormat = `48;2;`;
-        const opener = type === 'text' ? `\x1b[${textFormat}` : `\x1b[${bgFormat}`;
-        const closer = type === 'text' ? `\x1b[${39}m` : `\x1b[${49}m`;
-        return (input$1) => {
-            const input = input$1.toString().trim();
-            const colourCount = colors.length;
-            const step = Math.min(input.length / (colourCount - 1));
-            let result = '';
-            for (let character = 0; character < input.length; character++) {
-                const colourIndex = Math.min(Math.floor(character / step), colourCount - 2);
-                const factor = (character % step) / step;
-                const startColour = colors[colourIndex];
-                const endColour = colors[colourIndex + 1];
-                const interpolatedColour = interpolate(startColour, endColour, factor);
-                result += `${opener}${interpolatedColour[0]};${interpolatedColour[1]};${interpolatedColour[2]}m${input[character]}${closer}`;
-            }
-            return result;
-        };
-    },
-    success(message, prefix = '') {
-        console.info(`${prefix}${termark.green(message)}`);
-    },
-    info(message, prefix = '') {
-        console.info(`${prefix}${termark.blue(message)}`);
-    },
-    warn(message, prefix = '') {
-        console.warn(`${prefix}${termark.yellow(message)}`);
-    },
-    error(message, prefix = '') {
-        console.error(`${prefix}${termark.red(message)}`);
-    },
-    custom(opener, closer, type) {
-        const formatType = type === 'asColor' ? 'color' : 'format';
-        return format(opener, closer, formatType);
-    },
-};
-
-module.exports = termark;
-
-// Copyright (C) 2025 Q
+"use strict";const r=()=>!process.env.NO_COLOR,t=()=>{const r=process.env.COLORTERM;return{is16bit:!!r&&(r.includes("ansi")&&!r.includes("256")),is256:!!r&&r.includes("ansi256"),isTrueColor:!!r&&(r.includes("truecolor")||r.includes("24bit"))}};function o(t,o,e){if("color"===e&&!r())return r=>r.toString();const i=`[${t}m`,n=`[${o}m`;return r=>{const t=r.toString().trim();return-1===t.indexOf(n)?`${i}${t}${n}`:`${i}${t.replaceAll(n,n+i)}${n}`}}function e(r,t,o){return[Math.round(r[0]+o*(t[0]-r[0])),Math.round(r[1]+o*(t[1]-r[1])),Math.round(r[2]+o*(t[2]-r[2]))]}class i{constructor(){this.areColorsEnabled=r(),this.is8bitEnabled=t().is256,this.is24bitEnabled=t().isTrueColor,this.reset=o(0,0,"format"),this.bold=o(1,22,"format"),this.dim=o(2,22,"format"),this.italic=o(3,23,"format"),this.underline=o(4,24,"format"),this.blink=o(5,25,"format"),this.inverse=o(7,27,"format"),this.overline=o(53,55,"format"),this.hidden=o(8,28,"format"),this.strike=o(9,29,"format"),this.black=o(30,39,"color"),this.red=o(31,39,"color"),this.green=o(32,39,"color"),this.yellow=o(33,39,"color"),this.blue=o(34,39,"color"),this.magenta=o(35,39,"color"),this.cyan=o(36,39,"color"),this.white=o(37,39,"color"),this.blackBright=o(90,39,"color"),this.redBright=o(91,39,"color"),this.greenBright=o(92,39,"color"),this.yellowBright=o(93,39,"color"),this.blueBright=o(94,39,"color"),this.magentaBright=o(95,39,"color"),this.cyanBright=o(96,39,"color"),this.whiteBright=o(97,39,"color"),this.bgBlack=o(40,49,"color"),this.bgRed=o(41,49,"color"),this.bgGreen=o(42,49,"color"),this.bgYellow=o(43,49,"color"),this.bgBlue=o(44,49,"color"),this.bgMagenta=o(45,49,"color"),this.bgCyan=o(46,49,"color"),this.bgWhite=o(47,49,"color"),this.bgBlackBright=o(100,49,"color"),this.bgRedBright=o(101,49,"color"),this.bgGreenBright=o(102,49,"color"),this.bgYellowBright=o(103,49,"color"),this.bgBlueBright=o(104,49,"color"),this.bgMagentaBright=o(105,49,"color"),this.bgCyanBright=o(106,49,"color"),this.bgWhiteBright=o(107,49,"color")}ansi256(e,n){if(n<0||n>255)throw new Error((new i).red("Value `color` is out of range! The value must be a number between 0 and 255!"));if(!t().is256||!r())return r=>r.toString();return o("text"===e?`38;5;${n}`:`48;5;${n}`,"text"===e?39:49,"color")}rgb(r,...e){let n,l,s;if(Array.isArray(e[0])?(n=e[0][0],l=e[0][1],s=e[0][2]):(n=e[0],l=e[1],s=e[2]),"number"==typeof n&&(n<0||n>255)||"number"==typeof l&&(l<0||l>255)||"number"==typeof s&&(s<0||s>255))throw new Error((new i).red("One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!"));if(!t().isTrueColor)return r=>r.toString();return o("text"===r?`38;2;${n};${l};${s}`:`48;2;${n};${l};${s}`,"text"===r?39:49,"color")}gradient(o,i){if(!r()||!t().isTrueColor)return r=>r.toString();const n="text"===o?"[38;2;":"[48;2;",l="text"===o?"":"";return r=>{const t=r.toString().trim(),o=i.length,s=Math.min(t.length/(o-1));let h="";for(let r=0;r<t.length;r++){const c=Math.min(Math.floor(r/s),o-2),a=r%s/s,g=e(i[c],i[c+1],a);h+=`${n}${g[0]};${g[1]};${g[2]}m${t[r]}${l}`}return h}}success(r,t=""){console.info(`${t}${(new i).green(r)}`)}info(r,t=""){console.info(`${t}${(new i).blue(r)}`)}warn(r,t=""){console.warn(`${t}${(new i).yellow(r)}`)}error(r,t=""){console.error(`${t}${(new i).red(r)}`)}custom(r,t,e){return o(r,t,"asColor"===e?"color":"format")}}module.exports=i;

package/dist/index.d.ts

@@ -1,318 +1,172 @@
+import { ANSIStyleType, RGB } from './util';
 /**
- * All properties and methods provided by Termark.
+ * The `Termark` class 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';
+ *
+ * const termark = new 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';
+ *
+ * const termark = new 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';
+ *
+ * const termark = new 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';
+ *
+ * const termark = new 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.
  */
-interface Termark {
-    /**
-     * Check whether terminal colours are enabled.
-     *
-     * @returns true If terminal colours are enabled.
-     */
+export default class Termark {
+    /** Check whether terminal colours are enabled. */
     areColorsEnabled: boolean;
-    /**
-     * Check whether 8-bit colours are enabled.
-     *
-     * @returns true If 8-bit colours are enabled.
-     */
+    /** Check whether 8-bit colours are enabled. */
     is8bitEnabled: boolean;
-    /**
-     * Check whether 24-bit colours (truecolor) are enabled.
-     *
-     * @returns true If 24-bit colours are enabled.
-     */
+    /** Check whether 24-bit colours are enabled. */
     is24bitEnabled: boolean;
-    /**
-     * Reset all formatting of some text.
-     *
-     * @param input The text to format.
-     * @returns The formatted text.
-     */
+    /** Reset all styles. */
     reset: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bold.
-     *
-     * @param input The text to format.
-     * @returns The text in bold letters.
-     */
+    /** Make some text bold. */
     bold: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text thinner.
-     *
-     * @param input The text to format.
-     * @returns The text in thinner letters.
-     */
+    /** Make some text thin. */
     dim: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text italic. May not be widely supported.
-     *
-     * @param input The text to format.
-     * @returns The text with italicized (usually slanted) letters.
-     */
+    /** Make some text italic. May not be widely supported. */
     italic: (input: string | TemplateStringsArray) => string;
-    /**
-     * Underline some text.
-     *
-     * @param input The text to format.
-     * @returns The underlined text.
-     */
+    /** Underline some text. */
     underline: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text blink slowly.
-     *
-     * @param input The text to format.
-     * @returns The blinking text.
-     */
+    /** Make some text blink slowly. */
     blink: (input: string | TemplateStringsArray) => string;
-    /**
-     * Invert some text (foreground colour becomes background colour, background colour becomes foreground colour).
-     *
-     * @param input The text to format.
-     * @returns The inverted text.
-     */
+    /** 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).
-     *
-     * @param input The text to format.
-     * @returns The text with a line above it.
-     */
+    /** Add a line above some text. May not be widely supported. */
     overline: (input: string | TemplateStringsArray) => string;
-    /**
-     * Hide some text (may not be widely supported).
-     *
-     * @param input The text to format.
-     * @returns The hidden text.
-     */
+    /** Visually hide some text. */
     hidden: (input: string | TemplateStringsArray) => string;
-    /**
-     * Add a line through (strike) some text.
-     *
-     * @param input The text to format.
-     * @returns The striked text.
-     */
+    /** Add a line through (strike) some text. */
     strike: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text black.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured black.
-     */
+    /** Colour some text black. */
     black: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text red.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured red.
-     */
+    /** Colour some text red. */
     red: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text green.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured green.
-     */
+    /** Colour some text green. */
     green: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text yellow.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured yellow.
-     */
+    /** Colour some text yellow. */
     yellow: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text blue.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured blue.
-     */
+    /** Colour some text blue. */
     blue: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text magenta.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured magenta.
-     */
+    /** Colour some text magenta. */
     magenta: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text cyan.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured cyan.
-     */
+    /** Colour some text cyan. */
     cyan: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text white.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured white.
-     */
+    /** Colour some text white. */
     white: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright black (grey).
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright black (grey).
-     */
+    /** Colour some text bright black (grey). */
     blackBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright red.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright red.
-     */
+    /** Colour some text bright red. */
     redBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright green.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright green.
-     */
+    /** Colour some text bright green. */
     greenBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright yellow.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright yellow.
-     */
+    /** Colour some text bright yellow. */
     yellowBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright blue.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright blue.
-     */
+    /** Colour some text bright blue. */
     blueBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright magenta.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright magenta.
-     */
+    /** Colour some text bright magenta. */
     magentaBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright cyran.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright cyan.
-     */
+    /** Colour some text bright cyan. */
     cyanBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright white.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright white.
-     */
+    /** Colour some text bright white. */
     whiteBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text black.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a black background.
-     */
+    /** Colour the background of some text black. */
     bgBlack: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text red.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a red background.
-     */
+    /** Colour the background of some text red. */
     bgRed: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text green.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a green background.
-     */
+    /** Colour the background of some text green. */
     bgGreen: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text yellow.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a yellow background.
-     */
+    /** Colour the background of some text yellow. */
     bgYellow: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text blue.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a blue background.
-     */
+    /** Colour the background of some text blue. */
     bgBlue: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text magenta.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a magenta background.
-     */
+    /** Colour the background of some text magenta. */
     bgMagenta: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text cyan.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a cyan background.
-     */
+    /** Colour the background of some text cyan. */
     bgCyan: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text white.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a white background.
-     */
+    /** Colour the background of some text white. */
     bgWhite: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright black (grey).
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright black (grey) background.
-     */
+    /** Colour the background of some text bright black (grey). */
     bgBlackBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright red.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright re backgroundd.
-     */
+    /** Colour the background of some text bright red. */
     bgRedBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright green.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright gree backgroundn.
-     */
+    /** Colour the background of some text bright green. */
     bgGreenBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright yellow.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright yello backgroundw.
-     */
+    /** Colour the background of some text bright yellow. */
     bgYellowBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright blue.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright blu backgrounde.
-     */
+    /** Colour the background of some text bright blue. */
     bgBlueBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright magenta.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright magent backgrounda.
-     */
+    /** Colour the background of some text bright magenta. */
     bgMagentaBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright cyan.
-     *
-     * @param input The desired text to be styled.
-     * @returns If colours are enabled, `input` with a bright cyan background.
-     */
+    /** Colour the background of some text bright cyan. */
     bgCyanBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright white.
-     *
-     * @param input The desired text to be styled.
-     * @returns If colours are enabled, `input` with a bright white background.
-     */
+    /** Colour the background of some text bright white. */
     bgWhiteBright: (input: string | TemplateStringsArray) => string;
     /**
      * Make some text or its background one of 256 colours.
@@ -324,7 +178,7 @@ interface Termark {
      * @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: 'text' | 'background', color: number) => (input: string | TemplateStringsArray) => string;
+    ansi256(type: ANSIStyleType, color: number): (input: string | TemplateStringsArray) => string;
     /**
      * Make some text or its background using custom RGB values.
      *
@@ -340,7 +194,7 @@ interface Termark {
      * termark.rgb('text', [85, 222, 124])('...');
      * ```
      */
-    rgb: (type: 'text' | 'background', ...rgb: [number, number, number] | [[number, number, number]]) => (input: string | TemplateStringsArray) => string;
+    rgb(type: ANSIStyleType, ...rgb: RGB | [RGB]): (input: string | TemplateStringsArray) => string;
     /**
      * Apply a gradient to some text or its background.
      *
@@ -357,7 +211,7 @@ interface Termark {
      * termark.gradient('background', [[222, 111, 0], [93, 255, 68], [0, 224, 110]])('...');
      * ```
      */
-    gradient: (type: 'text' | 'background', colors: [number, number, number][]) => (input: string | TemplateStringsArray) => string;
+    gradient(type: ANSIStyleType, colors: RGB[]): (input: string | TemplateStringsArray) => string;
     /**
      * Logs a `message` to the console on the `info` level.
      *
@@ -374,7 +228,7 @@ interface Termark {
      * termark.success('...'); // Logs "..." in green as a success (info).
      * ```
      */
-    success: (message: string, prefix?: string) => void;
+    success(message: string, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `info` level.
      *
@@ -388,7 +242,7 @@ interface Termark {
      * termark.info('...'); // Logs "..." in blue as an info.
      * ```
      */
-    info: (message: string, prefix?: string) => void;
+    info(message: string, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `error` level.
      *
@@ -406,7 +260,7 @@ interface Termark {
      * termark.warn('...'); // Logs "..." in yellow as a warning (error).
      * ```
      */
-    warn: (message: string, prefix?: string) => void;
+    warn(message: string, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `error` level.
      *
@@ -420,7 +274,7 @@ interface Termark {
      * termark.error('...'); // Logs "..." in red as an error.
      * ```
      */
-    error: (message: string, prefix?: string) => void;
+    error(message: string, prefix?: string): void;
     /**
      * Style some text using entirely custom settings.
      *
@@ -442,73 +296,5 @@ interface Termark {
      * termark.custom('58;2;33', 59)('...'); // This should result in a string with a blue underline.
      * ```
      */
-    custom: (opener: number | string, closer: number | string, type: 'asFormat' | 'asColor') => (input: string | TemplateStringsArray) => string;
+    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` object are static, 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
- * 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
- * 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;

package/dist/index.mjs

@@ -1,179 +1 @@
-/*
-Copyright 2025 Q
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-const areColoursEnabled = () => {
-    const noColour = process.env.NO_COLOR;
-    return noColour ? false : true;
-};
-const getColourSupport = () => {
-    const colourTerm = process.env.COLORTERM;
-    const is16bit = colourTerm ? (colourTerm.includes('ansi') && !(colourTerm.includes('256'))) : false;
-    const is256 = colourTerm ? colourTerm.includes('ansi256') : false;
-    const isTrueColor = colourTerm ? (colourTerm.includes('truecolor') || colourTerm.includes('24bit')) : false;
-    return {
-        is16bit,
-        is256,
-        isTrueColor
-    };
-};
-function format(open, close, type) {
-    if (type === 'color' && !areColoursEnabled())
-        return (input) => input.toString();
-    const opener = `\x1b[${open}m`;
-    const closer = `\x1b[${close}m`;
-    return (input$1) => {
-        const input = input$1.toString().trim();
-        const index = input.indexOf(closer);
-        if (index === -1)
-            return `${opener}${input}${closer}`;
-        return `${opener}${input.replaceAll(closer, closer + opener)}${closer}`;
-    };
-}
-function interpolate(color1, color2, factor) {
-    return [
-        Math.round(color1[0] + factor * (color2[0] - color1[0])),
-        Math.round(color1[1] + factor * (color2[1] - color1[1])),
-        Math.round(color1[2] + factor * (color2[2] - color1[2])),
-    ];
-}
-
-const termark = {
-    areColorsEnabled: areColoursEnabled(),
-    is8bitEnabled: getColourSupport().is256,
-    is24bitEnabled: getColourSupport().isTrueColor,
-    reset: format(0, 0, 'format'),
-    bold: format(1, 22, 'format'),
-    dim: format(2, 22, 'format'),
-    italic: format(3, 23, 'format'),
-    underline: format(4, 24, 'format'),
-    blink: format(5, 25, 'format'),
-    inverse: format(7, 27, 'format'),
-    overline: format(53, 55, 'format'),
-    hidden: format(8, 28, 'format'),
-    strike: format(9, 29, 'format'),
-    black: format(30, 39, 'color'),
-    red: format(31, 39, 'color'),
-    green: format(32, 39, 'color'),
-    yellow: format(33, 39, 'color'),
-    blue: format(34, 39, 'color'),
-    magenta: format(35, 39, 'color'),
-    cyan: format(36, 39, 'color'),
-    white: format(37, 39, 'color'),
-    blackBright: format(90, 39, 'color'),
-    redBright: format(91, 39, 'color'),
-    greenBright: format(92, 39, 'color'),
-    yellowBright: format(93, 39, 'color'),
-    blueBright: format(94, 39, 'color'),
-    magentaBright: format(95, 39, 'color'),
-    cyanBright: format(96, 39, 'color'),
-    whiteBright: format(97, 39, 'color'),
-    bgBlack: format(40, 49, 'color'),
-    bgRed: format(41, 49, 'color'),
-    bgGreen: format(42, 49, 'color'),
-    bgYellow: format(43, 49, 'color'),
-    bgBlue: format(44, 49, 'color'),
-    bgMagenta: format(45, 49, 'color'),
-    bgCyan: format(46, 49, 'color'),
-    bgWhite: format(47, 49, 'color'),
-    bgBlackBright: format(100, 49, 'color'),
-    bgRedBright: format(101, 49, 'color'),
-    bgGreenBright: format(102, 49, 'color'),
-    bgYellowBright: format(103, 49, 'color'),
-    bgBlueBright: format(104, 49, 'color'),
-    bgMagentaBright: format(105, 49, 'color'),
-    bgCyanBright: format(106, 49, 'color'),
-    bgWhiteBright: format(107, 49, 'color'),
-    ansi256(type, color) {
-        if (color < 0 || color > 255)
-            throw new Error(termark.red('Value `color` is out of range! The value must be a number between 0 and 255!'));
-        if (!getColourSupport().is256 || !areColoursEnabled())
-            return (input) => input.toString();
-        const textFormat = `38;5;${color}`;
-        const bgFormat = `48;5;${color}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    rgb(type, ...rgb) {
-        let red;
-        let green;
-        let blue;
-        if (Array.isArray(rgb[0])) {
-            red = rgb[0][0];
-            green = rgb[0][1];
-            blue = rgb[0][2];
-        }
-        else {
-            red = rgb[0];
-            green = rgb[1];
-            blue = rgb[2];
-        }
-        if (((typeof red === 'number') && (red < 0 || red > 255)) ||
-            ((typeof green === 'number') && (green < 0 || green > 255)) ||
-            ((typeof blue === 'number') && (blue < 0 || blue > 255)))
-            throw new Error(termark.red('One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!'));
-        if (!getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;${red};${green};${blue}`;
-        const bgFormat = `48;2;${red};${green};${blue}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    gradient(type, colors) {
-        if (!areColoursEnabled() || !getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;`;
-        const bgFormat = `48;2;`;
-        const opener = type === 'text' ? `\x1b[${textFormat}` : `\x1b[${bgFormat}`;
-        const closer = type === 'text' ? `\x1b[${39}m` : `\x1b[${49}m`;
-        return (input$1) => {
-            const input = input$1.toString().trim();
-            const colourCount = colors.length;
-            const step = Math.min(input.length / (colourCount - 1));
-            let result = '';
-            for (let character = 0; character < input.length; character++) {
-                const colourIndex = Math.min(Math.floor(character / step), colourCount - 2);
-                const factor = (character % step) / step;
-                const startColour = colors[colourIndex];
-                const endColour = colors[colourIndex + 1];
-                const interpolatedColour = interpolate(startColour, endColour, factor);
-                result += `${opener}${interpolatedColour[0]};${interpolatedColour[1]};${interpolatedColour[2]}m${input[character]}${closer}`;
-            }
-            return result;
-        };
-    },
-    success(message, prefix = '') {
-        console.info(`${prefix}${termark.green(message)}`);
-    },
-    info(message, prefix = '') {
-        console.info(`${prefix}${termark.blue(message)}`);
-    },
-    warn(message, prefix = '') {
-        console.warn(`${prefix}${termark.yellow(message)}`);
-    },
-    error(message, prefix = '') {
-        console.error(`${prefix}${termark.red(message)}`);
-    },
-    custom(opener, closer, type) {
-        const formatType = type === 'asColor' ? 'color' : 'format';
-        return format(opener, closer, formatType);
-    },
-};
-
-export { termark as default };
-
-// Copyright (C) 2025 Q
+const r=()=>!process.env.NO_COLOR,t=()=>{const r=process.env.COLORTERM;return{is16bit:!!r&&(r.includes("ansi")&&!r.includes("256")),is256:!!r&&r.includes("ansi256"),isTrueColor:!!r&&(r.includes("truecolor")||r.includes("24bit"))}};function o(t,o,e){if("color"===e&&!r())return r=>r.toString();const i=`[${t}m`,n=`[${o}m`;return r=>{const t=r.toString().trim();return-1===t.indexOf(n)?`${i}${t}${n}`:`${i}${t.replaceAll(n,n+i)}${n}`}}function e(r,t,o){return[Math.round(r[0]+o*(t[0]-r[0])),Math.round(r[1]+o*(t[1]-r[1])),Math.round(r[2]+o*(t[2]-r[2]))]}class i{constructor(){this.areColorsEnabled=r(),this.is8bitEnabled=t().is256,this.is24bitEnabled=t().isTrueColor,this.reset=o(0,0,"format"),this.bold=o(1,22,"format"),this.dim=o(2,22,"format"),this.italic=o(3,23,"format"),this.underline=o(4,24,"format"),this.blink=o(5,25,"format"),this.inverse=o(7,27,"format"),this.overline=o(53,55,"format"),this.hidden=o(8,28,"format"),this.strike=o(9,29,"format"),this.black=o(30,39,"color"),this.red=o(31,39,"color"),this.green=o(32,39,"color"),this.yellow=o(33,39,"color"),this.blue=o(34,39,"color"),this.magenta=o(35,39,"color"),this.cyan=o(36,39,"color"),this.white=o(37,39,"color"),this.blackBright=o(90,39,"color"),this.redBright=o(91,39,"color"),this.greenBright=o(92,39,"color"),this.yellowBright=o(93,39,"color"),this.blueBright=o(94,39,"color"),this.magentaBright=o(95,39,"color"),this.cyanBright=o(96,39,"color"),this.whiteBright=o(97,39,"color"),this.bgBlack=o(40,49,"color"),this.bgRed=o(41,49,"color"),this.bgGreen=o(42,49,"color"),this.bgYellow=o(43,49,"color"),this.bgBlue=o(44,49,"color"),this.bgMagenta=o(45,49,"color"),this.bgCyan=o(46,49,"color"),this.bgWhite=o(47,49,"color"),this.bgBlackBright=o(100,49,"color"),this.bgRedBright=o(101,49,"color"),this.bgGreenBright=o(102,49,"color"),this.bgYellowBright=o(103,49,"color"),this.bgBlueBright=o(104,49,"color"),this.bgMagentaBright=o(105,49,"color"),this.bgCyanBright=o(106,49,"color"),this.bgWhiteBright=o(107,49,"color")}ansi256(e,n){if(n<0||n>255)throw new Error((new i).red("Value `color` is out of range! The value must be a number between 0 and 255!"));if(!t().is256||!r())return r=>r.toString();return o("text"===e?`38;5;${n}`:`48;5;${n}`,"text"===e?39:49,"color")}rgb(r,...e){let n,l,s;if(Array.isArray(e[0])?(n=e[0][0],l=e[0][1],s=e[0][2]):(n=e[0],l=e[1],s=e[2]),"number"==typeof n&&(n<0||n>255)||"number"==typeof l&&(l<0||l>255)||"number"==typeof s&&(s<0||s>255))throw new Error((new i).red("One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!"));if(!t().isTrueColor)return r=>r.toString();return o("text"===r?`38;2;${n};${l};${s}`:`48;2;${n};${l};${s}`,"text"===r?39:49,"color")}gradient(o,i){if(!r()||!t().isTrueColor)return r=>r.toString();const n="text"===o?"[38;2;":"[48;2;",l="text"===o?"":"";return r=>{const t=r.toString().trim(),o=i.length,s=Math.min(t.length/(o-1));let h="";for(let r=0;r<t.length;r++){const c=Math.min(Math.floor(r/s),o-2),a=r%s/s,g=e(i[c],i[c+1],a);h+=`${n}${g[0]};${g[1]};${g[2]}m${t[r]}${l}`}return h}}success(r,t=""){console.info(`${t}${(new i).green(r)}`)}info(r,t=""){console.info(`${t}${(new i).blue(r)}`)}warn(r,t=""){console.warn(`${t}${(new i).yellow(r)}`)}error(r,t=""){console.error(`${t}${(new i).red(r)}`)}custom(r,t,e){return o(r,t,"asColor"===e?"color":"format")}}export{i as default};

package/dist/util.d.ts

@@ -1,3 +1,5 @@
+export type ANSIStyleType = 'text' | 'background';
+export type RGB = [number, number, number];
 /**
  * Check whether terminal colours are supported/enabled.
  *
@@ -46,4 +48,4 @@ export declare function format(open: number | string, close: number | string, ty
  * @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: [number, number, number], color2: [number, number, number], factor: number): [number, number, number];
+export declare function interpolate(color1: RGB, color2: RGB, factor: number): RGB;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "termark",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "main": "./dist/index.cjs",
     "module": "./dist/index.mjs",
     "exports": {
@@ -30,9 +30,9 @@
         "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-cleanup": "^3.2.1",
         "rollup-plugin-typescript2": "^0.36.0",
         "typescript": "^5.9.2"
     }