1.0.0 • Published 1 year ago

pen-style v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

pen-style

image

A minimal color and formatting for console

Simple color and formatting for console log.

  • 8 colors (black,white,red,blue,green,yellow,cyan,orange).
  • Hex colors (#f5f5e8).
  • RGB.
  • Background colors.
  • Style with Bold, Italic, Underline and Strikethrough.

Usage

Usage:

var { Pen } = require("pen-style");

Or

import { Pen } from "pen-style-test";

Output colored text:

console.log(Pen("This text is red","red"));

Styles can be mixed:

console.log(Pen("This text is cyan with underline and italic",{c:"cyan",o:"ui"}));

API

Pen(text, color)

color can be default colors(black,white,red,blue,green,yellow,cyan,orange), Hex or RGB

Example

console.log(Pen("This using rgb",{r:120,g:50,b:12}));

console.log(Pen("This using hex","#FF0000"));

console.log(Pen("This using color","red"));

Pen(text, options)

options has fields

FieldTypeDescription
cstring or rgbText color
bstring or rgbBackground color
ostring or rgbOther style options ex: bi = Bold + italic

Style

Bold: b

Italic: i

Underline: u

Strikethrough. s

Style can be combine: bi = Bold + italic

Contributing

All contributions are accepted as a PR.

  • You can file issues by submitting a PR.
  • Implement new feature by submitting a PR.
  • Improve documentation by submitting PR. You are welcome to improve this project! It would help me so much!

Support

For support, email downy1229@gmail.com!