chalk-template 0.5.0 → 1.1.0

package/index.d.ts

@@ -1,3 +1,5 @@
+import type {ChalkInstance} from 'chalk';
+
 /**
 Terminal string styling with [tagged template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates)
 
@@ -78,3 +80,38 @@ console.log(template('Today is {red hot}'));
 ```
 */
 export function templateStderr(text: string): string;
+
+/**
+Terminal string styling, using a custom Chalk instance.
+
+This function can be useful if you need to create a template function using your own Chalk instance.
+
+__Note:__ It's up to you to properly escape the input.
+
+@example
+```
+import {Chalk} from 'chalk'
+import {makeTemplate} from 'chalk-template';
+
+const template = makeTemplate(new Chalk());
+
+console.log(template('Today is {red hot}''));
+```
+*/
+export function makeTemplate(chalk: ChalkInstance): (text: string) => string;
+
+/**
+Terminal string styling with [tagged template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#tagged_templates),
+configured using a custom Chalk instance.
+
+@example
+```
+import {Chalk} from 'chalk'
+import {makeTaggedTemplate} from 'chalk-template';
+
+const chalkTemplate = makeTaggedTemplate(new Chalk());
+
+console.log(chalkTemplate`Today is {red hot}`);
+```
+*/
+export function makeTaggedTemplate(chalk: ChalkInstance): (text: TemplateStringsArray, ...placeholders: unknown[]) => string;

package/index.js

@@ -1,6 +1,6 @@
-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;
 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$/;
@@ -92,7 +92,7 @@ function parseStyle(style) {
 	return results;
 }
 
-function makeTemplate(chalk) {
+export function makeTemplate(chalk) {
 	function buildStyle(styles) {
 		const enabled = {};
 
@@ -179,8 +179,10 @@ function makeChalkTemplate(template) {
 	return chalkTemplate;
 }
 
+export const makeTaggedTemplate = chalkInstance => makeChalkTemplate(makeTemplate(chalkInstance));
+
 export const template = makeTemplate(chalk);
 export default makeChalkTemplate(template);
 
-export const templateStderr = makeTemplate(chalk.stderr);
+export const templateStderr = makeTemplate(chalkStderr);
 export const chalkTemplateStderr = makeChalkTemplate(templateStderr);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "chalk-template",
-	"version": "0.5.0",
+	"version": "1.1.0",
 	"description": "Terminal string styling with tagged template literals",
 	"license": "MIT",
 	"repository": "chalk/chalk-template",
@@ -46,12 +46,12 @@
 		"text"
 	],
 	"dependencies": {
-		"chalk": "^4.1.2"
+		"chalk": "^5.2.0"
 	},
 	"devDependencies": {
-		"ava": "^5.1.0",
+		"ava": "^5.2.0",
 		"cross-env": "^7.0.3",
-		"tsd": "^0.25.0",
-		"xo": "^0.53.1"
+		"tsd": "^0.28.1",
+		"xo": "^0.54.2"
 	}
 }

package/readme.md

@@ -87,6 +87,23 @@ import {templateStderr} from 'chalk-template';
 console.error(templateStderr('Today is {red hot}'));
 ```
 
+## Create template functions using a custom Chalk instance
+
+The `makeTemplate` and `makeTaggedTemplate` functions are exported so functions can be created using a custom Chalk instance.
+
+**Note:** When using a function created with `makeTemplate`, it's up to you to properly escape the input.
+
+```js
+import {Chalk} from 'chalk'
+import {makeTemplate, makeTaggedTemplate} from 'chalk-template';
+
+const template = makeTemplate(new Chalk({level: 3}));
+const chalkTemplate = makeTaggedTemplate(new Chalk({level: 3}));
+
+console.log(template('Today is {red hot}'));
+console.log(chalkTemplate`Today is {red hot}`);
+```
+
 ## Related
 
 - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right