Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on May 10, 2024 via pnpm

colorette 2.0.20

๐ŸŒˆEasily set your terminal text color & styles.
Package summary
Share
0
issues
1
license
1
MIT
Package created
23 Aug 2018
Version published
16 Apr 2023
Maintainers
1
Total deps
1
Direct deps
0
License
MIT

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
1 Packages, Including:
colorette@2.0.20
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

0
All Dependencies CSV
โ“˜ This is a list of colorette 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities

Visualizations

Frequently Asked Questions

What does colorette do?

Colorette is a versatile JavaScript library, ideal for setting the color and style of your terminal text in an effortless and efficient way. It offers the advantage of no dependencies and an automatic color support detection feature. Colorette also ensures excellent performance with speed up to 2 times faster than its alternatives. It also provides TypeScript support and observes standards such as the NO_COLOR guideline. Compatibility-wise, it works with Node 10 and above versions.

How do you use colorette?

Using Colorette in your JavaScript projects is quite straightforward. First, you need to install it via npm with the command npm install colorette.

Once installed, you can import Colorette into your project and use it to add color to your terminal text as shown below:

import { blue, bold, underline } from "colorette"

console.log(
  blue("I'm blue"),
  bold(blue("da ba dee")),
  underline(bold(blue("da ba daa")))
)

Colorette offers support for nesting of styles:

console.log(bold(`I'm ${blue(`da ba ${underline("dee")} da ba`)} daa`))

And overriding terminal color detection:

import { createColors } from "colorette"

const { blue } = createColors({ useColor: false })

console.log(blue("Blue? Nope, nah"))

Where are the colorette docs?

The Colorette documentation can be found within the README file on its GitHub repository page located at https://github.com/jorgebucaran/colorette. It provides essential information about the API methods, environment configuration, usage examples, and the list of supported colors. It also hosts information about performance benchmarks and acknowledgment notes.