chalk 2.2.2 → 2.4.0

package/index.js

@@ -1,7 +1,7 @@
 'use strict';
 const escapeStringRegexp = require('escape-string-regexp');
 const ansiStyles = require('ansi-styles');
-const supportsColor = require('supports-color');
+const stdoutColor = require('supports-color').stdout;
 
 const template = require('./templates.js');
 
@@ -19,7 +19,7 @@ function applyOptions(obj, options) {
 	options = options || {};
 
 	// Detect level if not set manually
-	const scLevel = supportsColor ? supportsColor.level : 0;
+	const scLevel = stdoutColor ? stdoutColor.level : 0;
 	obj.level = options.level === undefined ? scLevel : options.level;
 	obj.enabled = 'enabled' in options ? options.enabled : obj.level > 0;
 }
@@ -224,5 +224,5 @@ function chalkTag(chalk, strings) {
 Object.defineProperties(Chalk.prototype, styles);
 
 module.exports = Chalk(); // eslint-disable-line new-cap
-module.exports.supportsColor = supportsColor;
+module.exports.supportsColor = stdoutColor;
 module.exports.default = module.exports; // For TypeScript

package/index.js.flow

@@ -0,0 +1,95 @@
+// @flow
+
+type TemplateStringsArray = $ReadOnlyArray<string>;
+
+export type Level = $Values<{
+	None: 0,
+	Basic: 1,
+	Ansi256: 2,
+	TrueColor: 3
+}>;
+
+export type ChalkOptions = {|
+	enabled?: boolean,
+	level?: Level
+|};
+
+export type ColorSupport = {|
+	level: Level,
+	hasBasic: boolean,
+	has256: boolean,
+	has16m: boolean
+|};
+
+export interface Chalk {
+	(...text: string[]): string,
+	(text: TemplateStringsArray, ...placeholders: string[]): string,
+	constructor(options?: ChalkOptions): Chalk,
+	enabled: boolean,
+	level: Level,
+	rgb(r: number, g: number, b: number): Chalk,
+	hsl(h: number, s: number, l: number): Chalk,
+	hsv(h: number, s: number, v: number): Chalk,
+	hwb(h: number, w: number, b: number): Chalk,
+	bgHex(color: string): Chalk,
+	bgKeyword(color: string): Chalk,
+	bgRgb(r: number, g: number, b: number): Chalk,
+	bgHsl(h: number, s: number, l: number): Chalk,
+	bgHsv(h: number, s: number, v: number): Chalk,
+	bgHwb(h: number, w: number, b: number): Chalk,
+	hex(color: string): Chalk,
+	keyword(color: string): Chalk,
+
+	+reset: Chalk,
+	+bold: Chalk,
+	+dim: Chalk,
+	+italic: Chalk,
+	+underline: Chalk,
+	+inverse: Chalk,
+	+hidden: Chalk,
+	+strikethrough: Chalk,
+
+	+visible: Chalk,
+
+	+black: Chalk,
+	+red: Chalk,
+	+green: Chalk,
+	+yellow: Chalk,
+	+blue: Chalk,
+	+magenta: Chalk,
+	+cyan: Chalk,
+	+white: Chalk,
+	+gray: Chalk,
+	+grey: Chalk,
+	+blackBright: Chalk,
+	+redBright: Chalk,
+	+greenBright: Chalk,
+	+yellowBright: Chalk,
+	+blueBright: Chalk,
+	+magentaBright: Chalk,
+	+cyanBright: Chalk,
+	+whiteBright: Chalk,
+
+	+bgBlack: Chalk,
+	+bgRed: Chalk,
+	+bgGreen: Chalk,
+	+bgYellow: Chalk,
+	+bgBlue: Chalk,
+	+bgMagenta: Chalk,
+	+bgCyan: Chalk,
+	+bgWhite: Chalk,
+	+bgBlackBright: Chalk,
+	+bgRedBright: Chalk,
+	+bgGreenBright: Chalk,
+	+bgYellowBright: Chalk,
+	+bgBlueBright: Chalk,
+	+bgMagentaBright: Chalk,
+	+bgCyanBright: Chalk,
+	+bgWhiteBrigh: Chalk,
+
+	supportsColor: ColorSupport
+};
+
+declare var chalk: Chalk;
+
+export default chalk;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "chalk",
-	"version": "2.2.2",
+	"version": "2.4.0",
 	"description": "Terminal string styling done right",
 	"license": "MIT",
 	"repository": "chalk/chalk",
@@ -8,14 +8,15 @@
 		"node": ">=4"
 	},
 	"scripts": {
-		"test": "xo && tsc --project types && nyc ava",
+		"test": "xo && tsc --project types && flow --max-warnings=0 && nyc ava",
 		"bench": "matcha benchmark.js",
 		"coveralls": "nyc report --reporter=text-lcov | coveralls"
 	},
 	"files": [
 		"index.js",
 		"templates.js",
-		"types/index.d.ts"
+		"types/index.d.ts",
+		"index.js.flow"
 	],
 	"keywords": [
 		"color",
@@ -41,14 +42,15 @@
 		"text"
 	],
 	"dependencies": {
-		"ansi-styles": "^3.1.0",
+		"ansi-styles": "^3.2.1",
 		"escape-string-regexp": "^1.0.5",
-		"supports-color": "^4.0.0"
+		"supports-color": "^5.3.0"
 	},
 	"devDependencies": {
 		"ava": "*",
 		"coveralls": "^3.0.0",
-		"execa": "^0.8.0",
+		"execa": "^0.9.0",
+		"flow-bin": "^0.68.0",
 		"import-fresh": "^2.0.0",
 		"matcha": "^0.7.0",
 		"nyc": "^11.0.2",
@@ -61,6 +63,9 @@
 		"envs": [
 			"node",
 			"mocha"
+		],
+		"ignores": [
+			"test/_flow.js"
 		]
 	}
 }

