开发者社区> 镜像站> NPM> ansi-rainbow
ansi-rainbow
One of the most advanced ansi string rainbow stylizer tool
Last updated 4 years ago by soyuka .
WTFPL · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install ansi-rainbow 
SYNC missed versions from official npm registry.

ansi-rainbow

Rainbowify string with https://github.com/sindresorhus/ansi-styles rainicorn

Install

npm install ansi-rainbow

Basic example


var rainbow = require('ansi-rainbow')

console.log(rainbow.r("I am in the pony world"))
//or
console.log(rainbow.r("I", "am", "in", "the", "pony", "world"))

//what about background rainbows?

console.log(rainbow.bg("I am a background in the pony world"))

That outputs:

pony pony

Features

Rainbow is skipping black and white colors (did you ever seen these on a rainbow?). But, we could imagine that in a world where Pony's are flying, black could be part of a rainbow so:

rainbow.add('black white') //adds black and white

Let's write all features together to print a rainbow flag \o/:


rainbow
	.add('black', 'white')
	.reset() //we do not want black and white anymore - note it does not reset options only colors
	.skip(rainbow._backgrounds) //skips backgrounds
	.add('bgBlue bgMagenta bgCyan') //this will keep order when rainbowified
	.options({color_space: true, gap: 3}) //this will force color spaces and change color every 3 characters

	console.log(rainbow.bg('         '))
	console.log(rainbow.bg('123456789'))
	console.log(rainbow.bg('         '))

That outputs:

pony pony

API

  • r(string) rainbowify
  • bg(string) background-rainbowify
  • add(colors) do not skip colors
  • skip(colors) skip colors
  • reset() reset colors (skips ['black', 'white', 'bgBlack', 'bgWhite'])
  • options({}) set options
    • (bool) .color_space or .colorSpace - whether to color spaces
    • (string) .space_color or .spaceColor - space color string
    • (int) .gap - the gap size between a color change

TODO

What about everything that is not a string?

Current Tags

  • 1.0.1                                ...           latest (4 years ago)

11 Versions

  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           5 years ago
  • 0.0.9                                ...           5 years ago
  • 0.0.8                                ...           6 years ago
  • 0.0.7                                ...           7 years ago
  • 0.0.6                                ...           7 years ago
  • 0.0.5                                ...           7 years ago
  • 0.0.4                                ...           7 years ago
  • 0.0.3                                ...           7 years ago
  • 0.0.2                                ...           7 years ago
  • 0.0.1                                ...           7 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (1)
Dev Dependencies (4)