tickplate 1.0.7 → 1.0.9

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2023 Metarhia contributors
+Copyright (c) 2017-2025 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

@@ -1,7 +1,6 @@
 ## Tickplate - Back-tick templates for JavaScript
 
 [![ci status](https://github.com/metarhia/tickplate/workflows/Testing%20CI/badge.svg)](https://github.com/metarhia/tickplate/actions?query=workflow%3A%22Testing+CI%22+branch%3Amaster)
-[![codacy](https://api.codacy.com/project/badge/Grade/69719502402b43598ffac0fd35f2192c)](https://www.codacy.com/app/metarhia/tickplate)
 [![snyk](https://snyk.io/test/github/metarhia/tickplate/badge.svg)](https://snyk.io/test/github/metarhia/tickplate)
 [![npm version](https://badge.fury.io/js/tickplate.svg)](https://badge.fury.io/js/tickplate)
 [![npm downloads/month](https://img.shields.io/npm/dm/tickplate.svg)](https://www.npmjs.com/package/tickplate)
@@ -31,11 +30,35 @@ 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));
 ```
 
 ## License & Contributors
 
-Copyright (c) 2017-2023 [Metarhia contributors](https://github.com/metarhia/tickplate/graphs/contributors).
+Copyright (c) 2017-2025 [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.7",
+  "version": "1.0.9",
   "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,24 +27,26 @@
   },
   "main": "tickplate.js",
   "types": "tickplate.d.ts",
-  "files": ["tickplate.d.ts"],
+  "files": [
+    "tickplate.d.ts"
+  ],
   "engines": {
-    "node": "16 || 18 || 19 || 20"
+    "node": ">=18"
   },
   "readmeFilename": "README.md",
   "scripts": {
     "test": "npm run lint && npm run types && node ./test.js",
     "types": "tsc -p tsconfig.json",
-    "lint": "eslint . && prettier -c \"**/*.js\" \"**/*.json\" \"**/*.md\" \".*rc\" \"**/*.yml\"",
-    "fmt": "prettier --write \"**/*.js\" \"**/*.json\" \"**/*.md\" \".*rc\" \"**/*.yml\""
+    "lint": "eslint . && prettier -c \"**/*.js\" \"**/*.json\" \"**/*.md\"",
+    "fix": "prettier --write \"**/*.js\" \"**/*.json\" \"**/*.md\""
   },
   "devDependencies": {
-    "eslint": "^8.34.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": "^5.0.4"
+    "eslint": "^9.39.2",
+    "eslint-config-metarhia": "^9.1.5",
+    "prettier": "^3.7.4",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "metautil": "^5.4.0"
   }
 }

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;