chalk-template 0.3.1 → 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

@@ -117,7 +117,7 @@ function buildStyle(styles) {
 	return current;
 }
 
-function template(string) {
+export function template(string) {
 	const styles = [];
 	const chunks = [];
 	let chunk = [];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "chalk-template",
-	"version": "0.3.1",
+	"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

@@ -58,6 +58,16 @@ Note that function styles (`rgb()`, etc.) may not contain spaces between paramet
 
 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