termark 1.1.0 → 2.1.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](#default--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,8 @@ 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)
+- [Custom themes & loggers](#custom-themes-and-loggers)
 
 ## Installation
 
@@ -28,13 +31,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';
+
+termark.info('This is the default import, where all properties and methods are accessible.');
 
-// for both, you'd then likely do this for convenience:
-const termark = new Termark();
+// Named imports:
+import { success, inverse } from 'termark';
+
+success(
+    inverse('This text with a green background is achieved with named imports!')
+)
 ```
 
 ## Usage
@@ -42,9 +60,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 +78,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 +95,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 +133,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 +142,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 +161,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 +190,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 +202,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 +214,82 @@ 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.
+
+### Custom themes and loggers
+
+You can create custom themes (a collection of multiple styles) and loggers:
+
+```ts
+import termark, { Termark } from 'termark';
+
+const myTheme = Termark.createTheme(
+    termark.blue, // <- Notice that we specify a built-in function *without calling it*!
+    termark.bold // Same goes for this one.
+);
+
+console.log(
+    myTheme('This text is bold and blue!')
+);
+
+// ------
+
+// All properties but `default` are completely optional.
+// If omitted, default ones are used
+const myLogger = Termark.createLogger({
+    default: [
+        termark.cyan,
+        termark.italic
+    ],
+    success: {
+        prefix: false, // Disable built-in prefix
+        styles: [
+            termark.greenBright,
+            termark.bold
+        ]
+    },
+    info: {
+        prefix: 'Info' // Custom prefix to override the default
+        // No custom styles--use default ones.
+    },
+    // leave `warn` as-is
+    error: {
+        // Use default prefix; omitting or setting to an empty string have the same result.
+        styles: [
+            termark.bgRedBright,
+            termark.dim
+        ]
+    },
+});
+
+myLogger.log('...'); // Uses the `default` property's options.
+myLogger.success('...'); // Omitted prefix, uses custom styles.
+myLogger.info('...'); // Uses custom prefix, default styles.
+myLogger.warn('...'); // Left as-is.
+myLogger.error('...'); // Uses default prefix, with custom styles.
+```
+
 ## 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 e=()=>!process.env.NO_COLOR,r=()=>{const e=process.env.COLORTERM;return{is16bit:!!e&&(e.includes("ansi")&&!e.includes("256")),is256:!!e&&e.includes("ansi256"),isTrueColor:!!e&&(e.includes("truecolor")||e.includes("24bit"))}};function t(r,t,i){if("color"===i&&!e())return e=>e.toString();const o=`[${r}m`,s=`[${t}m`;return e=>{const r=e.toString().trim();return-1===r.indexOf(s)?`${o}${r}${s}`:`${o}${r.replaceAll(s,s+o)}${s}`}}function i(e,r,t){return[Math.round(e[0]+t*(r[0]-e[0])),Math.round(e[1]+t*(r[1]-e[1])),Math.round(e[2]+t*(r[2]-e[2]))]}function o(e,r,t){if("number"!=typeof e)throw new TypeError(`Parameter ${JSON.stringify(e)} must be a finite number, which it currently isn't!`);return Math.min(Math.max(e,r),t)}class s{constructor(){this.areColorsEnabled=e(),this.is8bitEnabled=r().is256,this.is24bitEnabled=r().isTrueColor,this.reset=t(0,0,"format"),this.bold=t(1,22,"format"),this.dim=t(2,22,"format"),this.italic=t(3,23,"format"),this.underline=t(4,24,"format"),this.blink=t(5,25,"format"),this.inverse=t(7,27,"format"),this.overline=t(53,55,"format"),this.hidden=t(8,28,"format"),this.strike=t(9,29,"format"),this.black=t(30,39,"color"),this.red=t(31,39,"color"),this.green=t(32,39,"color"),this.yellow=t(33,39,"color"),this.blue=t(34,39,"color"),this.magenta=t(35,39,"color"),this.cyan=t(36,39,"color"),this.white=t(37,39,"color"),this.blackBright=t(90,39,"color"),this.redBright=t(91,39,"color"),this.greenBright=t(92,39,"color"),this.yellowBright=t(93,39,"color"),this.blueBright=t(94,39,"color"),this.magentaBright=t(95,39,"color"),this.cyanBright=t(96,39,"color"),this.whiteBright=t(97,39,"color"),this.bgBlack=t(40,49,"color"),this.bgRed=t(41,49,"color"),this.bgGreen=t(42,49,"color"),this.bgYellow=t(43,49,"color"),this.bgBlue=t(44,49,"color"),this.bgMagenta=t(45,49,"color"),this.bgCyan=t(46,49,"color"),this.bgWhite=t(47,49,"color"),this.bgBlackBright=t(100,49,"color"),this.bgRedBright=t(101,49,"color"),this.bgGreenBright=t(102,49,"color"),this.bgYellowBright=t(103,49,"color"),this.bgBlueBright=t(104,49,"color"),this.bgMagentaBright=t(105,49,"color"),this.bgCyanBright=t(106,49,"color"),this.bgWhiteBright=t(107,49,"color")}static get init(){return new this.termarkInstance}ansi256(i,s){if(!r().is256||!e())return e=>e.toString();s=o(s,0,255);return t("text"===i?`38;5;${s}`:`48;5;${s}`,"text"===i?39:49,"color")}rgb(e,...i){if(!r().isTrueColor)return e=>e.toString();let s,n,l;Array.isArray(i[0])?(s=o(i[0][0],0,255),n=o(i[0][1],0,255),l=o(i[0][2],0,255)):(s=o(i[0],0,255),n=o(i[1],0,255),l=o(i[2],0,255));return t("text"===e?`38;2;${s};${n};${l}`:`48;2;${s};${n};${l}`,"text"===e?39:49,"color")}gradient(t,o){if(!e()||!r().isTrueColor)return e=>e.toString();const s="text"===t?"[38;2;":"[48;2;",n="text"===t?"":"";return e=>{const r=e.toString().trim(),t=o.length,l=Math.min(r.length/(t-1));let g="";for(let e=0;e<r.length;e++){const c=Math.min(Math.floor(e/l),t-2),a=e%l/l,h=i(o[c],o[c+1],a);g+=`${s}${h[0]};${h[1]};${h[2]}m${r[e]}${n}`}return g}}success(e,r=""){console.info(`${s.successPrefix} ${r}${s.init.green(e)}`)}info(e,r=""){console.info(`${s.infoPrefix} ${r}${s.init.blue(e)}`)}warn(e,r=""){console.warn(`${s.warnPrefix} ${r}${s.init.yellow(e)}`)}error(e,r=""){console.error(`${s.errorPrefix} ${r}${s.init.red(e)}`)}custom(e,r,i){return t(e,r,"asColor"===i?"color":"format")}static createTheme(...e){const r=[];return e.forEach(e=>r.push(e)),e=>{const t=e.toString();return r.reduce((e,r)=>r(e),t)}}static createLogger(e){var r,t,i,o,n,l,g,c;const a=void 0===(null===(r=e.success)||void 0===r?void 0:r.prefix)||""===e.success.prefix?s.successPrefix:!1===e.success.prefix?"":e.success.prefix,h=void 0===(null===(t=e.info)||void 0===t?void 0:t.prefix)||""===e.info.prefix?s.infoPrefix:!1===e.info.prefix?"":e.info.prefix,b=void 0===(null===(i=e.warn)||void 0===i?void 0:i.prefix)||""===e.warn.prefix?s.warnPrefix:!1===e.warn.prefix?"":e.warn.prefix,x=void 0===(null===(o=e.error)||void 0===o?void 0:o.prefix)||""===e.error.prefix?s.errorPrefix:!1===e.error.prefix?"":e.error.prefix,u=s.createTheme(...e.default),d=s.createTheme(...void 0!==(null===(n=e.success)||void 0===n?void 0:n.styles)&&0!==e.success.styles.length?e.success.styles:[s.init.green]),p=s.createTheme(...void 0!==(null===(l=e.info)||void 0===l?void 0:l.styles)&&0!==e.info.styles.length?e.info.styles:[s.init.blue]),f=s.createTheme(...void 0!==(null===(g=e.warn)||void 0===g?void 0:g.styles)&&0!==e.warn.styles.length?e.warn.styles:[s.init.yellow]),B=s.createTheme(...void 0!==(null===(c=e.error)||void 0===c?void 0:c.styles)&&0!==e.error.styles.length?e.error.styles:[s.init.red]);return{log(e,r=""){console.log(`${r}${u(e)}`)},success(e,r=""){console.info(`${a?a+" ":""}${r}${d(e)}`)},info(e,r=""){console.info(`${h?h+" ":""}${r}${p(e)}`)},warn(e,r=""){console.info(`${b?b+" ":""}${r}${f(e)}`)},error(e,r=""){console.info(`${x?x+" ":""}${r}${B(e)}`)}}}}s.termarkInstance=s,s.successPrefix=s.init.green(s.init.bold("[✓]")),s.infoPrefix=s.init.blue(s.init.bold("[i]")),s.warnPrefix=s.init.yellow(s.init.bold("[!]")),s.errorPrefix=s.init.red(s.init.bold("[X]"));const n=s.init,{areColorsEnabled:l,is8bitEnabled:g,is24bitEnabled:c,reset:a,bold:h,dim:b,italic:x,underline:u,blink:d,inverse:p,overline:f,hidden:B,strike:m,black:$,red:w,green:y,yellow:v,blue:k,magenta:C,cyan:M,white:T,blackBright:P,redBright:E,greenBright:R,yellowBright:O,blueBright:S,magentaBright:G,cyanBright:W,whiteBright:Y,bgBlack:L,bgRed:A,bgGreen:_,bgYellow:I,bgBlue:N,bgMagenta:j,bgCyan:J,bgWhite:X,bgBlackBright:q,bgRedBright:z,bgGreenBright:D,bgYellowBright:F,bgBlueBright:H,bgMagentaBright:K,bgCyanBright:Q,bgWhiteBright:U,ansi256:V,rgb:Z,gradient:ee,success:re,info:te,warn:ie,error:oe,custom:se}=n,{createTheme:ne,createLogger:le}=s;exports.Termark=s,exports.ansi256=V,exports.areColorsEnabled=l,exports.bgBlack=L,exports.bgBlackBright=q,exports.bgBlue=N,exports.bgBlueBright=H,exports.bgCyan=J,exports.bgCyanBright=Q,exports.bgGreen=_,exports.bgGreenBright=D,exports.bgMagenta=j,exports.bgMagentaBright=K,exports.bgRed=A,exports.bgRedBright=z,exports.bgWhite=X,exports.bgWhiteBright=U,exports.bgYellow=I,exports.bgYellowBright=F,exports.black=$,exports.blackBright=P,exports.blink=d,exports.blue=k,exports.blueBright=S,exports.bold=h,exports.createLogger=le,exports.createTheme=ne,exports.custom=se,exports.cyan=M,exports.cyanBright=W,exports.default=n,exports.dim=b,exports.error=oe,exports.gradient=ee,exports.green=y,exports.greenBright=R,exports.hidden=B,exports.info=te,exports.inverse=p,exports.is24bitEnabled=c,exports.is8bitEnabled=g,exports.italic=x,exports.magenta=C,exports.magentaBright=G,exports.overline=f,exports.red=w,exports.redBright=E,exports.reset=a,exports.rgb=Z,exports.strike=m,exports.success=re,exports.underline=u,exports.warn=ie,exports.white=T,exports.whiteBright=Y,exports.yellow=v,exports.yellowBright=O;

package/dist/index.d.ts

@@ -1,83 +1,52 @@
-import { ANSIStyleType, RGB } from './util';
+import { ANSIStyleType, RGB, FormatFunction, LoggerOptions, LogObject } 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.
+ * However, it is nonetheless useful as it enables type-safety,
  *
- * ---
- *
- * With methods on the other hand, you *do* perform commands and operations.
- * Methods are dynamic, meaning that you *do* specify how they work.
+ * You use this class the same way as you would the {@linkcode termark} object.
  *
  * @example
  * ```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.red('...'); // Returns "..." in red.
- * termark.rgb('background', [255, 255, 255])('...'); // Returns "..." with a white background.
+ * // Alternatively, you could do:
+ * Termark.init.success('This works, too!');
  * ```
  *
- * 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.
+ * @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;
+    private static successPrefix;
+    private static infoPrefix;
+    private static warnPrefix;
+    private static errorPrefix;
     /** Check whether terminal colours are enabled. */
     areColorsEnabled: boolean;
     /** Check whether 8-bit colours are enabled. */
@@ -85,89 +54,89 @@ export default class Termark {
     /** Check whether 24-bit colours are enabled. */
     is24bitEnabled: boolean;
     /** Reset all styles. */
-    reset: (input: string | TemplateStringsArray) => string;
+    reset: FormatFunction;
     /** Make some text bold. */
-    bold: (input: string | TemplateStringsArray) => string;
+    bold: FormatFunction;
     /** Make some text thin. */
-    dim: (input: string | TemplateStringsArray) => string;
+    dim: FormatFunction;
     /** Make some text italic. May not be widely supported. */
-    italic: (input: string | TemplateStringsArray) => string;
+    italic: FormatFunction;
     /** Underline some text. */
-    underline: (input: string | TemplateStringsArray) => string;
-    /** Make some text blink slowly. */
-    blink: (input: string | TemplateStringsArray) => string;
+    underline: FormatFunction;
+    /** Make some text blink slowly. May not be widely supported/may not work everywhere. */
+    blink: FormatFunction;
     /** Invert some text (foreground colour becomes background colour, background colour becomes foreground colour). */
-    inverse: (input: string | TemplateStringsArray) => string;
+    inverse: FormatFunction;
     /** Add a line above some text. May not be widely supported. */
-    overline: (input: string | TemplateStringsArray) => string;
+    overline: FormatFunction;
     /** Visually hide some text. */
-    hidden: (input: string | TemplateStringsArray) => string;
+    hidden: FormatFunction;
     /** Add a line through (strike) some text. */
-    strike: (input: string | TemplateStringsArray) => string;
+    strike: FormatFunction;
     /** Colour some text black. */
-    black: (input: string | TemplateStringsArray) => string;
+    black: FormatFunction;
     /** Colour some text red. */
-    red: (input: string | TemplateStringsArray) => string;
+    red: FormatFunction;
     /** Colour some text green. */
-    green: (input: string | TemplateStringsArray) => string;
+    green: FormatFunction;
     /** Colour some text yellow. */
-    yellow: (input: string | TemplateStringsArray) => string;
+    yellow: FormatFunction;
     /** Colour some text blue. */
-    blue: (input: string | TemplateStringsArray) => string;
+    blue: FormatFunction;
     /** Colour some text magenta. */
-    magenta: (input: string | TemplateStringsArray) => string;
+    magenta: FormatFunction;
     /** Colour some text cyan. */
-    cyan: (input: string | TemplateStringsArray) => string;
+    cyan: FormatFunction;
     /** Colour some text white. */
-    white: (input: string | TemplateStringsArray) => string;
+    white: FormatFunction;
     /** Colour some text bright black (grey). */
-    blackBright: (input: string | TemplateStringsArray) => string;
+    blackBright: FormatFunction;
     /** Colour some text bright red. */
-    redBright: (input: string | TemplateStringsArray) => string;
+    redBright: FormatFunction;
     /** Colour some text bright green. */
-    greenBright: (input: string | TemplateStringsArray) => string;
+    greenBright: FormatFunction;
     /** Colour some text bright yellow. */
-    yellowBright: (input: string | TemplateStringsArray) => string;
+    yellowBright: FormatFunction;
     /** Colour some text bright blue. */
-    blueBright: (input: string | TemplateStringsArray) => string;
+    blueBright: FormatFunction;
     /** Colour some text bright magenta. */
-    magentaBright: (input: string | TemplateStringsArray) => string;
+    magentaBright: FormatFunction;
     /** Colour some text bright cyan. */
-    cyanBright: (input: string | TemplateStringsArray) => string;
+    cyanBright: FormatFunction;
     /** Colour some text bright white. */
-    whiteBright: (input: string | TemplateStringsArray) => string;
+    whiteBright: FormatFunction;
     /** Colour the background of some text black. */
-    bgBlack: (input: string | TemplateStringsArray) => string;
+    bgBlack: FormatFunction;
     /** Colour the background of some text red. */
-    bgRed: (input: string | TemplateStringsArray) => string;
+    bgRed: FormatFunction;
     /** Colour the background of some text green. */
-    bgGreen: (input: string | TemplateStringsArray) => string;
+    bgGreen: FormatFunction;
     /** Colour the background of some text yellow. */
-    bgYellow: (input: string | TemplateStringsArray) => string;
+    bgYellow: FormatFunction;
     /** Colour the background of some text blue. */
-    bgBlue: (input: string | TemplateStringsArray) => string;
+    bgBlue: FormatFunction;
     /** Colour the background of some text magenta. */
-    bgMagenta: (input: string | TemplateStringsArray) => string;
+    bgMagenta: FormatFunction;
     /** Colour the background of some text cyan. */
-    bgCyan: (input: string | TemplateStringsArray) => string;
+    bgCyan: FormatFunction;
     /** Colour the background of some text white. */
-    bgWhite: (input: string | TemplateStringsArray) => string;
+    bgWhite: FormatFunction;
     /** Colour the background of some text bright black (grey). */
-    bgBlackBright: (input: string | TemplateStringsArray) => string;
+    bgBlackBright: FormatFunction;
     /** Colour the background of some text bright red. */
-    bgRedBright: (input: string | TemplateStringsArray) => string;
+    bgRedBright: FormatFunction;
     /** Colour the background of some text bright green. */
-    bgGreenBright: (input: string | TemplateStringsArray) => string;
+    bgGreenBright: FormatFunction;
     /** Colour the background of some text bright yellow. */
-    bgYellowBright: (input: string | TemplateStringsArray) => string;
+    bgYellowBright: FormatFunction;
     /** Colour the background of some text bright blue. */
-    bgBlueBright: (input: string | TemplateStringsArray) => string;
+    bgBlueBright: FormatFunction;
     /** Colour the background of some text bright magenta. */
-    bgMagentaBright: (input: string | TemplateStringsArray) => string;
+    bgMagentaBright: FormatFunction;
     /** Colour the background of some text bright cyan. */
-    bgCyanBright: (input: string | TemplateStringsArray) => string;
+    bgCyanBright: FormatFunction;
     /** Colour the background of some text bright white. */
-    bgWhiteBright: (input: string | TemplateStringsArray) => string;
+    bgWhiteBright: FormatFunction;
     /**
      * 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.
@@ -178,7 +147,7 @@ export default class 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: ANSIStyleType, color: number): (input: string | TemplateStringsArray) => string;
+    ansi256(type: ANSIStyleType, color: number): FormatFunction;
     /**
      * Make some text or its background using custom RGB values.
      *
@@ -194,7 +163,7 @@ export default class Termark {
      * termark.rgb('text', [85, 222, 124])('...');
      * ```
      */
-    rgb(type: ANSIStyleType, ...rgb: RGB | [RGB]): (input: string | TemplateStringsArray) => string;
+    rgb(type: ANSIStyleType, ...rgb: RGB | [RGB]): FormatFunction;
     /**
      * Apply a gradient to some text or its background.
      *
@@ -211,7 +180,7 @@ export default class Termark {
      * termark.gradient('background', [[222, 111, 0], [93, 255, 68], [0, 224, 110]])('...');
      * ```
      */
-    gradient(type: ANSIStyleType, colors: RGB[]): (input: string | TemplateStringsArray) => string;
+    gradient(type: ANSIStyleType, colors: RGB[]): FormatFunction;
     /**
      * Logs a `message` to the console on the `info` level.
      *
@@ -228,7 +197,7 @@ export default class Termark {
      * termark.success('...'); // Logs "..." in green as a success (info).
      * ```
      */
-    success(message: string, prefix?: string): void;
+    success(message: string | TemplateStringsArray, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `info` level.
      *
@@ -242,7 +211,7 @@ export default class Termark {
      * termark.info('...'); // Logs "..." in blue as an info.
      * ```
      */
-    info(message: string, prefix?: string): void;
+    info(message: string | TemplateStringsArray, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `error` level.
      *
@@ -260,7 +229,7 @@ export default class Termark {
      * termark.warn('...'); // Logs "..." in yellow as a warning (error).
      * ```
      */
-    warn(message: string, prefix?: string): void;
+    warn(message: string | TemplateStringsArray, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `error` level.
      *
@@ -274,7 +243,7 @@ export default class Termark {
      * termark.error('...'); // Logs "..." in red as an error.
      * ```
      */
-    error(message: string, prefix?: string): void;
+    error(message: string | TemplateStringsArray, prefix?: string): void;
     /**
      * Style some text using entirely custom settings.
      *
@@ -286,7 +255,7 @@ export default class Termark {
      *
      * @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.
+     * @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
@@ -296,5 +265,119 @@ export default class 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;
+    custom(opener: string | number, closer: string | number, type: 'asColor' | 'asFormat'): FormatFunction;
+    /**
+     * Create a theme (multiple stylings grouped together).
+     *
+     * This creates a function you can call to style some desired string using the stylings
+     * you specified.
+     *
+     * @example
+     * ```ts
+     * import termark, { Termark } from 'termark';
+     *
+     * const myTheme = Termark.createTheme(
+     *      termark.bold,
+     *      termark.blue,
+     *      termark.bgGreen
+     * );
+     *
+     * console.log(
+     *      myTheme('...') // message will be bold with a green background and blue text
+     * );
+     * ```
+     *
+     * @param styles Stylings to apply.
+     * @returns A function to style some desired text using the specified styles.
+     */
+    static createTheme(...styles: FormatFunction[]): FormatFunction;
+    /**
+     * Define a custom logger.
+     *
+     * Using the `options` object, you can specify the styling that is applied to each method. For example, you can customize
+     * how a message logged using `error()` looks.
+     *
+     * For `success()`, `info()`, `warn()`, and `error()`, you can also customize the prefix.
+     *
+     * The resulting methods are exactly like the predefined ones, apart from the custom styling. That means that each method also
+     * takes an optional `prefix` argument for branding purposes.
+     *
+     * @param options An object to customize the logger.
+     * @returns An object with methods to log various messages to the terminal with various (semantic) styling.
+     */
+    static createLogger(options: LoggerOptions): LogObject;
 }
+/**
+ * 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: FormatFunction, bold: FormatFunction, dim: FormatFunction, italic: FormatFunction, underline: FormatFunction, blink: FormatFunction, inverse: FormatFunction, overline: FormatFunction, hidden: FormatFunction, strike: FormatFunction, black: FormatFunction, red: FormatFunction, green: FormatFunction, yellow: FormatFunction, blue: FormatFunction, magenta: FormatFunction, cyan: FormatFunction, white: FormatFunction, blackBright: FormatFunction, redBright: FormatFunction, greenBright: FormatFunction, yellowBright: FormatFunction, blueBright: FormatFunction, magentaBright: FormatFunction, cyanBright: FormatFunction, whiteBright: FormatFunction, bgBlack: FormatFunction, bgRed: FormatFunction, bgGreen: FormatFunction, bgYellow: FormatFunction, bgBlue: FormatFunction, bgMagenta: FormatFunction, bgCyan: FormatFunction, bgWhite: FormatFunction, bgBlackBright: FormatFunction, bgRedBright: FormatFunction, bgGreenBright: FormatFunction, bgYellowBright: FormatFunction, bgBlueBright: FormatFunction, bgMagentaBright: FormatFunction, bgCyanBright: FormatFunction, bgWhiteBright: FormatFunction, ansi256: (type: ANSIStyleType, color: number) => FormatFunction, rgb: (type: ANSIStyleType, ...rgb: RGB | [RGB]) => FormatFunction, gradient: (type: ANSIStyleType, colors: RGB[]) => FormatFunction, success: (message: string | TemplateStringsArray, prefix?: string) => void, info: (message: string | TemplateStringsArray, prefix?: string) => void, warn: (message: string | TemplateStringsArray, prefix?: string) => void, error: (message: string | TemplateStringsArray, prefix?: string) => void, custom: (opener: string | number, closer: string | number, type: "asColor" | "asFormat") => FormatFunction;
+export declare const createTheme: typeof Termark.createTheme, createLogger: typeof Termark.createLogger;

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

package/dist/util.d.ts

@@ -49,3 +49,109 @@ export declare function format(open: number | string, close: number | string, ty
  * @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;
+/**
+ * From [`JSAux`](https://codeberg.org/Genesis_Software/js-aux).
+ */
+export declare function clamp(value: number, min: number, max: number): number;
+export type FormatFunctionReturn = string | TemplateStringsArray;
+export type FormatFunction = (input: FormatFunctionReturn) => string;
+/**
+ * The object returned by the `createLogger()` method of the `Termark` class.
+ */
+export type LogObject = {
+    /**
+     * A generic logging function.
+     *
+     * @param message Th message string.
+     * @param prefix An optional prefix for branding purposes.
+     */
+    log(message: string, prefix?: string): void;
+    /**
+     * A success logging function. Prints to the same level as `log()`.
+     *
+     * @param message Th message string.
+     * @param prefix An optional prefix for branding purposes.
+     */
+    success(message: string, prefix?: string): void;
+    /**
+     * An info logging function. Prints to the same level as `log()`.
+     *
+     * @param message Th message string.
+     * @param prefix An optional prefix for branding purposes.
+     */
+    info(message: string, prefix?: string): void;
+    /**
+     * A warning logging function. Prints to the same level as `error()`.
+     *
+     * @param message Th message string.
+     * @param prefix An optional prefix for branding purposes.
+     */
+    warn(message: string, prefix?: string): void;
+    /**
+     * An error logging function.
+     *
+     * @param message Th message string.
+     * @param prefix An optional prefix for branding purposes.
+     */
+    error(message: string, prefix?: string): void;
+};
+/**
+ * Options for the logging methods that aren't `log()` of a custom logger.
+ */
+export interface LoggerLogOptions {
+    /**
+     * Customize the prefix of a certain "level" or "type" of log (e.g., `error`).
+     *
+     * This is only for semantics.
+     *
+     * If left empty, the default prefix is used. If set to `false`, it will be omitted.
+     *
+     * The following are the default prefixes:
+     *
+     * - `success()`: `[✔]`
+     * - `info()`: `[i]`,
+     * - `warn()`: `[!]`,
+     * - `error()`: `[X]`
+     */
+    prefix: string | false;
+    /**
+     * An array of styles to apply.
+     *
+     * @example [termark.blue, termark.bold]
+     */
+    styles: FormatFunction[];
+}
+/**
+ * Options to customize a custom logger.
+ */
+export interface LoggerOptions {
+    /**
+     * The default styling.
+     *
+     * This is what gets applied to the message string when the `log()` method is called.
+     */
+    default: FormatFunction[];
+    /**
+     * Styling to apply when the `success()` method is called.
+     *
+     * Keep in mind that this is only for visuals; there is no "success" log level
+     * in Node. Therefore, this prints to the same level as `log()` and `info()`.
+     */
+    success?: LoggerLogOptions;
+    /**
+     * Styling to apply when the `info()` method is called.
+     *
+     * This prints to the same level as `log()` and `success()`.
+     */
+    info?: LoggerLogOptions;
+    /**
+     * Styling to apply when the `warn()` method is called.
+     *
+     * This prints to the same level as `error()`.
+     */
+    warn?: LoggerLogOptions;
+    /**
+     * Styling to apply when the `error()` method is called.`
+     */
+    error?: LoggerLogOptions;
+}

package/package.json

@@ -1,39 +1,39 @@
 {
-    "name": "termark",
-    "version": "1.1.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": "2.1.0",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     }
-}
+  },
+  "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"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "test": "node dist/index.mjs"
+  }
+}