chalk-template 0.2.0 → 0.4.0

package/index.d.ts

@@ -21,3 +21,15 @@ 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.
+
+@example
+```
+import { template } from 'chalk-template';
+
+log(template('Today is {red hot}')
+```
+*/
+export function template(text: string): string;

package/index.js

@@ -1,8 +1,8 @@
 import chalk 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;
-const STYLE_REGEX = /(?:^|\.)(\w+)(?:\(([^)]*)\))?/g;
+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;
+const STYLE_REGEX = /(?:^|\.)(?:(?:(\w+)(?:\(([^)]*)\))?)|(?:#(?=[:a-fA-F\d]{2,})([a-fA-F\d]{6})?(?::([a-fA-F\d]{6}))?))/g;
 const STRING_REGEX = /^(['"])((?:\\.|(?!\1)[^\\])*)\1$/;
 const ESCAPE_REGEX = /\\(u(?:[a-f\d]{4}|{[a-f\d]{1,6}})|x[a-f\d]{2}|.)|([^\\])/gi;
 
@@ -53,6 +53,18 @@ function parseArguments(name, arguments_) {
 	return results;
 }
 
+function parseHex(hex) {
+	const n = Number.parseInt(hex, 16);
+	return [
+		// eslint-disable-next-line no-bitwise
+		(n >> 16) & 0xFF,
+		// eslint-disable-next-line no-bitwise
+		(n >> 8) & 0xFF,
+		// eslint-disable-next-line no-bitwise
+		n & 0xFF,
+	];
+}
+
 function parseStyle(style) {
 	STYLE_REGEX.lastIndex = 0;
 
@@ -64,6 +76,14 @@ function parseStyle(style) {
 
 		if (matches[2]) {
 			results.push([name, ...parseArguments(name, matches[2])]);
+		} else if (matches[3] || matches[4]) {
+			if (matches[3]) {
+				results.push(['rgb', ...parseHex(matches[3])]);
+			}
+
+			if (matches[4]) {
+				results.push(['bgRgb', ...parseHex(matches[4])]);
+			}
 		} else {
 			results.push([name]);
 		}
@@ -97,7 +117,7 @@ function buildStyle(styles) {
 	return current;
 }
 
-function template(string) {
+export function template(string) {
 	const styles = [];
 	const chunks = [];
 	let chunk = [];
@@ -141,7 +161,7 @@ export default function chalkTemplate(firstString, ...arguments_) {
 
 	const parts = [firstString.raw[0]];
 
-	for (let index = 1; index < firstString.length; index++) {
+	for (let index = 1; index < firstString.raw.length; index++) {
 		parts.push(
 			String(arguments_[index - 1]).replace(/[{}\\]/g, '\\$&'),
 			String(firstString.raw[index]),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "chalk-template",
-	"version": "0.2.0",
+	"version": "0.4.0",
 	"description": "Terminal string styling with tagged template literals",
 	"license": "MIT",
 	"repository": "chalk/chalk-template",
@@ -11,7 +11,7 @@
 		"node": ">=12"
 	},
 	"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 && tsd"
+		"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"
 	},
 	"files": [
 		"index.js",
@@ -49,6 +49,7 @@
 		"ava": "^3.15.0",
 		"cross-env": "^7.0.3",
 		"tsd": "^0.18.0",
+		"typescript": "^4.6.2",
 		"xo": "^0.45.0"
 	}
 }

package/readme.md

@@ -31,6 +31,13 @@ console.log(chalk`
 	There are {bold 5280 feet} in a mile.
 	In {bold ${miles} miles}, there are {green.bold ${calculateFeet(miles)} feet}.
 `);
+
+
+console.log(chalk`
+	There are also {#FF0000 shorthand hex styles} for
+	both the {#ABCDEF foreground}, {#:123456 background},
+	or {#ABCDEF:123456 both}.
+`);
 ```
 
 ## API
@@ -47,10 +54,20 @@ console.log(chalk.bold.rgb(10, 100, 200)('Hello!'));
 console.log(chalkTemplate`{bold.rgb(10,100,200) Hello!}`);
 ```
 
-Note that function styles (`rgb()`, `hex()`, etc.) may not contain spaces between parameters.
+Note that function styles (`rgb()`, etc.) may not contain spaces between parameters.
 
 All interpolated values (`` chalkTemplate`${foo}` ``) are converted to strings via the `.toString()` method. All curly braces (`{` and `}`) in interpolated value strings are escaped.
 
+## Template function
+
+You may also use the template function as an alternative to the tagged template function.
+
+```js
+import {template} from 'chalk-template';
+
+console.log(template('Today is {red hot}'));
+```
+
 ## Related
 
 - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right