Comparing version 2.4.2 to 3.0.0-beta.1
{ | ||
"name": "chalk", | ||
"version": "2.4.2", | ||
"version": "3.0.0-beta.1", | ||
"description": "Terminal string styling done right", | ||
"license": "MIT", | ||
"repository": "chalk/chalk", | ||
"main": "source", | ||
"engines": { | ||
"node": ">=4" | ||
"node": ">=8" | ||
}, | ||
"scripts": { | ||
"test": "xo && tsc --project types && flow --max-warnings=0 && nyc ava", | ||
"bench": "matcha benchmark.js", | ||
"coveralls": "nyc report --reporter=text-lcov | coveralls" | ||
"test": "xo && nyc ava && tsd", | ||
"bench": "matcha benchmark.js" | ||
}, | ||
"files": [ | ||
"index.js", | ||
"templates.js", | ||
"types/index.d.ts", | ||
"index.js.flow" | ||
"source", | ||
"index.d.ts" | ||
], | ||
@@ -45,28 +43,22 @@ "keywords": [ | ||
"dependencies": { | ||
"ansi-styles": "^3.2.1", | ||
"escape-string-regexp": "^1.0.5", | ||
"supports-color": "^5.3.0" | ||
"ansi-styles": "^4.1.0", | ||
"supports-color": "^7.1.0" | ||
}, | ||
"devDependencies": { | ||
"ava": "*", | ||
"coveralls": "^3.0.0", | ||
"execa": "^0.9.0", | ||
"flow-bin": "^0.68.0", | ||
"import-fresh": "^2.0.0", | ||
"ava": "^2.4.0", | ||
"coveralls": "^3.0.5", | ||
"execa": "^2.0.3", | ||
"import-fresh": "^3.1.0", | ||
"matcha": "^0.7.0", | ||
"nyc": "^11.0.2", | ||
"resolve-from": "^4.0.0", | ||
"typescript": "^2.5.3", | ||
"xo": "*" | ||
"nyc": "^14.1.1", | ||
"resolve-from": "^5.0.0", | ||
"tsd": "^0.7.4", | ||
"xo": "^0.25.3" | ||
}, | ||
"types": "types/index.d.ts", | ||
"xo": { | ||
"envs": [ | ||
"node", | ||
"mocha" | ||
], | ||
"ignores": [ | ||
"test/_flow.js" | ||
] | ||
"rules": { | ||
"unicorn/prefer-string-slice": "off", | ||
"unicorn/prefer-includes": "off" | ||
} | ||
} | ||
} |
@@ -12,7 +12,7 @@ <h1 align="center"> | ||
[![Build Status](https://travis-ci.org/chalk/chalk.svg?branch=master)](https://travis-ci.org/chalk/chalk) [![Coverage Status](https://coveralls.io/repos/github/chalk/chalk/badge.svg?branch=master)](https://coveralls.io/github/chalk/chalk?branch=master) [![](https://img.shields.io/badge/unicorn-approved-ff69b4.svg)](https://www.youtube.com/watch?v=9auOCbH5Ns4) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) [![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs) | ||
[![Build Status](https://travis-ci.org/chalk/chalk.svg?branch=master)](https://travis-ci.org/chalk/chalk) [![Coverage Status](https://coveralls.io/repos/github/chalk/chalk/badge.svg?branch=master)](https://coveralls.io/github/chalk/chalk?branch=master) [![npm dependents](https://badgen.net/npm/dependents/chalk)](https://www.npmjs.com/package/chalk?activeTab=dependents) [![Downloads](https://badgen.net/npm/dt/chalk)](https://www.npmjs.com/package/chalk) [![](https://img.shields.io/badge/unicorn-approved-ff69b4.svg)](https://www.youtube.com/watch?v=9auOCbH5Ns4) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) ![TypeScript-ready](https://img.shields.io/npm/types/chalk.svg) | ||
### [See what's new in Chalk 2](https://github.com/chalk/chalk/releases/tag/v2.0.0) | ||
<img src="https://cdn.jsdelivr.net/gh/chalk/ansi-styles@8261697c95bf34b6c7767e2cbe9941a851d59385/screenshot.svg" width="900"> | ||
<img src="https://cdn.rawgit.com/chalk/ansi-styles/8261697c95bf34b6c7767e2cbe9941a851d59385/screenshot.svg" alt="" width="900"> | ||
**This readme reflects the next major version that is currently in development. You probably want [the v2 readme](https://www.npmjs.com/package/chalk).** | ||
@@ -30,3 +30,3 @@ | ||
- Actively maintained | ||
- [Used by ~23,000 packages](https://www.npmjs.com/browse/depended/chalk) as of December 31, 2017 | ||
- [Used by ~46,000 packages](https://www.npmjs.com/browse/depended/chalk) as of October 1, 2019 | ||
@@ -40,7 +40,3 @@ | ||
<a href="https://www.patreon.com/sindresorhus"> | ||
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160"> | ||
</a> | ||
## Usage | ||
@@ -130,16 +126,6 @@ | ||
### chalk.enabled | ||
### chalk.level | ||
Color support is automatically detected, as is the level (see `chalk.level`). However, if you'd like to simply enable/disable Chalk, you can do so via the `.enabled` property. | ||
Specifies the level of color support. | ||
Chalk is enabled by default unless explicitly disabled via the constructor or `chalk.level` is `0`. | ||
If you need to change this in a reusable module, create a new instance: | ||
```js | ||
const ctx = new chalk.constructor({enabled: false}); | ||
``` | ||
### chalk.level | ||
Color support is automatically detected, but you can override it by setting the `level` property. You should however only do this in your own code as it applies globally to all Chalk consumers. | ||
@@ -150,3 +136,3 @@ | ||
```js | ||
const ctx = new chalk.constructor({level: 0}); | ||
const ctx = new chalk.Instance({level: 0}); | ||
``` | ||
@@ -165,7 +151,11 @@ | ||
Can be overridden by the user with the flags `--color` and `--no-color`. For situations where using `--color` is not possible, add the environment variable `FORCE_COLOR=1` to forcefully enable color or `FORCE_COLOR=0` to forcefully disable. The use of `FORCE_COLOR` overrides all other color support checks. | ||
Can be overridden by the user with the flags `--color` and `--no-color`. For situations where using `--color` is not possible, use the environment variable `FORCE_COLOR=1` (level 1), `FORCE_COLOR=2` (level 2), or `FORCE_COLOR=3` (level 3) to forcefully enable color, or `FORCE_COLOR=0` to forcefully disable. The use of `FORCE_COLOR` overrides all other color support checks. | ||
Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively. | ||
### chalk.stderr and chalk.stderr.supportsColor | ||
`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. | ||
## Styles | ||
@@ -175,11 +165,11 @@ | ||
- `reset` | ||
- `bold` | ||
- `dim` | ||
- `italic` *(Not widely supported)* | ||
- `underline` | ||
- `inverse` | ||
- `hidden` | ||
- `strikethrough` *(Not widely supported)* | ||
- `visible` (Text is emitted only if enabled) | ||
- `reset` - Resets the current color chain. | ||
- `bold` - Make text bold. | ||
- `dim` - Emitting only a small amount of light. | ||
- `italic` - Make text italic. *(Not widely supported)* | ||
- `underline` - Make text underline. *(Not widely supported)* | ||
- `inverse`- Inverse background and foreground colors. | ||
- `hidden` - Prints the text, but makes it invisible. | ||
- `strikethrough` - Puts a horizontal line through the center of the text. *(Not widely supported)* | ||
- `visible`- Prints the text only when Chalk has a color level > 0. Can be useful for things that are purely cosmetic. | ||
@@ -192,7 +182,7 @@ ### Colors | ||
- `yellow` | ||
- `blue` *(On Windows the bright version is used since normal blue is illegible)* | ||
- `blue` | ||
- `magenta` | ||
- `cyan` | ||
- `white` | ||
- `gray` ("bright black") | ||
- `blackBright` (alias: `gray`, `grey`) | ||
- `redBright` | ||
@@ -216,3 +206,3 @@ - `greenBright` | ||
- `bgWhite` | ||
- `bgBlackBright` | ||
- `bgBlackBright` (alias: `bgGray`, `bgGrey`) | ||
- `bgRedBright` | ||
@@ -238,4 +228,4 @@ - `bgGreenBright` | ||
console.log(chalk` | ||
There are {bold 5280 feet} in a mile. | ||
In {bold ${miles} miles}, there are {green.bold ${calculateFeet(miles)} feet}. | ||
There are {bold 5280 feet} in a mile. | ||
In {bold ${miles} miles}, there are {green.bold ${calculateFeet(miles)} feet}. | ||
`); | ||
@@ -290,3 +280,3 @@ ``` | ||
If you're on Windows, do yourself a favor and use [`cmder`](http://cmder.net/) instead of `cmd.exe`. | ||
If you're on Windows, do yourself a favor and use [Windows Terminal](https://github.com/microsoft/terminal) instead of `cmd.exe`. | ||
@@ -323,4 +313,12 @@ | ||
## License | ||
--- | ||
MIT | ||
<div align="center"> | ||
<b> | ||
<a href="https://tidelift.com/subscription/pkg/npm-chalk?utm_source=npm-chalk&utm_medium=referral&utm_campaign=readme">Get professional support for Chalk with a Tidelift subscription</a> | ||
</b> | ||
<br> | ||
<sub> | ||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. | ||
</sub> | ||
</div> |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 1 instance in 1 package
31421
2
9
651
1
2
313
1
+ Addedansi-styles@4.3.0(transitive)
+ Addedcolor-convert@2.0.1(transitive)
+ Addedcolor-name@1.1.4(transitive)
+ Addedhas-flag@4.0.0(transitive)
+ Addedsupports-color@7.2.0(transitive)
- Removedescape-string-regexp@^1.0.5
- Removedansi-styles@3.2.1(transitive)
- Removedcolor-convert@1.9.3(transitive)
- Removedcolor-name@1.1.3(transitive)
- Removedescape-string-regexp@1.0.5(transitive)
- Removedhas-flag@3.0.0(transitive)
- Removedsupports-color@5.5.0(transitive)
Updatedansi-styles@^4.1.0
Updatedsupports-color@^7.1.0