chalk-template 0.4.0 → 1.0.0

package/index.d.ts

@@ -5,7 +5,7 @@ Terminal string styling with [tagged template literals](https://developer.mozill
 ```
 import chalkTemplate from 'chalk-template';
 
-log(chalkTemplate`
+console.log(chalkTemplate`
 CPU: {red ${cpu.totalPercent}%}
 RAM: {green ${ram.used / ram.total * 100}%}
 DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
@@ -17,19 +17,64 @@ DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
 import chalkTemplate from 'chalk-template';
 import chalk from 'chalk';
 
-log(chalk.red.bgBlack(chalkTemplate`2 + 3 = {bold ${2 + 3}}`));
+console.log(chalk.red.bgBlack(chalkTemplate`2 + 3 = {bold ${2 + 3}}`));
 ```
 */
 export default function chalkTemplate(text: TemplateStringsArray, ...placeholders: unknown[]): string;
 
 /**
-Terminal string styling. It is preferred that you use the template tag (default export) but this function is useful if you'd like to wrap the color template function.
+Terminal string styling with [tagged template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates),
+configured for standard error instead of standard output
 
 @example
 ```
-import { template } from 'chalk-template';
+import {chalkTemplateStderr as chalkTemplate} from 'chalk-template';
 
-log(template('Today is {red hot}')
+console.log(chalkTemplate`
+CPU: {red ${cpu.totalPercent}%}
+RAM: {green ${ram.used / ram.total * 100}%}
+DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
+`);
+```
+
+@example
+```
+import {chalkTemplateStderr as chalkTemplate} from 'chalk-template';
+import {chalkStderr as chalk} from 'chalk';
+
+console.log(chalk.red.bgBlack(chalkTemplate`2 + 3 = {bold ${2 + 3}}`));
+```
+*/
+export function chalkTemplateStderr(text: TemplateStringsArray, ...placeholders: unknown[]): string;
+
+/**
+Terminal string styling.
+
+This function can be useful if you need to wrap the template function. However, prefer the default export whenever possible.
+
+__Note:__ It's up to you to properly escape the input.
+
+@example
+```
+import {template} from 'chalk-template';
+
+console.log(template('Today is {red hot}'));
 ```
 */
 export function template(text: string): string;
+
+/**
+Terminal string styling, configured for stderr.
+
+This function can be useful if you need to wrap the template function. However, prefer the `chalkTemplateStderr` export whenever possible.
+
+__Note:__ It's up to you to properly escape the input.
+
+@example
+```
+import {templateStderr as template} from 'chalk-template';
+
+console.log(template('Today is {red hot}'));
+```
+*/
+export function templateStderr(text: string): string;

package/index.js

@@ -1,4 +1,5 @@
-import chalk from 'chalk';
+// eslint-disable-next-line unicorn/import-style
+import chalk, {chalkStderr} from 'chalk';
 
 // eslint-disable-next-line unicorn/better-regex
 const TEMPLATE_REGEX = /(?:\\(u(?:[a-f\d]{4}|{[a-f\d]{1,6}})|x[a-f\d]{2}|.))|(?:{(~)?(#?[\w:]+(?:\([^)]*\))?(?:\.#?[\w:]+(?:\([^)]*\))?)*)(?:[ \t]|(?=\r?\n)))|(})|((?:.|[\r\n\f])+?)/gi;
@@ -24,7 +25,7 @@ function unescape(c) {
 	const bracket = c[1] === '{';
 
 	if ((u && !bracket && c.length === 5) || (c[0] === 'x' && c.length === 3)) {
-		return String.fromCharCode(Number.parseInt(c.slice(1), 16));
+		return String.fromCodePoint(Number.parseInt(c.slice(1), 16));
 	}
 
 	if (u && bracket) {
@@ -92,81 +93,95 @@ function parseStyle(style) {
 	return results;
 }
 
-function buildStyle(styles) {
-	const enabled = {};
+function makeTemplate(chalk) {
+	function buildStyle(styles) {
+		const enabled = {};
 
-	for (const layer of styles) {
-		for (const style of layer.styles) {
-			enabled[style[0]] = layer.inverse ? null : style.slice(1);
+		for (const layer of styles) {
+			for (const style of layer.styles) {
+				enabled[style[0]] = layer.inverse ? null : style.slice(1);
+			}
 		}
-	}
 
-	let current = chalk;
-	for (const [styleName, styles] of Object.entries(enabled)) {
-		if (!Array.isArray(styles)) {
-			continue;
-		}
+		let current = chalk;
+		for (const [styleName, styles] of Object.entries(enabled)) {
+			if (!Array.isArray(styles)) {
+				continue;
+			}
 
-		if (!(styleName in current)) {
-			throw new Error(`Unknown Chalk style: ${styleName}`);
+			if (!(styleName in current)) {
+				throw new Error(`Unknown Chalk style: ${styleName}`);
+			}
+
+			current = styles.length > 0 ? current[styleName](...styles) : current[styleName];
 		}
 
-		current = styles.length > 0 ? current[styleName](...styles) : current[styleName];
+		return current;
 	}
 
-	return current;
-}
-
-export function template(string) {
-	const styles = [];
-	const chunks = [];
-	let chunk = [];
-
-	// eslint-disable-next-line max-params
-	string.replace(TEMPLATE_REGEX, (_, escapeCharacter, inverse, style, close, character) => {
-		if (escapeCharacter) {
-			chunk.push(unescape(escapeCharacter));
-		} else if (style) {
-			const string = chunk.join('');
-			chunk = [];
-			chunks.push(styles.length === 0 ? string : buildStyle(styles)(string));
-			styles.push({inverse, styles: parseStyle(style)});
-		} else if (close) {
-			if (styles.length === 0) {
-				throw new Error('Found extraneous } in Chalk template literal');
+	function template(string) {
+		const styles = [];
+		const chunks = [];
+		let chunk = [];
+
+		// eslint-disable-next-line max-params
+		string.replace(TEMPLATE_REGEX, (_, escapeCharacter, inverse, style, close, character) => {
+			if (escapeCharacter) {
+				chunk.push(unescape(escapeCharacter));
+			} else if (style) {
+				const string = chunk.join('');
+				chunk = [];
+				chunks.push(styles.length === 0 ? string : buildStyle(styles)(string));
+				styles.push({inverse, styles: parseStyle(style)});
+			} else if (close) {
+				if (styles.length === 0) {
+					throw new Error('Found extraneous } in Chalk template literal');
+				}
+
+				chunks.push(buildStyle(styles)(chunk.join('')));
+				chunk = [];
+				styles.pop();
+			} else {
+				chunk.push(character);
 			}
+		});
 
-			chunks.push(buildStyle(styles)(chunk.join('')));
-			chunk = [];
-			styles.pop();
-		} else {
-			chunk.push(character);
-		}
-	});
+		chunks.push(chunk.join(''));
 
-	chunks.push(chunk.join(''));
+		if (styles.length > 0) {
+			throw new Error(`Chalk template literal is missing ${styles.length} closing bracket${styles.length === 1 ? '' : 's'} (\`}\`)`);
+		}
 
-	if (styles.length > 0) {
-		throw new Error(`Chalk template literal is missing ${styles.length} closing bracket${styles.length === 1 ? '' : 's'} (\`}\`)`);
+		return chunks.join('');
 	}
 
-	return chunks.join('');
+	return template;
 }
 
-export default function chalkTemplate(firstString, ...arguments_) {
-	if (!Array.isArray(firstString) || !Array.isArray(firstString.raw)) {
-		// If chalkTemplate() was called by itself or with a string
-		throw new TypeError('A tagged template literal must be provided');
-	}
+function makeChalkTemplate(template) {
+	function chalkTemplate(firstString, ...arguments_) {
+		if (!Array.isArray(firstString) || !Array.isArray(firstString.raw)) {
+			// If chalkTemplate() was called by itself or with a string
+			throw new TypeError('A tagged template literal must be provided');
+		}
 
-	const parts = [firstString.raw[0]];
+		const parts = [firstString.raw[0]];
 
-	for (let index = 1; index < firstString.raw.length; index++) {
-		parts.push(
-			String(arguments_[index - 1]).replace(/[{}\\]/g, '\\$&'),
-			String(firstString.raw[index]),
-		);
+		for (let index = 1; index < firstString.raw.length; index++) {
+			parts.push(
+				String(arguments_[index - 1]).replace(/[{}\\]/g, '\\$&'),
+				String(firstString.raw[index]),
+			);
+		}
+
+		return template(parts.join(''));
 	}
 
-	return template(parts.join(''));
+	return chalkTemplate;
 }
+
+export const template = makeTemplate(chalk);
+export default makeChalkTemplate(template);
+
+export const templateStderr = makeTemplate(chalkStderr);
+export const chalkTemplateStderr = makeChalkTemplate(templateStderr);

package/package.json

@@ -1,14 +1,17 @@
 {
 	"name": "chalk-template",
-	"version": "0.4.0",
+	"version": "1.0.0",
 	"description": "Terminal string styling with tagged template literals",
 	"license": "MIT",
 	"repository": "chalk/chalk-template",
 	"funding": "https://github.com/chalk/chalk-template?sponsor=1",
 	"type": "module",
-	"exports": "./index.js",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
 	"engines": {
-		"node": ">=12"
+		"node": ">=14.16"
 	},
 	"scripts": {
 		"test": "xo && ava test/index.js && cross-env FORCE_COLOR=0 ava test/no-color.js && cross-env FORCE_COLOR=3 TERM=dumb ava test/full-color.js && cross-env FORCE_COLOR=3 TERM=dumb ava test/template.js && tsd"
@@ -43,13 +46,12 @@
 		"text"
 	],
 	"dependencies": {
-		"chalk": "^4.1.2"
+		"chalk": "^5.2.0"
 	},
 	"devDependencies": {
-		"ava": "^3.15.0",
+		"ava": "^5.2.0",
 		"cross-env": "^7.0.3",
-		"tsd": "^0.18.0",
-		"typescript": "^4.6.2",
-		"xo": "^0.45.0"
+		"tsd": "^0.27.0",
+		"xo": "^0.53.1"
 	}
 }

package/readme.md

@@ -10,36 +10,47 @@ npm install chalk-template
 
 ## Usage
 
+For printing to standard output (stdout):
+
 ```js
 import chalkTemplate from 'chalk-template';
 import chalk from 'chalk';
 
-const log = console.log;
-
-log(chalkTemplate`
+console.log(chalkTemplate`
 CPU: {red ${cpu.totalPercent}%}
 RAM: {green ${ram.used / ram.total * 100}%}
 DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
 `);
 
-log(chalk.red.bgBlack(chalkTemplate`2 + 3 = {bold ${2 + 3}}`));
+console.log(chalk.red.bgBlack(chalkTemplate`2 + 3 = {bold ${2 + 3}}`));
 
 const miles = 18;
 const calculateFeet = miles => miles * 5280;
 
-console.log(chalk`
+console.log(chalkTemplate`
 	There are {bold 5280 feet} in a mile.
 	In {bold ${miles} miles}, there are {green.bold ${calculateFeet(miles)} feet}.
 `);
 
-
-console.log(chalk`
+console.log(chalkTemplate`
 	There are also {#FF0000 shorthand hex styles} for
 	both the {#ABCDEF foreground}, {#:123456 background},
 	or {#ABCDEF:123456 both}.
 `);
 ```
 
+For printing to standard error (stderr):
+
+```js
+import {chalkTemplateStderr} from 'chalk-template';
+
+console.error(chalkTemplateStderr`
+CPU: {red ${cpu.totalPercent}%}
+RAM: {green ${ram.used / ram.total * 100}%}
+DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
+`);
+```
+
 ## API
 
 Blocks are delimited by an opening curly brace (`{`), a style, some content, and a closing curly brace (`}`).
@@ -60,7 +71,9 @@ All interpolated values (`` chalkTemplate`${foo}` ``) are converted to strings v
 
 ## Template function
 
-You may also use the template function as an alternative to the tagged template function.
+This function can be useful if you need to wrap the template function. However, prefer the default export whenever possible.
+
+**Note:** It's up to you to properly escape the input.
 
 ```js
 import {template} from 'chalk-template';
@@ -68,6 +81,12 @@ import {template} from 'chalk-template';
 console.log(template('Today is {red hot}'));
 ```
 
+```js
+import {templateStderr} from 'chalk-template';
+
+console.error(templateStderr('Today is {red hot}'));
+```
+
 ## Related
 
 - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right