Custom delimiters, for Handlebars templates.
Install with npm:
$ npm install --save handlebars-delimiters- breaking changes: the
.escapeDelimsmethod was renamed to.escape - adds a
.replacemethod that replaces delimiters and returns a string
var delimiters = require('handlebars-delimiters');
var Handlebars = require('handlebars');
/**
* Before
*/
var a = Handlebars.compile('{{ name }}<%= name %>')({name: 'Jon'});
console.log(a);
//=> 'Jon<%= name %>'
/**
* After
*/
// Pass your instance of Handlebars and define custom delimiters
delimiters(Handlebars, ['<%=', '%>']);
var b = Handlebars.compile('{{ name }}<%= name %>')({name: 'Jon'});
console.log(b);
//=> '{{ name }}Jon'Params
Handlebars{Object}delimiters{Array}: Array with open and close delimiters, like['<%', '%>']returns{undefined}
Example
var delimiters = require('handlebars-delimiters');
var handlebars = require('handlebars');
delimiters(handlebars, ['<%', '%>']);
// you can now use handlebars as usual, but with the new delimitersReplace or delimiters in the given string.
Params
str{String}: String with handlebars to replace or escape.source{String}: The delimiters regex source string to conver to a regular expression.escape{Boolean}: If true, replacements are escaped with a double-slash.returns{String}
Example
var replaced = delimiters.replace(str, ['<%=', '%>']);Escape handlebars delimiters in the given string.
Params
str{String}: String with handlebars to replace or escape.returns{String}
Example
var escaped = delimiters.escape(str);- handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
- handlebars-lint: Pass a context and a string with handlebars templates and lint for missing variables, helpers… more | homepage
- template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 6 | jonschlinkert |
| 4 | KingMario |
| 2 | AdamMcCormick |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testJon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 05, 2017.