tickplate 1.0.6 → 1.0.8

package/README.md

@@ -31,6 +31,30 @@ const data = {
 
 const templ = t`${'hello'} ${'myFriend'}, great ${'positions'} of Rome`;
 
+console.log(templ(data));
+console.log(templ(data, { delimiter: ', ' }));
+```
+
+With default values provided (optionally):
+
+```js
+const t = require('tickplate');
+
+const data = {
+  greeting: 'Valē!',
+  person: {
+    name: 'Lucius Aurelius Verus',
+    toString() {
+      return this.name;
+    },
+  },
+  positions: ['brother', 'emperor', 'co-emperor'],
+  ruleFrom: 161,
+  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));
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tickplate",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "author": "Timur Shemsedinov <timur.shemsedinov@gmail.com>",
   "description": "Back-tick templates for JavaScript",
   "license": "MIT",
@@ -14,7 +14,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/metarhia/tickplate"
+    "url": "git+https://github.com/metarhia/tickplate.git"
   },
   "bugs": {
     "url": "https://github.com/metarhia/tickplate/issues",
@@ -27,9 +27,11 @@
   },
   "main": "tickplate.js",
   "types": "tickplate.d.ts",
-  "files": ["tickplate.d.ts"],
+  "files": [
+    "tickplate.d.ts"
+  ],
   "engines": {
-    "node": "^14.18 || 16 || 18 || 19"
+    "node": "18 || 20 || 21"
   },
   "readmeFilename": "README.md",
   "scripts": {
@@ -39,12 +41,15 @@
     "fmt": "prettier --write \"**/*.js\" \"**/*.json\" \"**/*.md\" \".*rc\" \"**/*.yml\""
   },
   "devDependencies": {
-    "eslint": "^8.34.0",
+    "eslint": "^8.54.0",
     "eslint-config-metarhia": "^8.1.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-prettier": "^4.2.1",
-    "prettier": "^2.8.4",
-    "typescript": "^4.9.5"
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "prettier": "^3.1.0",
+    "typescript": "^5.3.2"
+  },
+  "dependencies": {
+    "metautil": "^4.0.1"
   }
 }

package/tickplate.d.ts

@@ -1,3 +1,10 @@
-declare function tickplate(strings: Array<string>, ...keys: Array<string>): (values: object) => string;
+interface TickplateOptions {
+  delimiter?: any;
+}
+
+declare function tickplate(
+  strings: Array<string>,
+  ...keys: Array<string>
+): (values: object, opts?: TickplateOptions) => string;
 
 export = tickplate;

package/tickplate.js

@@ -1,14 +1,45 @@
 'use strict';
 
-const tickplate =
-  (strings, ...keys) =>
-  (values) => {
+const metautil = require('metautil');
+
+const SEPARATOR = '=';
+
+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);
+  return { key, value: parsed };
+};
+
+const parseKeys = (strKeyValuePairs, sep = SEPARATOR) => {
+  const defaults = {};
+  for (const pair of strKeyValuePairs) {
+    const { key, value } = parseKeyValuePair(pair, sep);
+    defaults[key] = value;
+  }
+  return { keys: Object.keys(defaults), defaults };
+};
+
+const serialize = (value, opts) => {
+  if (!Array.isArray(value)) return value;
+  const { delimiter } = opts;
+  return value.join(delimiter);
+};
+
+const tickplate = (strings, ...keys) => {
+  const { keys: tickplateKeys, defaults } = parseKeys(keys);
+  return (values, opts = {}) => {
+    const tickplateValues = { ...defaults, ...values };
     const result = [strings[0]];
-    for (let i = 0; i < keys.length; i++) {
-      const key = keys[i];
-      result.push(values[key], strings[i + 1]);
+    for (let i = 0; i < tickplateKeys.length; i++) {
+      const key = tickplateKeys[i];
+      const value = serialize(tickplateValues[key], opts);
+      result.push(value, strings[i + 1]);
     }
     return result.join('');
   };
+};
 
 module.exports = tickplate;

package/CHANGELOG.md

@@ -1,45 +0,0 @@
-# Changelog
-
-## [Unreleased][unreleased]
-
-## [1.0.6][] - 2023-02-20
-
-- Package maintenance
-
-## [1.0.5][] - 2022-07-07
-
-- Package maintenance
-
-## [1.0.4][] - 2022-05-12
-
-- Package maintenance
-
-## [1.0.3][] - 2021-07-17
-
-- Fix d.ts typings and include typings to package publishing files
-- Chore: update package files, copyrights, links
-
-## [1.0.2][] - 2021-07-15
-
-- Add d.ts typings
-- Package maintenance
-
-## [1.0.1][] - 2021-06-14
-
-- Refresh package (dependencies, ci, badges, code style)
-
-## [1.0.0][] - 2020-12-16
-
-- Reflect data structures to template with tick syntax
-
-## [0.0.x][] Pre-release versions
-
-[unreleased]: https://github.com/metarhia/tickplate/compare/v1.0.6...HEAD
-[1.0.6]: https://github.com/metarhia/tickplate/compare/v1.0.5...v1.0.6
-[1.0.5]: https://github.com/metarhia/tickplate/compare/v1.0.4...v1.0.5
-[1.0.4]: https://github.com/metarhia/tickplate/compare/v1.0.3...v1.0.4
-[1.0.3]: https://github.com/metarhia/tickplate/compare/v1.0.2...v1.0.3
-[1.0.2]: https://github.com/metarhia/tickplate/compare/v1.0.1...v1.0.2
-[1.0.1]: https://github.com/metarhia/tickplate/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/metarhia/tickplate/compare/v0.0.x...v1.0.0
-[0.0.x]: https://github.com/metarhia/tickplate/releases/tag/v0.0.x