@maksims/colorizer.js 1.0.2

package/README.md

@@ -0,0 +1,70 @@
+# colorizer.js
+
+Small library for simple coloring and styling of terminal output with ANSI characters.
+
+## Documentation
+Its important that you should call `background` or `font` function before calling one of color functions like `hex` or `rgb` so that the library could create the correct order of ANSI characters. `hex` function takes over 24 bit value.
+
+First, import the library
+```js
+import colorizer from "colorizer.js";
+```
+
+This will work.
+```js
+console.log(
+  colorizer()
+    .bold()
+    .underline()
+    .font()
+    .rgb(255, 255, 0)
+    .text("WARN")
+);
+```
+This will work too.
+```js
+console.log(
+  colorizer()
+    .background()
+    .hex(0xff_ff_ff)
+    //     R  G  B 
+    .bold()
+    .underline()
+    .text("WARN")
+);
+```
+This will not work.
+```js
+console.log(
+  colorizer()
+    // On whom should this color be applied??
+    .hex(0xff_ff_ff)
+    .bold()
+    .underline()
+    .text("WARN")
+);
+```
+This will not work too.
+```js
+console.log(
+  colorizer()
+    // Incorrect sequence of ANSI characters! 
+    .font()
+    .bold() // <- Either move it before applying colors or after.
+    .hex(0xff_ff_ff)
+    .underline()
+    .text("WARN")
+);
+```
+You can create a reusable coloring function.
+```js
+import colorizer from "colorizer.ts";
+
+const warn = colorizer()
+  .bold()
+  .font()
+  .rgb(255, 255, 0)
+  .text;
+
+console.log(warn("[WARN]:"), "Some warning!");
+```

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@maksims/colorizer.js",
+  "version": "1.0.2",
+  "description": "Small library for simple coloring and styling of terminal output with ANSI charcters.",
+  "homepage": "https://github.com/MaksimsTurs/colorizer.js#readme",
+  "license": "ISC",
+  "author": "MaksimsTurs",
+  "type": "module",
+  "main": "./src/colorizer.ts",
+  "bugs": {
+    "url": "https://github.com/MaksimsTurs/colorizer.js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MaksimsTurs/colorizer.js.git"
+  }
+}

package/src/colorizer.ts

@@ -0,0 +1,97 @@
+import STYLES from "./const/STYLES.const.ts";
+
+import type { Colorizer } from "./colorizer.type.ts";
+
+import isFillContextValid from "./utils/is-fill-context-valid.util.ts";
+
+const _warn: Colorizer["text"] = colorizer()
+  .bold()
+  .font()
+  .rgb(170, 170, 0)
+  .text;
+const _text: Colorizer["text"] = colorizer()
+  .transparent()
+  .font()
+  .rgb(255, 255, 255)
+  .text;
+
+export default function colorizer(): Colorizer {
+  let styles: string[] = [];
+
+  return {
+    // Font styles.
+    strikeThrought: function(): Colorizer {
+      styles.push(STYLES.STRIKE_THROUGHT);
+
+      return this;
+    },
+    underline: function(): Colorizer {
+      styles.push(STYLES.UNDERLINE);
+
+      return this;
+    },
+    transparent: function(): Colorizer {
+      styles.push(STYLES.TRANSPARENT);
+
+      return this;
+    },
+    italic: function(): Colorizer {
+      styles.push(STYLES.ITALIC);
+
+      return this;
+    },
+    bold: function(): Colorizer {
+      styles.push(STYLES.BOLD);
+
+      return this;
+    },
+    // Fill contexts.
+    font: function(): Colorizer {
+      styles.push(STYLES.BG);
+
+      return this;
+    },
+    background: function(): Colorizer {
+      styles.push(STYLES.FG);
+
+      return this;
+    },
+    // Font Colors.
+    hex: function(hex: number): Colorizer {
+      const r: number = hex >> 16 & 0xff;
+      const g: number = hex >> 8  & 0xff;
+      const b: number = hex >> 0  & 0xff;
+
+      if(!isFillContextValid(styles.at(-1))) {
+        console.warn(_warn("[WARN]:"), _text(`The hex color does not have effect because the fill location "${styles.at(-1)}" is not valid!`));
+        console.warn(_warn("[WARN]:"), _text("Call the \"fg\" function for background color or \"bg\" for font color!"));
+      }
+
+      styles.push(`${r};${g};${b}m`);
+
+      return this;
+    },
+    rgb: function(r: number, g: number, b: number): Colorizer {
+      if(!isFillContextValid(styles.at(-1))) {
+        console.warn(_warn("[WARN]:"), _text(`The rgb color does not have effect because the fill location "${styles.at(-1)}" is not valid!`));
+        console.warn(_warn("[WARN]:"), _text("Call the \"fg\" function for background color or \"bg\" for font color!"));
+      }
+
+      styles.push(`${r};${g};${b}m`);
+
+      return this;
+    },
+    text: function(text: string): string {
+      let colorized: string = "";
+
+      for(let index: number = 0; index < styles.length; index++) {
+        colorized += styles[index];
+      }
+
+      colorized += text;
+      colorized += STYLES.RESET;
+      
+      return colorized;
+    },
+  }
+};

package/src/colorizer.type.ts

@@ -0,0 +1,17 @@
+export type Colorizer = {
+  strikeThrought: () => Colorizer
+  underline:      () => Colorizer
+  /** Reduce the intensity of backround and font colors. */
+  transparent:    () => Colorizer
+  italic:         () => Colorizer
+  bold:           () => Colorizer
+  /** Set the font color. */
+  font:           () => Colorizer
+  /** Set the background color. */
+  background:     () => Colorizer
+  /** Should be 24 bit value. */
+  hex:            (hex: number) => Colorizer
+  rgb:            (r: number, g: number, b: number) => Colorizer
+  /** Apply a set of rules to the given text.*/
+  text:           (text: string) => string;
+};

package/src/const/STYLES.const.ts

@@ -0,0 +1,13 @@
+const STYLES = {
+  RESET:           "\x1b[0m",
+  BOLD:            "\x1b[1m",
+  TRANSPARENT:     "\x1b[2m",
+  ITALIC:          "\x1b[3m",
+  UNDERLINE:       "\x1b[4m",
+  STRIKE_THROUGHT: "\x1b[9m",
+  
+  BG:        "\x1b[38;2;",
+  FG:        "\x1b[48;2;",
+} as const;
+
+export default STYLES;

package/src/utils/is-fill-context-valid.util.ts

@@ -0,0 +1,9 @@
+import STYLES from "../const/STYLES.const.ts";
+
+export default function isFillContextValid(something?: string): boolean {
+  return(
+    !!(something &&
+      (something === STYLES.BG ||
+       something === STYLES.FG))
+  );
+};