Skip to content

Commit 797461e

Browse files
committed
Meta tweaks
1 parent 0e6fecc commit 797461e

2 files changed

Lines changed: 3 additions & 14 deletions

File tree

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Terminal string styling done right",
55
"license": "MIT",
66
"repository": "chalk/chalk",
7+
"funding": "https://github.com/chalk/chalk?sponsor=1",
78
"main": "source",
89
"engines": {
910
"node": ">=8"
@@ -49,7 +50,7 @@
4950
"execa": "^3.2.0",
5051
"import-fresh": "^3.1.0",
5152
"matcha": "^0.7.0",
52-
"nyc": "^14.1.1",
53+
"nyc": "^15.0.0",
5354
"resolve-from": "^5.0.0",
5455
"tsd": "^0.7.4",
5556
"xo": "^0.25.3"

readme.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313

1414
<img src="https://cdn.jsdelivr.net/gh/chalk/ansi-styles@8261697c95bf34b6c7767e2cbe9941a851d59385/screenshot.svg" width="900">
1515

16-
1716
## Highlights
1817

1918
- Expressive API
@@ -24,16 +23,14 @@
2423
- Doesn't extend `String.prototype`
2524
- Clean and focused
2625
- Actively maintained
27-
- [Used by ~46,000 packages](https://www.npmjs.com/browse/depended/chalk) as of October 1, 2019
28-
26+
- [Used by ~50,000 packages](https://www.npmjs.com/browse/depended/chalk) as of January 1, 2020
2927

3028
## Install
3129

3230
```console
3331
$ npm install chalk
3432
```
3533

36-
3734
## Usage
3835

3936
```js
@@ -107,7 +104,6 @@ console.log(chalk.green('Hello %s'), name);
107104
//=> 'Hello Sindre'
108105
```
109106

110-
111107
## API
112108

113109
### chalk.`<style>[.<style>...](string, [string...])`
@@ -149,7 +145,6 @@ Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=
149145

150146
`chalk.stderr` contains a separate instance configured with color support detected for `stderr` stream instead of `stdout`. Override rules from `chalk.supportsColor` apply to this too. `chalk.stderr.supportsColor` is exposed for convenience.
151147

152-
153148
## Styles
154149

155150
### Modifiers
@@ -202,7 +197,6 @@ Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=
202197
- `bgCyanBright`
203198
- `bgWhiteBright`
204199

205-
206200
## Tagged template literal
207201

208202
Chalk can be used as a [tagged template literal](http://exploringjs.com/es6/ch_template-literals.html#_tagged-template-literals).
@@ -232,7 +226,6 @@ Note that function styles (`rgb()`, `hsl()`, `keyword()`, etc.) may not contain
232226

233227
All interpolated values (`` chalk`${foo}` ``) are converted to strings via the `.toString()` method. All curly braces (`{` and `}`) in interpolated value strings are escaped.
234228

235-
236229
## 256 and Truecolor color support
237230

238231
Chalk supports 256 colors and [Truecolor](https://gist.github.com/XVilka/8346728) (16 million colors) on supported terminal apps.
@@ -262,24 +255,20 @@ The following color models can be used:
262255
- [`ansi`](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit) - Example: `chalk.ansi(31).bgAnsi(93)('red on yellowBright')`
263256
- [`ansi256`](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) - Example: `chalk.bgAnsi256(194)('Honeydew, more or less')`
264257

265-
266258
## Windows
267259

268260
If you're on Windows, do yourself a favor and use [Windows Terminal](https://github.com/microsoft/terminal) instead of `cmd.exe`.
269261

270-
271262
## Origin story
272263

273264
[colors.js](https://github.com/Marak/colors.js) used to be the most popular string styling module, but it has serious deficiencies like extending `String.prototype` which causes all kinds of [problems](https://github.com/yeoman/yo/issues/68) and the package is unmaintained. Although there are other packages, they either do too much or not enough. Chalk is a clean and focused alternative.
274265

275-
276266
## chalk for enterprise
277267

278268
Available as part of the Tidelift Subscription.
279269

280270
The maintainers of chalk and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-chalk?utm_source=npm-chalk&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
281271

282-
283272
## Related
284273

285274
- [chalk-cli](https://github.com/chalk/chalk-cli) - CLI for this module
@@ -297,7 +286,6 @@ The maintainers of chalk and thousands of other packages are working with Tideli
297286
- [chalk-pipe](https://github.com/LitoMore/chalk-pipe) - Create chalk style schemes with simpler style strings
298287
- [terminal-link](https://github.com/sindresorhus/terminal-link) - Create clickable links in the terminal
299288

300-
301289
## Maintainers
302290

303291
- [Sindre Sorhus](https://github.com/sindresorhus)

0 commit comments

Comments
 (0)