Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ehmicky/colors-option

Let users toggle colors
https://github.com/ehmicky/colors-option

ansi bash chalk cli color colors config configuration disable es6 javascript library nodejs option rgb shell terminal tty typescript windows

Last synced: 19 days ago
JSON representation

Let users toggle colors

Host: GitHub
URL: https://github.com/ehmicky/colors-option
Owner: ehmicky
License: mit
Created: 2021-03-01T21:19:32.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-09-14T16:52:53.000Z (2 months ago)
Last Synced: 2024-10-11T10:17:07.711Z (about 1 month ago)
Topics: ansi, bash, chalk, cli, color, colors, config, configuration, disable, es6, javascript, library, nodejs, option, rgb, shell, terminal, tty, typescript, windows
Language: JavaScript
Homepage:
Size: 5.61 MB
Stars: 7
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js&colorA=404040&logoColor=66cc33)](https://www.npmjs.com/package/colors-option)

[![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript&colorA=404040&logoColor=0096ff)](/src/main.d.ts)

[![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov&colorA=404040)](https://codecov.io/gh/ehmicky/colors-option)

[![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon&colorA=404040&logoColor=9590F9)](https://fosstodon.org/@ehmicky)

[![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium&colorA=404040)](https://medium.com/@ehmicky)

Let users toggle colors.

This is a thin wrapper around the popular

[`chalk`](https://github.com/chalk/chalk) colors library that adds support for:

- A [`colors` boolean option](#colors)

- The [`NO_COLOR`](https://no-color.org/) and

  [`NODE_DISABLE_COLORS`](https://nodejs.org/api/cli.html#cli_node_disable_colors_1)

  environment variables

# Hire me

Please

[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)

if you're looking for a Node.js API or CLI engineer (11 years of experience).

Most recently I have been [Netlify Build](https://github.com/netlify/build)'s

and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'

technical lead for 2.5 years. I am available for full-time remote positions.

# Example

```js

import colorsOption from 'colors-option'

const exampleLibrary = ({ colors, ...otherLibraryOptions }) => {

  const chalk = colorsOption({ colors })

  console.log(chalk.red('example'))

}

```

# Install

```

npm install colors-option

```

This package works in Node.js >=18.18.0.

This is an ES module. It must be loaded using

[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),

not `require()`. If TypeScript is used, it must be configured to

[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),

not CommonJS.

# API

## colorsOption(options?)

`options`: `object`\

_Return value_: [`Chalk` instance](https://github.com/chalk/chalk#api)

### options

#### colors

_Type_: `boolean`\

_Default_: `undefined`

Whether colors should be enabled/disabled, regardless of terminal support.

Colors support is automatically detected, so this is only meant to override that

default behavior.

The recommended approach is to:

- Add a `colors` boolean programmatic option and/or CLI flag

- Keep its default value `undefined`

- Forward it to `colors-option`

Instead of using

[`chalk/supports-color`](https://github.com/chalk/supports-color), this relies

on Node.js built-in colors detection

[`getColorDepth()`](https://nodejs.org/api/tty.html#tty_writestream_getcolordepth_env)

which:

- Supports the [`NO_COLOR`](https://no-color.org/) and

  [`NODE_DISABLE_COLORS`](https://nodejs.org/api/cli.html#cli_node_disable_colors_1)

  environment variables.

- Does not guess colors detection based on the presence of a

  [`--colors` CLI flag](https://github.com/chalk/supports-color#info). This

  gives finer control and flexibility over how to expose this as a CLI flag.

Please note that `chalk` has a similar

[`level` option](https://github.com/chalk/chalk#chalklevel). However, that

option is an integer from `0` to `3` which makes it hard to toggle colors while

still keeping 256 colors or Truecolor.

#### stream

_Type_:

[`Stream`](https://nodejs.org/api/stream.html#stream_class_stream_writable)\

_Default_: [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout)

Stream used to detect colors support. This should be the file or terminal where

the colors are output.

# See also

- [`chalk-string`](https://github.com/ehmicky/chalk-string): Chalk with style

  strings.

- [`terminal-theme`](https://github.com/ehmicky/terminal-theme): 🎨 Use a color

  theme for your code's terminal output.

# Support

For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).

Everyone is welcome regardless of personal background. We enforce a

[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and

inclusive environment.

# Contributing

This project was made with ❤️. The simplest way to give back is by starring and

sharing it online.

If the documentation is unclear or has a typo, please click on the page's `Edit`

button (pencil icon) and suggest a correction.

If you would like to help us fix a bug or add a new feature, please check our

[guidelines](CONTRIBUTING.md). Pull requests are welcome!