kleur

Patches

• Add existence process.stdout check for browser-like polyfills (#42): 01963cc
  Bundlers like parcel, webpack, and browserify polyfill process but don't include a stdout implementation.
  Thank you @tinchoz49~!

Patches

• Ensure NO_COLOR disables colorization if any value is received (#38, #39, #40, #41): ef5d4a8, b329629
  Now properly adheres to the NO_COLOR spec.
  Thank you @stramel and @chocolateboy~!

Chores

• Adds tests to ensure FORCE_COLOR= works as expected (#41): b329629
  Much like NO_COLOR, use of FORCE_COLOR= is expected to be truthy.

Patches

• (types): Ensure kleur/colors type definitions can be resolved: 06923d0, cc66a6f

Features

• Add support for the NO_COLOR standard (#37): d839af7
  Thank you @stramel~! 🎉

Chores

• Enable GitHub Sponsors button 🙇: 16bc034

Patches

• Ensure process is defined before setting process-based values (#36): 303e502
  This allows for kleur to be imported into browsers without any bundle-shimming.

  NOTE: ANSI code support varies between browsers, but typically colors and background-colors work (never modifiers).

Patches

• Disable colorization if inside a TTY context (#33): 5c7353f
  Thank you @ai~!

  # Before:
  $ npx app.js > log.txt
  #=> The `log.txt` filled with ANSI codes 
  
  # After:
  $ npx app.js > log.txt
  #=> The `log.txt` is plain text
  
  # OVERRIDE:
  $ FORCE_COLOR=1 npx app.js > log.txt
  #=> The `log.txt` filled with ANSI codes; as requested

Chores

• Add bash tests for ENV detection: 5c7353f
• Update README with TTY explainer and example: 3a6a272, 3b3742a
• Update test runner version: 5fd93ba

Patches

• Revert to Node 6.x minimum support: 8c01d93
  The code works perfectly in that environment, so there's no reason not to.
  Truth be told, it was only bumped to 10.x because of the test runner constraint.

• (types) fix kleur/colors overloaded definition: f2f33a8
  Original print order assumed that every export returned null, which is not true.

Breaking

The minimum Node.js runtime increased from 6.x to 10.x since 10.x is the oldest active LTS version.
If you need to continue supporting Node 6.x, either continue using kleur@3.x or ignore the "engines" constraint of kleur@4.x – its CommonJS files will still execute in a Node 6.x environment.

Features

• Added native ESM support with exports map (for Node 12.18.x, Node 14+) (#30): 2da16a9
  Thank you @kristoferbaxter~!

• Added module package entry (for bundler and PikaCDN) (#31): 2da16a9

• Added new kleur/colors entry module: 049c080

These changes allow for import statements with kleur.
It's done in a way such that Node.js environments that natively support import will work. For those that don't and are using webpack/Rollup, the "module" entry is made available so that you can still take advantage of the ESM format.

We took this idea one step further with kleur/colors – which individually exports each color, modifier, and background function. This allows you to import only the methods you need, and the unused pieces of code are detached from your code. In other words, kleur/colors is 100% treeshakeable, which is a big advantage of the ESM format. Node.js (with native ESM support), Rollup, and webpack benefit from this, which means that your programs only include/load the kleur code you use.

If you're not ready to use ESM yet, require statements still work for both modules in all environments.

See the Individual Colors documentation for more info

import kleur from 'kleur';
import * as colors from 'kleur/colors';

console.log(
  kleur.underline().green('kleur natively supports ESM~!')
);

console.log(
  colors.white(colors.italic(`... so does "${ colors.green('kleur/colors') }"~!`))
);

Chores

• Migrate CI from TravisCI to GitHub Actions: f0b5da4, 88f9f72
• Move to c8 for code coverage: 06e3ba4
• Update test runner, include kleur/colors tests: f39b294
• Update benchmarks: 46cc8d8, 61d0d58, 049c080
• Update README: e2291ef, 9f09249, 840d3c0

Patches

• Add grey alias (#21): 59bdd40 Thanks @lumio

• Types: Export all interfaces (#23): 70e682d Thanks @Hammster

• Always reopen code on shared code.close sequence: 10981d2

• Internal: Track chain segments by code.open value, not color name: e9dbd08

• Internal: Initialize all codes inline within factory: e9dbd08

• Internal: Check code.close existence before String.replace: b1b41a8

• Internal: Only String.replace on unique contents: e9dbd08

Chores

• Update tests' expected ANSI for code.open sequences: 896c801
• Update tests' expected ANSI for "nested" chains & reopened codes: c74f538
• Update benchmark results: 35cbbc0

Patches

• Ensure this context isn't overridden by global (#18): 3d3a4cb

Chores

• Update benchmark results: 9a3f313

Patches

• Fix: Set enumerable properties for object visibility (#18): 48b3027 Thanks @marvinhagemeister~!

• Fix: Improve TS typings for expected CommonJS behavior (#18): 48b3027 Thanks again @marvinhagemeister~!

Breaking (#16)

This version is an intentional departure from the Chalk-like syntax. Any previous kleur chains (those with more than one color) will not work with 3.0 and will require slight changes. Most libraries can expect to update their usage within a few minutes!

// Before:
kleur.red.bold.underline('bolded, underlined, and red~!');


// After:
kleur.red().bold().underline('bolded, underlined, and red~!');

However, should you prefer the old syntax, please consider using ansi-colors instead since (in most cases) it's a drop-in replacement for Chalk while staying significantly smaller and faster.

You can also replace kleur@2.x with ansi-colors without any code/syntax changes.

Important: The release of kleur@3.0 deprecates older kleur versions.

Features

Named Chains & Partial Requires

It's now possible to save color-chains directly as variables!

// Before:
const kleur = require('kleur');

const toError = msg => kleur.white.bold.bgRed(msg);

toError('Oops');


// After:
const { white } = require('kleur'); // now possible

const toError = white().bold().bgRed;

toError('Oops');

Detect Color Support (#13)

A (super) simple check for color support is now included, which sets the initial value for enabled.

Many libs attempt to toggle colors via FORCE_COLOR since this ENV is used by Chalk. See also NODE_DISABLE_COLORS.

const { FORCE_COLOR, NODE_DISABLE_COLORS, TERM } = process.env;

const $ = {
  enabled: !NODE_DISABLE_COLORS && TERM !== 'dumb' && FORCE_COLOR !== '0'
};

Patches

• Improved TypeScript definitions (#14): 05ccfa8 Thanks @Rich-Harris~!

Patches

• Handle Numbers safely as Strings: e7c96db, 1ed6120

Patches

• Include TypeScript definitions: (#8): 0b44261 Thank you @madhavarshney and @rogierschouten

Chores

• Update benchmarks & results: 46205a9
• Update enabled example in README: 58496c9
• Clarify ansi-colors credits; with pitch & preference: 94d4f96

Patches

• Performance improvements: 9da1922, 9d1a735

  • Dropping the spread operator & the unnecessary function improved the op/s by 20k alone!
  • Reverted to object-type CODES for legibility & ~700 op/s gain

Chores

• Update benchmark member: clorox@2.0: e865520
• Update benchmark results: 1ad595c