metarhia/tickplate

Back-tick template engine for JavaScript 💬

Tickplate - Back-tick templates for JavaScript

Usage

• Install: npm install tickplate
• Require: const t = require('tickplate');
• Place tag t before templated string

Examples:

const t = require('tickplate');

const data = {
  hello: 'Ave!',
  myFriend: {
    name: 'Marcus Aurelius',
    toString() {
      return this.name;
    },
  },
  positions: ['emperor', 'philosopher', 'writer'],
};

const templ = t`${'hello'} ${'myFriend'}, great ${'positions'} of Rome`;

console.log(templ(data));
console.log(templ(data, { delimiter: ', ' }));

With default values provided (optionally):

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. Tickplate is MIT licensed.
Tickplate is a part of Metarhia technology stack.

tickplate's Issues

Templates without extra quotes

Templates syntax as of now:

const template1 = t`Example: ${'hello'} ${'myFriend'} great ${'positions'} of Rome`;

Better syntax without extra quotes:

const template1 = t`Example: ${hello} ${myFriend} great ${positions} of Rome`;

Support options like delimiter

Is your feature request related to a problem? Please describe.
There is no way to provide a delimiter for array values passed to a tickplate. Taking readme example into account, the following string is outputted: Ave! Marcus Aurelius, great emperor,philosopher,writer of Rome. Right now, there is no way to provide a delimiter that would be used when joining data.positions.

Describe the solution you'd like
Would be nice if we could provide options to templ(data, options). And one of the options would be a delimiter. For example:

const t = require('tickplate');

const data = {
  hello: 'Ave!',
  myFriend: {
    name: 'Marcus Aurelius',
    toString() {
      return this.name;
    },
  },
  positions: ['emperor', 'philosopher', 'writer'],
};

const templ = t`${'hello'} ${'myFriend'}, great ${'positions'} of Rome`;

console.log(templ(data, { delimiter: ", " }));

// Output: Ave! Marcus Aurelius, great emperor, philosopher, writer of Rome

Describe alternatives you've considered
As an alternative, we can use predefined ', ' value as a delimiter instead of a default JS one.

Additional context
N/A