chalk · Sep 14, 2021 · Sep 16, 2021 · Sep 17, 2021 · Sep 22, 2021 · Sep 26, 2021
Showing with 150 additions and 75 deletions.

+2 −0 .replit

+88 −61 cli.js

+1 −1 package.json

+3 −3 readme.md

+39 −10 test.js

+17 −0 test.js.md

BIN test.js.snap
diff --git a/.replit b/.replit
@@ -0,0 +1,2 @@
+language = "nodejs"
+run = "node cli.js --help && node cli.js --demo"
diff --git a/cli.js b/cli.js
@@ -7,56 +7,71 @@ import getStdin from 'get-stdin';
 import meow from 'meow';
 
 const printAllStyles = () => {
-	const styles = [
-		'bold',
-		'dim',
-		'italic',
-		'underline',
-		'inverse',
-		'strikethrough',
-		'black',
-		'red',
-		'green',
-		'yellow',
-		'blue',
-		'magenta',
-		'cyan',
-		'white',
-		'gray',
-		'bgBlack',
-		'bgRed',
-		'bgGreen',
-		'bgYellow',
-		'bgBlue',
-		'bgMagenta',
-		'bgCyan',
-		'bgWhite',
-	];
-
-	console.log(styles.map(style => chalk[style](style)).join(' '));
+	const textStyles = ['bold', 'dim', 'italic', 'underline', 'strikethrough'];
+	const colorStyles = ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'gray'];
+	const brightColorStyles = ['blackBright', 'redBright', 'greenBright', 'yellowBright', 'blueBright', 'magentaBright', 'cyanBright', 'whiteBright'];
+	const bgColorStyles = ['bgBlack', 'bgRed', 'bgGreen', 'bgYellow', 'bgBlue', 'bgMagenta', 'bgCyan', 'bgWhite', 'bgGray'];
+	const bgBrightColorStyles = ['bgBlackBright', 'bgRedBright', 'bgGreenBright', 'bgYellowBright', 'bgBlueBright', 'bgMagentaBright', 'bgCyanBright', 'bgWhiteBright'];
+
+	function styled(style, text) {
+		if (/^bg[^B]/.test(style)) {
+			text = chalk.black(text);
+		}
+
+		return chalk[style](text);
+	}
+
+	function showStyles(stylesArray) {
+		const output = stylesArray.map(style => styled(style, style)).join(' ');
+		console.log(output);
+	}
+
+	console.log('Available styles:\n');
+	showStyles(textStyles);
+	showStyles(colorStyles);
+	showStyles(brightColorStyles);
+	showStyles(bgColorStyles);
+	showStyles(bgBrightColorStyles);
 };
 
 const cli = meow(`
-	Usage
-	  $ chalk <style> … <string>
-	  $ echo <string> | chalk --stdin <style> …
+	${chalk.greenBright.inverse(' Usage ')}
+
+	  $ ${chalk.green('chalk')} ${chalk.yellow('[options…]')} ${chalk.cyan('<style> … <string>')}
+	  $ ${chalk.green('echo')} ${chalk.cyan('<string>')} | ${chalk.green('chalk')} ${chalk.yellow('--stdin [options…]')} ${chalk.cyan('<style> …')}
 
-	Options
-	  --template, -t    Style template. The \`~\` character negates the style.
-	  --stdin           Read input from stdin rather than from arguments.
-	  --no-newline, -n  Don't emit a newline (\`\\n\`) after the input.
-	  --demo            Demo of all Chalk styles.
+	${chalk.yellowBright.inverse(' Options ')}
+
+	  ${chalk.yellow('--template, -t')}    Style template. The \`~\` character negates the style.
+	  ${chalk.yellow('--stdin')}           Read input from stdin rather than from arguments.
+	  ${chalk.yellow('--no-newline, -n')}  Don't emit a newline (\`\\n\`) after the input.
+	  ${chalk.yellow('--demo')}            Demo of all Chalk styles.
+
+	${chalk.redBright.inverse(' Examples ')}
 
-	Examples
 	  $ chalk red bold 'Unicorns & Rainbows'
+	  ${chalk.red.bold('Unicorns & Rainbows')}
+
 	  $ chalk -t '{red.bold Unicorns & Rainbows}'
+	  ${chalk.red.bold('Unicorns & Rainbows')}
+
 	  $ chalk -t '{red.bold Dungeons and Dragons {~bold.blue (with added fairies)}}'
+	  ${chalk`{red.bold Dungeons and Dragons {~bold.blue (with added fairies)}}`}
+
 	  $ echo 'Unicorns from stdin' | chalk --stdin red bold
+	  ${chalk.red.bold('Unicorns from stdin')}
 `, {
 	importMeta: import.meta,
-	// TODO: Disabled until https://github.com/sindresorhus/meow/issues/197 is fixed.
-	// allowUnknownFlags: false,
+	allowUnknownFlags: false,
 	flags: {
+		// TODO: Can be removed when https://github.com/sindresorhus/meow/issues/197 is fixed.
+		help: {
+			type: 'boolean',
+		},
+		version: {
+			type: 'boolean',
+		},
+
 		template: {
 			type: 'string',
 			alias: 't',
@@ -76,10 +91,29 @@ const cli = meow(`
 
 const styles = cli.input;
 
+function handleTemplateFlag(template) {
+	if (cli.input.length > 0) {
+		console.error('The --template option only accepts 1 argument');
+		process.exitCode = 1;
+		return;
+	}
+
+	try {
+		const tagArray = [template];
+		tagArray.raw = tagArray;
+		console.log(chalk(tagArray));
+	} catch (error) {
+		console.error('Something went wrong! Maybe review your syntax?\n');
+		console.error(error.stack);
+		process.exitCode = 1;
+	}
+}
+
 function init(data) {
 	for (const style of styles) {
 		if (!Object.keys(ansiStyles).includes(style)) {
-			console.error(`Invalid style: ${style}`);
+			console.error(chalk`{red Invalid style: {bold ${style}}}\n`);
+			printAllStyles();
 			process.exit(1);
 		}
 	}
@@ -108,35 +142,28 @@ function init(data) {
 function processDataFromArgs() {
 	if (cli.flags.demo) {
 		printAllStyles();
-	} else if (cli.flags.template) {
-		if (cli.input.length === 0) {
-			try {
-				const tagArray = [cli.flags.template];
-				tagArray.raw = tagArray;
-				console.log(chalk(tagArray));
-			} catch (error) {
-				console.error('Something went wrong! Maybe review your syntax?\n');
-				console.error(error.stack);
-				process.exit(1);
-			}
-		} else {
-			console.error('The --template option only accepts 1 argument');
-			process.exit(1);
-		}
-	} else {
-		if (styles.length < 2) {
-			console.error('Input required');
-			process.exit(1);
-		}
+		return;
+	}
 
-		init(styles.pop());
+	if (cli.flags.template) {
+		handleTemplateFlag(cli.flags.template);
+		return;
 	}
+
+	if (styles.length < 2) {
+		console.error('Input required');
+		process.exitCode = 1;
+		return;
+	}
+
+	init(styles.pop());
 }
 
 async function processDataFromStdin() {
 	if (styles.length === 0) {
 		console.error('Input required');
-		process.exit(1);
+		process.exitCode = 1;
+		return;
 	}
 
 	init(await getStdin());

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "chalk-cli",
-	"version": "5.0.0",
+	"version": "5.0.1",
 	"description": "Terminal string styling done right",
 	"license": "MIT",
 	"repository": "github:chalk/chalk-cli",

diff --git a/readme.md b/readme.md
@@ -1,13 +1,13 @@
-# chalk-cli
+# chalk-cli [![Downloads](https://badgen.net/npm/dt/chalk-cli)](https://www.npmjs.com/package/chalk-cli) [![run on repl.it](https://repl.it/badge/github/chalk/chalk-cli)](https://repl.it/github/chalk/chalk-cli)
 
 > Terminal string styling done right
 
 <img src="screenshot.png" width="631">
 
 ## Install
 
-```
-$ npm install --global chalk-cli
+```sh
+npm install --global chalk-cli
 ```
 
 ## Usage

diff --git a/test.js b/test.js
@@ -4,21 +4,35 @@ import execa from 'execa';
 
 chalk.level = 1;
 
-const macro = async (t, {args, opts}, expected) => {
-	const {stdout} = await execa('./cli.js', args, opts);
+const macro = async (t, {arguments: arguments_, options}, expected) => {
+	const {stdout} = await execa('./cli.js', arguments_, options);
 	t.is(stdout, expected);
 };
 
+const snapshotMacro = async (t, {arguments: arguments_, options}) => {
+	const {stdout} = await execa('./cli.js', arguments_, options);
+	t.snapshot(stdout);
+};
+
 const templateMacro = (t, input, expected) =>
-	macro(t, {args: ['--template', input, '--no-stdin']}, expected);
+	macro(t, {arguments: ['--template', input, '--no-stdin']}, expected);
+
+test('help',
+	async (t, {arguments: arguments_, options}, expectedRegex) => {
+		const {stdout} = await execa('./cli.js', arguments_, options);
+		t.regex(stdout, expectedRegex);
+	},
+	{arguments: ['--help']},
+	/Terminal string styling done right/,
+);
 
-test('main', macro, {args: ['red', 'bold', 'unicorn', '--no-stdin']},
+test('main', macro, {arguments: ['red', 'bold', 'unicorn', '--no-stdin']},
 	chalk.red.bold('unicorn'));
-test('default to args; not stdin (#11)', macro, {args: ['red', 'bold', 'unicorn'], opts: {input: ''}},
+test('default to args; not stdin (#11)', macro, {arguments: ['red', 'bold', 'unicorn'], options: {input: ''}},
 	chalk.red.bold('unicorn'));
-test('stdin', macro, {args: ['red', 'bold', '--stdin'], opts: {input: 'unicorn'}},
+test('stdin', macro, {arguments: ['red', 'bold', '--stdin'], options: {input: 'unicorn'}},
 	chalk.red.bold('unicorn'));
-test('number', macro, {args: ['red', 'bold', '123', '--no-stdin']},
+test('number', macro, {arguments: ['red', 'bold', '123', '--no-stdin']},
 	chalk.red.bold('123'));
 
 test('template', templateMacro, '{red.bold unicorn}',
@@ -36,11 +50,26 @@ test('template escaping #2', templateMacro, '{red hey\\\\} not red',
 	chalk.red('hey\\') + ' not red');
 
 test('without -n, output has trailing newline', macro,
-	{args: ['red', 'bold', 'unicorn'], opts: {stripFinalNewline: false}},
+	{arguments: ['red', 'bold', 'unicorn'], options: {stripFinalNewline: false}},
 	chalk.red.bold('unicorn') + '\n');
 test('with -n, output has NO trailing newline', macro,
-	{args: ['-n', 'red', 'bold', 'unicorn'], opts: {stripFinalNewline: false}},
+	{arguments: ['-n', 'red', 'bold', 'unicorn'], options: {stripFinalNewline: false}},
 	chalk.red.bold('unicorn') /* No trailing newline */);
 test('with --no-newline, output has NO trailing newline', macro,
-	{args: ['--no-newline', 'red', 'bold', 'unicorn'], opts: {stripFinalNewline: false}},
+	{arguments: ['--no-newline', 'red', 'bold', 'unicorn'], options: {stripFinalNewline: false}},
 	chalk.red.bold('unicorn') /* No trailing newline */);
+
+test('demo', snapshotMacro, {arguments: ['--demo']});
+
+test('unknown flag',
+	async (t, {arguments: arguments_, options}, expectedRegex) => {
+		try {
+			await execa('./cli.js', arguments_, options);
+		} catch (error) {
+			t.is(error.exitCode, 2);
+			t.regex(error.toString(), expectedRegex);
+		}
+	},
+	{arguments: ['--this-is-not-a-supported-flag'], options: {input: 'unicorn'}},
+	/Unknown flag/,
+);
diff --git a/test.js.md b/test.js.md
@@ -0,0 +1,17 @@
+# Snapshot report for `test.js`
+
+The actual snapshot is saved in `test.js.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## demo
+
+> Snapshot 1
+
+    `Available styles:␊
+    ␊
+    [1mbold[22m [2mdim[22m [3mitalic[23m [4munderline[24m [9mstrikethrough[29m␊
+    [30mblack[39m [31mred[39m [32mgreen[39m [33myellow[39m [34mblue[39m [35mmagenta[39m [36mcyan[39m [37mwhite[39m [90mgray[39m␊
+    [90mblackBright[39m [91mredBright[39m [92mgreenBright[39m [93myellowBright[39m [94mblueBright[39m [95mmagentaBright[39m [96mcyanBright[39m [97mwhiteBright[39m␊
+    [40mbgBlack[49m [41m[30mbgRed[39m[49m [42m[30mbgGreen[39m[49m [43m[30mbgYellow[39m[49m [44mbgBlue[49m [45m[30mbgMagenta[39m[49m [46m[30mbgCyan[39m[49m [47m[30mbgWhite[39m[49m [100m[30mbgGray[39m[49m␊
+    [100mbgBlackBright[49m [101m[30mbgRedBright[39m[49m [102m[30mbgGreenBright[39m[49m [103m[30mbgYellowBright[39m[49m [104mbgBlueBright[49m [105m[30mbgMagentaBright[39m[49m [106m[30mbgCyanBright[39m[49m [107m[30mbgWhiteBright[39m[49m`
diff --git a/test.js.snap b/test.js.snap
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		language = "nodejs"
		run = "node cli.js --help && node cli.js --demo"