repository·main·Indexed 23 days ago
https://github.com/jorgebucaran/coloretteA lightweight, zero-dependency Node.js library for setting terminal text colors and styles. It features automatic color support detection, high performance, and supports standard ANSI colors, bright variants, background colors, and text modifiers like bold and underline. It respects NO_COLOR and FORCE_COLOR environment variables as well as --no-color and --color CLI flags.
Colorette respects standard terminal color control mechanisms:
CLI Flags
Use --no-color to disable color or --color to force it.
Environment Variables
NO_COLOR=: Disables color.FORCE_COLOR=: Forces color.$ ./example.js --no-color | ./consumer.js
$ NO_COLOR= ./example.js | ./consumer.jsImport specific color or style functions from colorette to wrap strings. You can nest styles (e.g., applying bold to a blue string) and use them within template literals. Colorette handles nested styles without breaking existing color sequences.
import { blue, bold, underline } from "colorette"
console.log(
blue("I'm blue"),
bold(blue("da ba dee")),
underline(bold(blue("da ba daa")))
)Install the colorette package using npm to start using terminal text colors and styles in your Node.js projects.
npm install coloretteUse createColors({ useColor }) to manually control whether colors are enabled or disabled, bypassing the automatic terminal detection. This is useful for testing or specific environment requirements.
import { createColors } from "colorette"
const { blue } = createColors({ useColor: false })
console.log(blue("Blue? Nope, nah"))Import individual color or style functions directly from colorette. Each function wraps a string in the corresponding ANSI escape code.
import { blue } from "colorette"
blue("I'm blue") //=> \x1b[34mI'm blue\x1b[39mColorette provides the following color, background, and modifier functions:
| Colors | Background Colors | Bright Colors | Bright Background Colors | Modifiers |
| ------- | ----------------- | ------------- | ------------------------ | ----------------- |
| black | bgBlack | blackBright | bgBlackBright | dim |
| red | bgRed | redBright | bgRedBright | **bold** |
| green | bgGreen | greenBright | bgGreenBright | hidden |
| yellow | bgYellow | yellowBright | bgYellowBright | _italic_ |
| blue | bgBlue | blueBright | bgBlueBright | <u>underline</u> |
| magenta | bgMagenta | magentaBright | bgMagentaBright | ~~strikethrough~~ |
| cyan | bgCyan | cyanBright | bgCyanBright | reset |
| white | bgWhite | whiteBright | bgWhiteBright | |
| gray | | | | |The createColors() function returns a Colorette object containing all available color and style functions. This is useful if you want to pass a single object containing all styling capabilities around your application. You can optionally pass an options object to control color usage.
Options:
useColor: boolean - Forces color usage (if true, colors will be applied regardless of terminal support).The createColors() function allows you to create a set of color/style functions. You can control whether colors are enabled by passing a useColor option.
useColor is true (or omitted, defaulting to isColorSupported), it returns the standard color functions that wrap strings in ANSI escape codes.useColor is false, it returns a set of functions that simply return the input string as-is (effectively disabling all styling).Color type signature: (text: string | number) => string. You can import these functions directly to wrap text for terminal output.Colorette exports a collection of functions for applying ANSI colors and styles directly to strings. If colors are supported in the environment, these functions wrap the input string in the appropriate escape codes. If not, they return the string unchanged.
Styles:
reset: Resets all stylesbold: Bold textdim: Dim textitalic: Italic textunderline: Underlined textinverse: Inverted colorshidden: Hidden textstrikethrough: Strikethrough textColors:
black, red, green, yellow, blue, magenta, cyan, white, grayblackBright, redBright, greenBright, yellowBright, blueBright, magentaBright, cyanBright, whiteBrightBackground Colors:
bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhitebgBlackBright, bgRedBright, bgGreenBright, bgYellowBright, bgBlueBright, bgMagentaBright, bgCyanBright, bgWhiteBrightThe following functions are exported by colorette. Each accepts a string or number and returns a formatted string.
resetbolddimitalicunderlineinversehiddenstrikethroughblackredgreenyellowbluemagentacyanwhitegraybgBlackbgRedbgGreenbgYellowbgBluebgMagentabgCyanbgWhiteblackBrightredBrightgreenBrightyellowBrightblueBrightmagentaBrightcyanBrightwhiteBrightbgBlackBrightbgRedBrightbgGreenBrightbgYellowBrightbgBlueBrightbgMagentaBrightbgCyanBrightbgWhiteBrighttype Color = (text: string | number) => string
// Styles
const reset: Color
const bold: Color
const dim: Color
const italic: Color
const underline: Color
const inverse: Color
const hidden: Color
const strikethrough: Color
// Colors
const black: Color
const red: Color
const green: Color
const yellow: Color
const blue: Color
const magenta: Color
const cyan: Color
const white: Color
const gray: Color
// Backgrounds
const bgBlack: Color
const bgRed: Color
const bgGreen: Color
const bgYellow: Color
const bgBlue: Color
const bgMagenta: Color
const bgCyan: Color
const bgWhite: Color
// Bright Colors
const blackBright: Color
const redBright: Color
const greenBright: Color
const yellowBright: Color
const blueBright: Color
const magentaBright: Color
const cyanBright: Color
const whiteBright: Color
// Bright Backgrounds
const bgBlackBright: Color
const bgRedBright: Color
const bgGreenBright: Color
const bgYellowBright: Color
const bgBlueBright: Color
const bgMagentaBright: Color
const bgCyanBright: Color
const bgWhiteBright: ColorisColorSupported is a boolean that returns true if the current terminal supports color, and false otherwise. While primarily used internally, it is exported for manual checks.