expand-template

What is expand-template?

The expand-template npm package is designed for string templating. It allows users to interpolate variables within a string template, making it useful for generating dynamic strings based on variable inputs. This can be particularly useful in applications that require dynamic generation of content, configuration files, or code snippets based on user input or application state.

What are expand-template's main functionalities?

Variable Interpolation

This feature allows the user to interpolate variables within a string template. The example demonstrates how to use the expand-template package to replace the {{name}} placeholder with the string 'World'.

`const expand = require('expand-template')({open: '{{', close: '}}'});
let template = 'Hello, {{name}}!';
let result = expand({name: 'World'});
console.log(result); // Outputs: Hello, World!`

Custom Delimiters

This feature enables the use of custom delimiters for the template placeholders. In the provided code, the delimiters are set to '<<' and '>>', and the example shows how to replace the <<year>> placeholder with 2023.

`const expand = require('expand-template')({open: '<<', close: '>>'});
let template = 'Current year: <<year>>';
let result = expand({year: 2023});
console.log(result); // Outputs: Current year: 2023`

Other packages similar to expand-template

mustache

Mustache is a logic-less template syntax. It can be used for HTML, config files, source code - anything. It works by expanding tags in a template using values provided in a hash or object. Compared to expand-template, Mustache offers a more complex syntax and functionality, including sections and inverted sections, but it might be overkill for simple string replacement tasks.

handlebars

Handlebars provides the power necessary to let you build semantic templates effectively with no frustration. It's an extension of Mustache with more features like helpers, partials, and more control structures. Handlebars is more feature-rich compared to expand-template, making it suitable for more complex templating needs but potentially heavier for simple tasks.

README

expand-template

Expand placeholders in a template string.

Install

$ npm i expand-template -S

Usage

Default functionality expands templates using {} as separators for string placeholders.

var expand = require('expand-template')()
var template = '{foo}/{foo}/{bar}/{bar}'
console.log(expand(template, {
  foo: 'BAR',
  bar: 'FOO'
}))
// -> BAR/BAR/FOO/FOO

Custom separators:

var expand = require('expand-template')({ sep: '[]' })
var template = '[foo]/[foo]/[bar]/[bar]'
console.log(expand(template, {
  foo: 'BAR',
  bar: 'FOO'
}))
// -> BAR/BAR/FOO/FOO

License

All code, unless stated otherwise, is dual-licensed under WTFPL and MIT.