summaryrefslogtreecommitdiff
path: root/colors/README.md
blob: 7a02d9efb8450d64262e430d6822a4fa0a94ea87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# colors

Is a basic console color module intended for [Deno](https://deno.land/). It is
inspired by [chalk](https://www.npmjs.com/package/chalk),
[kleur](https://www.npmjs.com/package/kleur), and
[colors](https://www.npmjs.com/package/colors) on npm.

## Usage

The main modules exports several functions which can color the output to the
console:

```ts
import { bgBlue, red, bold } from "https://deno.land/std/colors/mod.ts";

console.log(bgBlue(red(bold("Hello world!"))));
```

This module supports `NO_COLOR` environmental variable disabling any coloring if `NO_COLOR` is set.

## TODO

- Currently, it just assumes it is running in an environment that supports ANSI
  escape code terminal coloring. It should actually detect, specifically windows
  and adjust properly.

- Test coverage is very basic at the moment.

---

Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.