package/readme.md

@@ -9,11 +9,11 @@
 
 > Terminal string styling done right
 
-[![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/sindresorhus/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) [![](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)
 
 ### [See what's new in Chalk 2](https://github.com/chalk/chalk/releases/tag/v2.0.0)
 
-![](https://github.com/chalk/ansi-styles/raw/master/screenshot.png)
+<img src="https://cdn.rawgit.com/chalk/ansi-styles/8261697c95bf34b6c7767e2cbe9941a851d59385/screenshot.svg" alt="" width="900">
 
 
 ## Highlights
@@ -26,7 +26,7 @@
 - Doesn't extend `String.prototype`
 - Clean and focused
 - Actively maintained
-- [Used by ~17,000 packages](https://www.npmjs.com/browse/depended/chalk) as of June 20th, 2017
+- [Used by ~23,000 packages](https://www.npmjs.com/browse/depended/chalk) as of December 31, 2017
 
 
 ## Install
@@ -35,6 +35,10 @@
 $ npm install chalk
 ```
 
+<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
 
@@ -51,7 +55,7 @@ const chalk = require('chalk');
 const log = console.log;
 
 // Combine styled and normal strings
-log(chalk.blue('Hello') + 'World' + chalk.red('!'));
+log(chalk.blue('Hello') + ' World' + chalk.red('!'));
 
 // Compose multiple styles using the chainable API
 log(chalk.blue.bgRed.bold('Hello world!'));
@@ -124,7 +128,7 @@ Multiple arguments will be separated by space.
 
 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.
 
-Chalk is enabled by default unless expicitly disabled via the constructor or `chalk.level` is `0`.
+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:
 
@@ -265,8 +269,8 @@ The following color models can be used:
 - [`hex`](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet) - Example: `chalk.hex('#FF8800').bold('Orange!')`
 - [`keyword`](https://www.w3.org/wiki/CSS/Properties/color/keywords) (CSS keywords) - Example: `chalk.keyword('orange').bold('Orange!')`
 - [`hsl`](https://en.wikipedia.org/wiki/HSL_and_HSV) - Example: `chalk.hsl(32, 100, 50).bold('Orange!')`
-- [`hsv`](https://en.wikipedia.org/wiki/HSL_and_HSV) - Example: `chalk.hsl(32, 1, 1).bold('Orange!')`
-- [`hwb`](https://en.wikipedia.org/wiki/HWB_color_model)  - Example: `chalk.hsl(32, 0, 50).bold('Orange!')`
+- [`hsv`](https://en.wikipedia.org/wiki/HSL_and_HSV) - Example: `chalk.hsv(32, 100, 100).bold('Orange!')`
+- [`hwb`](https://en.wikipedia.org/wiki/HWB_color_model)  - Example: `chalk.hwb(32, 0, 50).bold('Orange!')`
 - `ansi16`
 - `ansi256`
 
@@ -296,6 +300,7 @@ If you're on Windows, do yourself a favor and use [`cmder`](http://cmder.net/) i
 - [chalk-animation](https://github.com/bokub/chalk-animation) - Animate strings in the terminal
 - [gradient-string](https://github.com/bokub/gradient-string) - Apply color gradients to strings
 - [chalk-pipe](https://github.com/LitoMore/chalk-pipe) - Create chalk style schemes with simpler style strings
+- [terminal-link](https://github.com/sindresorhus/terminal-link) - Create clickable links in the terminal
 
 
 ## Maintainers

package/types/index.d.ts

@@ -13,80 +13,85 @@ export interface ChalkOptions {
 	level?: Level;
 }
 
-export interface Chalk {
+export interface ChalkConstructor {
 	new (options?: ChalkOptions): Chalk;
 	(options?: ChalkOptions): Chalk;
+}
+
+export interface ColorSupport {
+	level: Level;
+	hasBasic: boolean;
+	has256: boolean;
+	has16m: boolean;
+}
+
+export interface Chalk {
 	(...text: string[]): string;
 	(text: TemplateStringsArray, ...placeholders: string[]): string;
-	constructor: Chalk;
+	constructor: ChalkConstructor;
 	enabled: boolean;
 	level: Level;
-	supportsColor: {
-		level: Level;
-		hasBasic: boolean;
-		has256: boolean;
-		has16m: boolean;
-	};
-	rgb(r: number, g: number, b: number): Chalk;
-	hsl(h: number, s: number, l: number): Chalk;
-	hsv(h: number, s: number, v: number): Chalk;
-	hwb(h: number, w: number, b: number): Chalk;
-	bgHex(color: string): Chalk;
-	bgKeyword(color: string): Chalk;
-	bgRgb(r: number, g: number, b: number): Chalk;
-	bgHsl(h: number, s: number, l: number): Chalk;
-	bgHsv(h: number, s: number, v: number): Chalk;
-	bgHwb(h: number, w: number, b: number): Chalk;
-	hex(color: string): Chalk;
-	keyword(color: string): Chalk;
+	rgb(r: number, g: number, b: number): this;
+	hsl(h: number, s: number, l: number): this;
+	hsv(h: number, s: number, v: number): this;
+	hwb(h: number, w: number, b: number): this;
+	bgHex(color: string): this;
+	bgKeyword(color: string): this;
+	bgRgb(r: number, g: number, b: number): this;
+	bgHsl(h: number, s: number, l: number): this;
+	bgHsv(h: number, s: number, v: number): this;
+	bgHwb(h: number, w: number, b: number): this;
+	hex(color: string): this;
+	keyword(color: string): this;
 
-	reset: Chalk;
-	bold: Chalk;
-	dim: Chalk;
-	italic: Chalk;
-	underline: Chalk;
-	inverse: Chalk;
-	hidden: Chalk;
-	strikethrough: Chalk;
+	readonly reset: this;
+	readonly bold: this;
+	readonly dim: this;
+	readonly italic: this;
+	readonly underline: this;
+	readonly inverse: this;
+	readonly hidden: this;
+	readonly strikethrough: this;
 
-	visible: Chalk;
+	readonly visible: this;
 
-	black: Chalk;
-	red: Chalk;
-	green: Chalk;
-	yellow: Chalk;
-	blue: Chalk;
-	magenta: Chalk;
-	cyan: Chalk;
-	white: Chalk;
-	gray: Chalk;
-	grey: Chalk;
-	blackBright: Chalk;
-	redBright: Chalk;
-	greenBright: Chalk;
-	yellowBright: Chalk;
-	blueBright: Chalk;
-	magentaBright: Chalk;
-	cyanBright: Chalk;
-	whiteBright: Chalk;
+	readonly black: this;
+	readonly red: this;
+	readonly green: this;
+	readonly yellow: this;
+	readonly blue: this;
+	readonly magenta: this;
+	readonly cyan: this;
+	readonly white: this;
+	readonly gray: this;
+	readonly grey: this;
+	readonly blackBright: this;
+	readonly redBright: this;
+	readonly greenBright: this;
+	readonly yellowBright: this;
+	readonly blueBright: this;
+	readonly magentaBright: this;
+	readonly cyanBright: this;
+	readonly whiteBright: this;
 
-	bgBlack: Chalk;
-	bgRed: Chalk;
-	bgGreen: Chalk;
-	bgYellow: Chalk;
-	bgBlue: Chalk;
-	bgMagenta: Chalk;
-	bgCyan: Chalk;
-	bgWhite: Chalk;
-	bgBlackBright: Chalk;
-	bgRedBright: Chalk;
-	bgGreenBright: Chalk;
-	bgYellowBright: Chalk;
-	bgBlueBright: Chalk;
-	bgMagentaBright: Chalk;
-	bgCyanBright: Chalk;
-	bgWhiteBright: Chalk;
+	readonly bgBlack: this;
+	readonly bgRed: this;
+	readonly bgGreen: this;
+	readonly bgYellow: this;
+	readonly bgBlue: this;
+	readonly bgMagenta: this;
+	readonly bgCyan: this;
+	readonly bgWhite: this;
+	readonly bgBlackBright: this;
+	readonly bgRedBright: this;
+	readonly bgGreenBright: this;
+	readonly bgYellowBright: this;
+	readonly bgBlueBright: this;
+	readonly bgMagentaBright: this;
+	readonly bgCyanBright: this;
+	readonly bgWhiteBright: this;
 }
 
-declare function chalk (): any;
-export default chalk as Chalk;
+declare const chalk: Chalk & { supportsColor: ColorSupport };
+
+export default chalk