tickplate 1.0.9 → 1.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2025 Metarhia contributors
+Copyright (c) 2017-2026 Metarhia contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -6,13 +6,19 @@
 [![npm downloads/month](https://img.shields.io/npm/dm/tickplate.svg)](https://www.npmjs.com/package/tickplate)
 [![npm downloads](https://img.shields.io/npm/dt/tickplate.svg)](https://www.npmjs.com/package/tickplate)
 
-## Usage
+Zero-dependency back-tick templates using property names instead of expressions.
+Part of the [Metarhia](https://github.com/metarhia) stack.
+
+## Installation
 
-- Install: `npm install tickplate`
-- Require: `const t = require('tickplate');`
-- Place tag `t` before templated string
+```bash
+npm install tickplate
+```
 
-## Examples:
+## Usage
+
+Place tag `t` before a template literal. Placeholders use property names (strings)
+as keys; pass a data object to the returned function to render.
 
 ```js
 const t = require('tickplate');
@@ -31,18 +37,58 @@ const data = {
 const templ = t`${'hello'} ${'myFriend'}, great ${'positions'} of Rome`;
 
 console.log(templ(data));
+// Ave! Marcus Aurelius, great emperor, philosopher, writer of Rome
+```
+
+### ESM
+
+```js
+import t from 'tickplate';
+
+const templ = t`Hello ${'name'}!`;
+console.log(templ({ name: 'World' }));
+// Hello World!
+```
+
+## API
+
+### `t(strings, ...keys)`
+
+Tagged template literal. Returns a function `(values, opts?) => string`.
+
+- **Placeholders**: `${'key'}` — property name from the data object.
+- **Default values**: `${'key=value'}` — JSON-parsable default when the key is
+  missing. Example: `${'greeting="Hello"'}` or `${'count=0'}`.
+- **Arrays**: Values are joined with `,` by default. Use `opts.delimiter` to
+  customize (e.g. `{ delimiter: ', ' }`).
+
+### `templ(values, opts?)`
+
+Renders the template.
+
+- **values**: Data object. Keys not present render as empty string. `null` and
+  `undefined` are treated as `{}`.
+- **opts.delimiter**: String (or coercible value) used to join array elements.
+  Default: `','`.
+
+## Examples
+
+### With delimiter
+
+```js
 console.log(templ(data, { delimiter: ', ' }));
+// Ave! Marcus Aurelius, great emperor, philosopher, writer of Rome
 ```
 
-With default values provided (optionally):
+### With default values
 
 ```js
-const t = require('tickplate');
+const templ = t`${'greeting='} ${'person="Marcus Aurelius"'}, great ${'positions=["emperor", "philosopher"]'} of Rome from ${'ruleFrom=161'} to ${'ruleTo=180'} AD`;
 
 const data = {
   greeting: 'Valē!',
   person: {
-    name: 'Lucius Aurelius Verus',
+    name: 'Lucius Verus',
     toString() {
       return this.name;
     },
@@ -52,13 +98,12 @@ const data = {
   ruleTo: 169,
 };
 
-const templ = t`${'greeting='} ${'person="Marcus Aurelius"'}, great ${'positions=["emperor", "philosopher"]'} of Rome from ${'ruleFrom=161'} to ${'ruleTo=180'} AD`;
-
 console.log(templ(data));
+// Valē! Lucius Verus, great brother,emperor,co-emperor of Rome from 161 to 180 AD
 ```
 
 ## License & Contributors
 
-Copyright (c) 2017-2025 [Metarhia contributors](https://github.com/metarhia/tickplate/graphs/contributors).
-Tickplate is [MIT licensed](./LICENSE).\
+Copyright (c) 2017-2026 [Metarhia contributors](https://github.com/metarhia/tickplate/graphs/contributors).
+Tickplate is [MIT licensed](./LICENSE).
 Tickplate is a part of [Metarhia](https://github.com/metarhia) technology stack.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tickplate",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "author": "Timur Shemsedinov <timur.shemsedinov@gmail.com>",
   "description": "Back-tick templates for JavaScript",
   "license": "MIT",
@@ -27,7 +27,15 @@
   },
   "main": "tickplate.js",
   "types": "tickplate.d.ts",
+  "exports": {
+    ".": {
+      "require": "./tickplate.js",
+      "import": "./tickplate.js",
+      "types": "./tickplate.d.ts"
+    }
+  },
   "files": [
+    "tickplate.js",
     "tickplate.d.ts"
   ],
   "engines": {
@@ -42,11 +50,8 @@
   },
   "devDependencies": {
     "eslint": "^9.39.2",
-    "eslint-config-metarhia": "^9.1.5",
+    "eslint-config-metarhia": "^9.1.8",
     "prettier": "^3.7.4",
     "typescript": "^5.9.3"
-  },
-  "dependencies": {
-    "metautil": "^5.4.0"
   }
 }

package/tickplate.d.ts

@@ -1,10 +1,15 @@
 interface TickplateOptions {
-  delimiter?: any;
+  delimiter?: string;
 }
 
+type TickplateTemplate = (
+  values?: Record<string, unknown> | null,
+  opts?: TickplateOptions,
+) => string;
+
 declare function tickplate(
-  strings: Array<string>,
-  ...keys: Array<string>
-): (values: object, opts?: TickplateOptions) => string;
+  strings: TemplateStringsArray,
+  ...keys: string[]
+): TickplateTemplate;
 
 export = tickplate;

package/tickplate.js

@@ -1,15 +1,23 @@
 'use strict';
 
-const metautil = require('metautil');
-
 const SEPARATOR = '=';
 
+const jsonParse = (value) => {
+  let result;
+  try {
+    result = JSON.parse(value);
+  } catch {
+    result = undefined;
+  }
+  return result;
+};
+
 const parseKeyValuePair = (value, sep = SEPARATOR) => {
   const [lhs, ...rhs] = value.split(sep);
   const key = lhs.trim();
   if (rhs.length === 0) return { key };
   const rhsRestored = rhs.join(sep).trim();
-  const parsed = metautil.jsonParse(rhsRestored);
+  const parsed = jsonParse(rhsRestored);
   return { key, value: parsed };
 };
 
@@ -30,7 +38,7 @@ const serialize = (value, opts) => {
 
 const tickplate = (strings, ...keys) => {
   const { keys: tickplateKeys, defaults } = parseKeys(keys);
-  return (values, opts = {}) => {
+  return (values = {}, opts = {}) => {
     const tickplateValues = { ...defaults, ...values };
     const result = [strings[0]];
     for (let i = 0; i < tickplateKeys.length; i++) {