1.1.1 • Published 12 months ago

javascript-console-styling v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

Features

This package comes with all available console styling escape codes in the form of functions, which allows for features that console-styling does not provide such as nesting colors and/or decorations. This package also provides a main.js file that can be used to easily test out all the functions and their output in different environments.

Colors

Black, Black Background, Red, Red Background, Green, Green Background, Yellow, Yellow Background, Blue, Blue Background, Magenta, Magenta Background, Cyan, Cyan Background, White, White Background, Gray, Gray Background, Bright Red, Bright Red Background, Bright Green, Bright Green Background, Bright Yellow, Bright Yellow Background, Bright Blue, Bright Blue Background, Bright Magenta, Bright Magenta Background, Bright Cyan, Bright Cyan Background, Bright White, Bright White Background

All available colours

Decorations

Bright, Dim, Italic Not widely supported, Underline, SlowBlink, RapidBlink Not widely supported, Reverse Not widely supported, Hidden Not widely supported, Strikethrough Not supported by all terminals (mostly the Windows Terminal)

All available decorations, the eighth one is "hidden"

Combinations

You can obviously combined color styles and decorations together by nesting them:

All available decoration/colour style combinations

The first block of those two is hidden

Usage

Option 1: Import all the colors and decorations

You can import all the color styles and decorations together with the following code:

const JCS = require("javascript-console-styling");

You can also import the Colors and Decorations object with the following code:

const { Colors, Decorations } = require("javascript-console-styling");

And later use individual styles:

console.log(Colors.redBg(Decorations.underline("Hello, world!")));

or declare them on their own:

const redBg = Colors.redBg;
const underline = Decorations.underline;
console.log(redBg(underline("Hello, world!")));

Option 2: Import only the colors

If you only want to use the color styles, you can import them on their own with the following code:

const Colors = require("javascript-console-styling/Colors");

You can also import a specific color styling on its own with the following code:

const { red, magenta, cyanBg } = require("javascript-console-styling/Colors");

Option 3: Import only the decorations

If you only want to use the decorations, you can import them on their own with the following code:

const Decorations = require("javascript-console-styling/Decorations");

You can also import a specific decoration on its own with the following code:

const { bright, underline, strikethrough } = require("javascript-console-styling/Decorations");

Issues

You can file an issue on Github, your issue can be a suggestion or a bug report as long as it's not a duplicate and is detailed and concisely described.