termark 1.1.0 → 2.0.0

package/README.md

@@ -4,9 +4,10 @@ Termark is a basic library to format console output to the standard non-browser
 
 ## Features & Highlights
 
-- 0-dependency
+- Zero dependencies
 - [ESM & CJS compatible](#esm--cjs-compatibility)
 - [NO_COLOR](https://no-color.org/)-friendly
+- [Default and named imports]
 - [Basic ANSI styling](#basic-ansi-styling) (`dim`, `bold`, `italic`, …)
 - [4-bit](#4-bit-colours) ($2^4 = 16$) colours (`red`, `cyan`, `blueBright`, …)
 - [8-bit](#8-bit-colours) ($2^8 = 256$) colours (`ansi256()`)
@@ -15,6 +16,7 @@ Termark is a basic library to format console output to the standard non-browser
 - Built-in [terminal logging methods](#built-in-terminal-logging-methods) (`success()`, `info()`, `warn()`, `error()`)
 - [Template strings](#template-strings) & [nested styles](#nested-styles) (``` green`Success: File ${cyan`plans.txt`} created successfully!` ```)
 - [Colour-detection utilities](#colour-detection-utilities) (`areColorsEnabled`, `is8bitEnabled`, `is24bitEnabled`)
+- [Usage as an object or as a class](#class-v-object)
 
 ## Installation
 
@@ -28,13 +30,28 @@ 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';
+```
+
+## Default & named imports
+
+Termark offers both a default import that has access to all properties and methods, or you can import each one individually:
+
+```ts
+// Default import:
+import termark from 'termark';
 
-// for both, you'd then likely do this for convenience:
-const termark = new Termark();
+termark.info('This is the default import, where all properties and methods are accessible.');
+
+// Named imports:
+import { success, inverse } from 'termark';
+
+success(
+    inverse('This text with a green background is achieved with named imports!')
+)
 ```
 
 ## Usage
@@ -42,9 +59,7 @@ const termark = new Termark();
 Here's a quick reference for every feature Termark provides:
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 console.log(
     termark.red('This is red text.'),
@@ -62,9 +77,7 @@ console.log(
 ### Basic ANSI styling
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 termark.reset('...');
 termark.bold('...');
@@ -81,9 +94,7 @@ termark.strike('...');
 ### 4-bit colours
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 termark.black('...');
 termark.red('...');
@@ -121,9 +132,7 @@ termark.bgWhiteBright('...');
 ### 8-bit colours
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 termark.ansi256('text', 33)('...');
 termark.ansi256('background', 200)('...');
@@ -132,9 +141,7 @@ termark.ansi256('background', 200)('...');
 ### 24-bit colours
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 // You can specify your RGB values as an array:
 termark.rgb('text', [182, 22, 234])('...');
@@ -153,40 +160,19 @@ termark.rgb('text', convert.hex.rgb('008330'))('...');
 
 ### Gradients
 
-```ts
-import Termark from 'termark';
+**Please note that gradients do not support nested styling.**
 
-const termark = new Termark();
+```ts
+import termark from '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]])('...');
 ```
 
-The way this works is as follows:
-
-We have two colours $C_1 = (R_1,G_1,B_1)$ and $C_2 = (R_2,G_2,B_2)$, 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 $C_i$.  
-For that, we can do the following:
-
-$$
-\begin{align*}
-t   &= \frac{i}{L-1} \\\\
-R_i &= R_1 + t \times (R_2 - R_1) \\
-G_i &= G_1 + t \times (G_2 - G_1) \\
-B_i &= B_1 + t \times (B_2 - B_1)
-\end{align*}
-$$
-
-We then apply $C_i$ to each character $i$ to get our (mostly) smooth gradient.
-
-**Please note that gradients do not support nested styling.**
-
 ### Built-in terminal logging methods
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 termark.success('...'); // Logs some message in green as an info message.
 termark.info('...'); // Logs some message in blue as an info message.
@@ -203,9 +189,7 @@ termark.error('File not found', brandPrefix);
 ### Template strings
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 // Instead of using this:
 termark.blue('...');
@@ -217,9 +201,7 @@ termark.blue`...`;
 ### Nested styles
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 termark.blue(
     'This is some blue text ' +
@@ -231,15 +213,29 @@ termark.blue(
 ### Colour-detection utilities
 
 ```ts
-import Termark from 'termark';
-
-const termark = new Termark();
+import termark from 'termark';
 
 termark.areColorsEnabled; // Check whether terminal colours are enabled.
 termark.is8bitEnabled; // Check whether 8-bit (256) colours are enabled.
 termark.is24bitEnabled; // Check whether 24-bit (truecolor) colours are enabled.
 ```
 
+### Class v. Object
+
+You can use Termark by importing the object, or you can import the class:
+
+```ts
+import { Termark } from 'termark';
+
+const termark = new Termark(); // This is the same as importing the `termark` object.
+termark.success('Termark is working!');
+
+// Alternatively, you could do this:
+Termark.init.success('This work, too!');
+```
+
+`Termark.init` enables using the `Termark` class as the default `termark` object.
+
 ## Licence
 
 Termark's code is licenced under the [Apache licence version 2](https://www.apache.org/licenses/LICENSE-2.0).  

package/dist/index.cjs

@@ -1 +1 @@
-"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;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});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 e(t,e,o){if("color"===o&&!r())return r=>r.toString();const i=`[${t}m`,s=`[${e}m`;return r=>{const t=r.toString().trim();return-1===t.indexOf(s)?`${i}${t}${s}`:`${i}${t.replaceAll(s,s+i)}${s}`}}function o(r,t,e){return[Math.round(r[0]+e*(t[0]-r[0])),Math.round(r[1]+e*(t[1]-r[1])),Math.round(r[2]+e*(t[2]-r[2]))]}class i{constructor(){this.areColorsEnabled=r(),this.is8bitEnabled=t().is256,this.is24bitEnabled=t().isTrueColor,this.reset=e(0,0,"format"),this.bold=e(1,22,"format"),this.dim=e(2,22,"format"),this.italic=e(3,23,"format"),this.underline=e(4,24,"format"),this.blink=e(5,25,"format"),this.inverse=e(7,27,"format"),this.overline=e(53,55,"format"),this.hidden=e(8,28,"format"),this.strike=e(9,29,"format"),this.black=e(30,39,"color"),this.red=e(31,39,"color"),this.green=e(32,39,"color"),this.yellow=e(33,39,"color"),this.blue=e(34,39,"color"),this.magenta=e(35,39,"color"),this.cyan=e(36,39,"color"),this.white=e(37,39,"color"),this.blackBright=e(90,39,"color"),this.redBright=e(91,39,"color"),this.greenBright=e(92,39,"color"),this.yellowBright=e(93,39,"color"),this.blueBright=e(94,39,"color"),this.magentaBright=e(95,39,"color"),this.cyanBright=e(96,39,"color"),this.whiteBright=e(97,39,"color"),this.bgBlack=e(40,49,"color"),this.bgRed=e(41,49,"color"),this.bgGreen=e(42,49,"color"),this.bgYellow=e(43,49,"color"),this.bgBlue=e(44,49,"color"),this.bgMagenta=e(45,49,"color"),this.bgCyan=e(46,49,"color"),this.bgWhite=e(47,49,"color"),this.bgBlackBright=e(100,49,"color"),this.bgRedBright=e(101,49,"color"),this.bgGreenBright=e(102,49,"color"),this.bgYellowBright=e(103,49,"color"),this.bgBlueBright=e(104,49,"color"),this.bgMagentaBright=e(105,49,"color"),this.bgCyanBright=e(106,49,"color"),this.bgWhiteBright=e(107,49,"color")}static get init(){return new this.termarkInstance}ansi256(o,s){if(s<0||s>255)throw new Error(i.init.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 e("text"===o?`38;5;${s}`:`48;5;${s}`,"text"===o?39:49,"color")}rgb(r,...o){let s,n,l;if(Array.isArray(o[0])?(s=o[0][0],n=o[0][1],l=o[0][2]):(s=o[0],n=o[1],l=o[2]),"number"==typeof s&&(s<0||s>255)||"number"==typeof n&&(n<0||n>255)||"number"==typeof l&&(l<0||l>255))throw new Error(i.init.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 e("text"===r?`38;2;${s};${n};${l}`:`48;2;${s};${n};${l}`,"text"===r?39:49,"color")}gradient(e,i){if(!r()||!t().isTrueColor)return r=>r.toString();const s="text"===e?"[38;2;":"[48;2;",n="text"===e?"":"";return r=>{const t=r.toString().trim(),e=i.length,l=Math.min(t.length/(e-1));let g="";for(let r=0;r<t.length;r++){const h=Math.min(Math.floor(r/l),e-2),a=r%l/l,c=o(i[h],i[h+1],a);g+=`${s}${c[0]};${c[1]};${c[2]}m${t[r]}${n}`}return g}}success(r,t=""){console.info(`${t}${i.init.green(r)}`)}info(r,t=""){console.info(`${t}${i.init.blue(r)}`)}warn(r,t=""){console.warn(`${t}${i.init.yellow(r)}`)}error(r,t=""){console.error(`${t}${i.init.red(r)}`)}custom(r,t,o){return e(r,t,"asColor"===o?"color":"format")}}i.termarkInstance=i;const s=new i,{areColorsEnabled:n,is8bitEnabled:l,is24bitEnabled:g,reset:h,bold:a,dim:c,italic:b,underline:u,blink:p,inverse:x,overline:B,hidden:d,strike:m,black:f,red:w,green:$,yellow:y,blue:k,magenta:C,cyan:M,white:E,blackBright:v,redBright:R,greenBright:O,yellowBright:T,blueBright:G,magentaBright:S,cyanBright:W,whiteBright:Y,bgBlack:A,bgRed:_,bgGreen:I,bgYellow:L,bgBlue:j,bgMagenta:N,bgCyan:P,bgWhite:V,bgBlackBright:q,bgRedBright:z,bgGreenBright:D,bgYellowBright:F,bgBlueBright:H,bgMagentaBright:J,bgCyanBright:K,bgWhiteBright:Q,ansi256:U,rgb:X,gradient:Z,success:rr,info:tr,warn:er,error:or,custom:ir}=s;exports.Termark=i,exports.ansi256=U,exports.areColorsEnabled=n,exports.bgBlack=A,exports.bgBlackBright=q,exports.bgBlue=j,exports.bgBlueBright=H,exports.bgCyan=P,exports.bgCyanBright=K,exports.bgGreen=I,exports.bgGreenBright=D,exports.bgMagenta=N,exports.bgMagentaBright=J,exports.bgRed=_,exports.bgRedBright=z,exports.bgWhite=V,exports.bgWhiteBright=Q,exports.bgYellow=L,exports.bgYellowBright=F,exports.black=f,exports.blackBright=v,exports.blink=p,exports.blue=k,exports.blueBright=G,exports.bold=a,exports.custom=ir,exports.cyan=M,exports.cyanBright=W,exports.default=s,exports.dim=c,exports.error=or,exports.gradient=Z,exports.green=$,exports.greenBright=O,exports.hidden=d,exports.info=tr,exports.inverse=x,exports.is24bitEnabled=g,exports.is8bitEnabled=l,exports.italic=b,exports.magenta=C,exports.magentaBright=S,exports.overline=B,exports.red=w,exports.redBright=R,exports.reset=h,exports.rgb=X,exports.strike=m,exports.success=rr,exports.underline=u,exports.warn=er,exports.white=E,exports.whiteBright=Y,exports.yellow=y,exports.yellowBright=T;

package/dist/index.d.ts

@@ -1,83 +1,48 @@
 import { ANSIStyleType, RGB } from './util';
 /**
- * The `Termark` class enables accessing all features of Termark:
+ * The `Termark` class is almost the same as the {@linkcode termark} object and by using `Termark.init`, it effectively does become the same.
  *
- * - 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.
- * ```
+ * However, it is nonetheless useful as it enables type-safety,
  *
- * 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.
+ * You use this class the same way as you would the {@linkcode termark} object.
  *
  * @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';
+ * import { Termark } from 'termark';
  *
- * const termark = new Termark();
+ * const termark = new Termark(); // This is the same as if you'd import the `termark` object.
+ * termark.success('Termark is working!');
  *
- * termark.success('...');
- * termark.info('...');
- * termark.warn('...');
- * termark.error('...');
+ * // Alternatively, you could do:
+ * Termark.init.success('This works, too!');
  * ```
  *
- * This is because the above three methods handle console outputs for you. Therefore, they needn't
- * return a function where you specify your input.
+ * @see The {@linkcode termark} object.
  */
-export default class Termark {
+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. */
@@ -298,3 +263,76 @@ export default class Termark {
      */
     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/index.mjs

@@ -1 +1 @@
-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};
+const t=()=>!process.env.NO_COLOR,r=()=>{const t=process.env.COLORTERM;return{is16bit:!!t&&(t.includes("ansi")&&!t.includes("256")),is256:!!t&&t.includes("ansi256"),isTrueColor:!!t&&(t.includes("truecolor")||t.includes("24bit"))}};function e(r,e,i){if("color"===i&&!t())return t=>t.toString();const o=`[${r}m`,n=`[${e}m`;return t=>{const r=t.toString().trim();return-1===r.indexOf(n)?`${o}${r}${n}`:`${o}${r.replaceAll(n,n+o)}${n}`}}function i(t,r,e){return[Math.round(t[0]+e*(r[0]-t[0])),Math.round(t[1]+e*(r[1]-t[1])),Math.round(t[2]+e*(r[2]-t[2]))]}class o{constructor(){this.areColorsEnabled=t(),this.is8bitEnabled=r().is256,this.is24bitEnabled=r().isTrueColor,this.reset=e(0,0,"format"),this.bold=e(1,22,"format"),this.dim=e(2,22,"format"),this.italic=e(3,23,"format"),this.underline=e(4,24,"format"),this.blink=e(5,25,"format"),this.inverse=e(7,27,"format"),this.overline=e(53,55,"format"),this.hidden=e(8,28,"format"),this.strike=e(9,29,"format"),this.black=e(30,39,"color"),this.red=e(31,39,"color"),this.green=e(32,39,"color"),this.yellow=e(33,39,"color"),this.blue=e(34,39,"color"),this.magenta=e(35,39,"color"),this.cyan=e(36,39,"color"),this.white=e(37,39,"color"),this.blackBright=e(90,39,"color"),this.redBright=e(91,39,"color"),this.greenBright=e(92,39,"color"),this.yellowBright=e(93,39,"color"),this.blueBright=e(94,39,"color"),this.magentaBright=e(95,39,"color"),this.cyanBright=e(96,39,"color"),this.whiteBright=e(97,39,"color"),this.bgBlack=e(40,49,"color"),this.bgRed=e(41,49,"color"),this.bgGreen=e(42,49,"color"),this.bgYellow=e(43,49,"color"),this.bgBlue=e(44,49,"color"),this.bgMagenta=e(45,49,"color"),this.bgCyan=e(46,49,"color"),this.bgWhite=e(47,49,"color"),this.bgBlackBright=e(100,49,"color"),this.bgRedBright=e(101,49,"color"),this.bgGreenBright=e(102,49,"color"),this.bgYellowBright=e(103,49,"color"),this.bgBlueBright=e(104,49,"color"),this.bgMagentaBright=e(105,49,"color"),this.bgCyanBright=e(106,49,"color"),this.bgWhiteBright=e(107,49,"color")}static get init(){return new this.termarkInstance}ansi256(i,n){if(n<0||n>255)throw new Error(o.init.red("Value `color` is out of range! The value must be a number between 0 and 255!"));if(!r().is256||!t())return t=>t.toString();return e("text"===i?`38;5;${n}`:`48;5;${n}`,"text"===i?39:49,"color")}rgb(t,...i){let n,l,s;if(Array.isArray(i[0])?(n=i[0][0],l=i[0][1],s=i[0][2]):(n=i[0],l=i[1],s=i[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(o.init.red("One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!"));if(!r().isTrueColor)return t=>t.toString();return e("text"===t?`38;2;${n};${l};${s}`:`48;2;${n};${l};${s}`,"text"===t?39:49,"color")}gradient(e,o){if(!t()||!r().isTrueColor)return t=>t.toString();const n="text"===e?"[38;2;":"[48;2;",l="text"===e?"":"";return t=>{const r=t.toString().trim(),e=o.length,s=Math.min(r.length/(e-1));let h="";for(let t=0;t<r.length;t++){const g=Math.min(Math.floor(t/s),e-2),a=t%s/s,c=i(o[g],o[g+1],a);h+=`${n}${c[0]};${c[1]};${c[2]}m${r[t]}${l}`}return h}}success(t,r=""){console.info(`${r}${o.init.green(t)}`)}info(t,r=""){console.info(`${r}${o.init.blue(t)}`)}warn(t,r=""){console.warn(`${r}${o.init.yellow(t)}`)}error(t,r=""){console.error(`${r}${o.init.red(t)}`)}custom(t,r,i){return e(t,r,"asColor"===i?"color":"format")}}o.termarkInstance=o;const n=new o,{areColorsEnabled:l,is8bitEnabled:s,is24bitEnabled:h,reset:g,bold:a,dim:c,italic:b,underline:u,blink:d,inverse:B,overline:m,hidden:f,strike:$,black:w,red:y,green:k,yellow:C,blue:M,magenta:E,cyan:p,white:v,blackBright:x,redBright:O,greenBright:R,yellowBright:S,blueBright:T,magentaBright:G,cyanBright:W,whiteBright:Y,bgBlack:A,bgRed:I,bgGreen:L,bgYellow:N,bgBlue:V,bgMagenta:_,bgCyan:j,bgWhite:q,bgBlackBright:z,bgRedBright:D,bgGreenBright:F,bgYellowBright:H,bgBlueBright:J,bgMagentaBright:K,bgCyanBright:P,bgWhiteBright:Q,ansi256:U,rgb:X,gradient:Z,success:tt,info:rt,warn:et,error:it,custom:ot}=n;export{o as Termark,U as ansi256,l as areColorsEnabled,A as bgBlack,z as bgBlackBright,V as bgBlue,J as bgBlueBright,j as bgCyan,P as bgCyanBright,L as bgGreen,F as bgGreenBright,_ as bgMagenta,K as bgMagentaBright,I as bgRed,D as bgRedBright,q as bgWhite,Q as bgWhiteBright,N as bgYellow,H as bgYellowBright,w as black,x as blackBright,d as blink,M as blue,T as blueBright,a as bold,ot as custom,p as cyan,W as cyanBright,n as default,c as dim,it as error,Z as gradient,k as green,R as greenBright,f as hidden,rt as info,B as inverse,h as is24bitEnabled,s as is8bitEnabled,b as italic,E as magenta,G as magentaBright,m as overline,y as red,O as redBright,g as reset,X as rgb,$ as strike,tt as success,u as underline,et as warn,v as white,Y as whiteBright,C as yellow,S as yellowBright};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "termark",
-    "version": "1.1.0",
+    "version": "2.0.0",
     "main": "./dist/index.cjs",
     "module": "./dist/index.mjs",
     "exports": {