@steeringwaves/handlebars-delimiters
v1.0.3
Published
Custom delimiters, for Handlebars templates. Includes greedy patch.
Downloads
183
Readme
handlebars-delimiters
Custom delimiters, for Handlebars templates.
Install
Install with npm:
$ npm install --save handlebars-delimiters
Release history
v1.0.0
- breaking changes: the
.escapeDelims
method was renamed to.escape
- adds a
.replace
method that replaces delimiters and returns a string
Usage
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'
API
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 delimiters
.replace
Replace 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
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);
About
Related projects
- 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
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Contributors
| Commits | Contributor | | --- | --- | | 6 | jonschlinkert | | 4 | KingMario | | 2 | AdamMcCormick |
Building docs
(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 && verb
Running tests
Running 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 test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 05, 2017.