2.1.1 • Published 8 months ago

chalk-with-markers v2.1.1

Weekly downloads
7
License
MIT
Repository
github
Last release
8 months ago

Chalk with Markers -- for the 💖 of 💄 ASCII art 🤙

I. Love. ASCII. Art. Seriously I can't make a NodeJS CLI or Chatbot without adding a decent splash-screen to it. That's why I love Chalk. But creating those strings got a little too verbose, that's why I created this lib.

Note: we've upgraded to ESM, as Chalk is also in ESM.

import { asciiArtChalker } from "chalk-with-markers";

console.log(asciiArtChalker.colorize(`

b   ______g__  __y____o__    r__ __
b  / ____/g / / /y  _/o /   r/ //_/
b / /   g/ /_/ /y/ /o/ /   r/ ,<   
b/ /___g/ __  /y/ /o/ /___r/ /| |  
b\\____/g_/ /_/y___/o_____/r_/ |_|  

`));

Note: I use the TAAG by patorjk to generate the art.

This lib should just:

  • be light weight & extendable
  • provide readable, non-verbose markers

Text highlight

If you want to highlight text, we use the default chalker like this:

import { chalker } from "chalk-with-markers";

console.log("Results:");
console.log(chalker.colorize("- Checked status for [y]KeesTalksTech[/], website is [g]online[/]."));
console.log(chalker.colorize("- Checked status for [y]Recipes[/], website is [r]offline[/]."));

It produces:

Default color markings

We have the following:

colorHTML nameHEXchalker markerasciiArtChalker markernotes
#FF0000redFF0000[r]r
#00FF00lime00FF00[g]g
#0080FFlight blue0080FF[b]b
#FFFF00yellowFFFF00[y]y
#FF00FFmagentaFF00FF[m]m
#00FFFFcyan00FFFF[c]c
#FFA500orangeFFA500[o]o
#FFFFFFlight violetFFFFFF[p]p
#FFFFFFwhiteFFFFFF[w]w
#000000black000000[k]k
[q] or [/]qresets chalk

Own mappings

Can I make my own markers? Yes, you can!

import { Chalker } from "chalk-with-markers";
import chalk from "chalk";

const x = new Chalker();
x.set("[r]", chalk.bgRed.black);
x.set("[w]", chalk.bgWhite.black);
x.set("[b]", chalk.bgBlue.black);
x.set("[/]", chalk.reset);

console.log(x.colorize(`
[r] X X X X 
[w]  X X X  
[b] X X X X 
[/]         `));

It produces:

Extend

Can I extend the mappings? Yes you can!

import { asciiArtChalker } from "chalk-with-markers";
import chalk from "chalk";

// global extend:
asciiArtChalker.set("p", chalk.hex("#FFC0CB")); // add HTML pink

// or clone to use extend locally:
const x = asciiArtChalker.clone();
x.set("p", chalk.hex("#FFC0CB")); // add HTML pink
2.1.1

8 months ago

2.0.2

8 months ago

1.0.25

8 months ago

2.1.0

8 months ago

2.0.1

8 months ago

2.0.0

8 months ago

1.0.24

4 years ago

1.0.22

4 years ago

1.0.23

4 years ago

1.0.21

4 years ago

1.0.20

4 years ago

1.0.19

4 years ago

1.0.18

4 years ago

1.0.17

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.14

5 years ago

1.0.13

5 years ago

1.0.12

5 years ago

1.0.11

5 years ago

1.0.10

5 years ago

1.0.9

5 years ago

1.0.8

5 years ago

1.0.7

5 years ago

1.0.5

5 years ago