', data)
```
-If called without second argument, **tmpl()** returns a reusable template function:
+If called without second argument, **tmpl()** returns a reusable template
+function:
```js
-var func = tmpl("
')
+document.getElementById('result').innerHTML = func(data)
```
### Templates cache
+
Templates loaded by id are cached in the map **tmpl.cache**:
```js
-var func = tmpl("tmpl-demo"), // Loads and parses the template
- cached = typeof tmpl.cache["tmpl-demo"] === "function", // true
- result = tmpl("tmpl-demo", data); // Uses cached template function
+var func = tmpl('tmpl-demo'), // Loads and parses the template
+ cached = typeof tmpl.cache['tmpl-demo'] === 'function', // true
+ result = tmpl('tmpl-demo', data) // Uses cached template function
-tmpl.cache["tmpl-demo"] = null;
-result = tmpl("tmpl-demo", data); // Loads and parses the template again
+tmpl.cache['tmpl-demo'] = null
+result = tmpl('tmpl-demo', data) // Loads and parses the template again
```
### Output encoding
-The method **tmpl.encode** is used to escape HTML special characters in the template output:
+
+The method **tmpl.encode** is used to escape HTML special characters in the
+template output:
```js
-var output = tmpl.encode("<>&\"'\x00"); // Renders "<>&"'"
+var output = tmpl.encode('<>&"\'\x00') // Renders "<>&"'"
```
-**tmpl.encode** makes use of the regular expression **tmpl.encReg** and the encoding map **tmpl.encMap** to match and replace special characters, which can be modified to change the behavior of the output encoding.
-Strings matched by the regular expression, but not found in the encoding map are removed from the output. This allows for example to automatically trim input values (removing whitespace from the start and end of the string):
+**tmpl.encode** makes use of the regular expression **tmpl.encReg** and the
+encoding map **tmpl.encMap** to match and replace special characters, which can
+be modified to change the behavior of the output encoding.
+Strings matched by the regular expression, but not found in the encoding map are
+removed from the output. This allows for example to automatically trim input
+values (removing whitespace from the start and end of the string):
```js
-tmpl.encReg = /(^\s+)|(\s+$)|[<>&"'\x00]/g;
-var output = tmpl.encode(" Banana! "); // Renders "Banana" (without whitespace)
+tmpl.encReg = /(^\s+)|(\s+$)|[<>&"'\x00]/g
+var output = tmpl.encode(' Banana! ') // Renders "Banana" (without whitespace)
```
### Local helper variables
-The local variables available inside the templates are the following:
-* **o**: The data object given as parameter to the template function (see the next section on how to modify the parameter name).
-* **tmpl**: A reference to the **tmpl** function object.
-* **_s**: The string for the rendered result content.
-* **_e**: A reference to the **tmpl.encode** method.
-* **print**: Helper function to add content to the rendered result string.
-* **include**: Helper function to include the return value of a different template in the result.
+The local variables available inside the templates are the following:
-To introduce additional local helper variables, the string **tmpl.helper** can be extended. The following adds a convenience function for *console.log* and a streaming function, that streams the template rendering result back to the callback argument (note the comma at the beginning of each variable declaration):
+- **o**: The data object given as parameter to the template function (see the
+ next section on how to modify the parameter name).
+- **tmpl**: A reference to the **tmpl** function object.
+- **\_s**: The string for the rendered result content.
+- **\_e**: A reference to the **tmpl.encode** method.
+- **print**: Helper function to add content to the rendered result string.
+- **include**: Helper function to include the return value of a different
+ template in the result.
+
+To introduce additional local helper variables, the string **tmpl.helper** can
+be extended. The following adds a convenience function for _console.log_ and a
+streaming function, that streams the template rendering result back to the
+callback argument (note the comma at the beginning of each variable
+declaration):
```js
-tmpl.helper += ",log=function(){console.log.apply(console, arguments)}" +
- ",st='',stream=function(cb){var l=st.length;st=_s;cb( _s.slice(l));}";
+tmpl.helper +=
+ ',log=function(){console.log.apply(console, arguments)}' +
+ ",st='',stream=function(cb){var l=st.length;st=_s;cb( _s.slice(l));}"
```
-Those new helper functions could be used to stream the template contents to the console output:
+Those new helper functions could be used to stream the template contents to the
+console output:
```html
```
### Template function argument
-The generated template functions accept one argument, which is the data object given to the **tmpl(id, data)** function. This argument is available inside the template definitions as parameter **o** (the lowercase letter).
+
+The generated template functions accept one argument, which is the data object
+given to the **tmpl(id, data)** function. This argument is available inside the
+template definitions as parameter **o** (the lowercase letter).
The argument name can be modified by overriding **tmpl.arg**:
```js
-tmpl.arg = "p";
+tmpl.arg = 'p'
// Renders "
JavaScript Templates
":
-var result = tmpl("
{%=p.title%}
", {title: "JavaScript Templates"});
+var result = tmpl('
{%=p.title%}
', { title: 'JavaScript Templates' })
```
### Template parsing
-The template contents are matched and replaced using the regular expression **tmpl.regexp** and the replacement function **tmpl.func**. The replacement function operates based on the [parenthesized submatch strings](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_function_as_a_parameter).
-To use different tags for the template syntax, override **tmpl.regexp** with a modified regular expression, by exchanging all occurrences of "{%" and "%}", e.g. with "[%" and "%]":
+The template contents are matched and replaced using the regular expression
+**tmpl.regexp** and the replacement function **tmpl.func**. The replacement
+function operates based on the
+[parenthesized submatch strings](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_function_as_a_parameter).
+
+To use different tags for the template syntax, override **tmpl.regexp** with a
+modified regular expression, by exchanging all occurrences of "{%" and "%}",
+e.g. with "[%" and "%]":
```js
-tmpl.regexp = /([\s'\\])(?![^%]*%\])|(?:\[%(=|#)([\s\S]+?)%\])|(\[%)|(%\])/g;
+tmpl.regexp = /([\s'\\])(?!(?:[^[]|\[(?!%))*%\])|(?:\[%(=|#)([\s\S]+?)%\])|(\[%)|(%\])/g
```
-By default, the plugin preserves whitespace (newlines, carriage returns, tabs and spaces). To strip unnecessary whitespace, you can override the **tmpl.func** function, e.g. with the following code:
+By default, the plugin preserves whitespace (newlines, carriage returns, tabs
+and spaces). To strip unnecessary whitespace, you can override the **tmpl.func**
+function, e.g. with the following code:
```js
-var originalFunc = tmpl.func;
+var originalFunc = tmpl.func
tmpl.func = function (s, p1, p2, p3, p4, p5, offset, str) {
- if (p1 && /\s/.test(p1)) {
- if (!offset || /\s/.test(str.charAt(offset - 1)) ||
- /^\s+$/g.test(str.slice(offset))) {
- return '';
- }
- return ' ';
+ if (p1 && /\s/.test(p1)) {
+ if (
+ !offset ||
+ /\s/.test(str.charAt(offset - 1)) ||
+ /^\s+$/g.test(str.slice(offset))
+ ) {
+ return ''
}
- return originalFunc.apply(tmpl, arguments);
-};
+ return ' '
+ }
+ return originalFunc.apply(tmpl, arguments)
+}
```
## Templates syntax
### Interpolation
+
Print variable with HTML special characters escaped:
```html
@@ -271,15 +341,8 @@ Use dot notation to print nested properties:
{%=o.author.name%}
```
-Note that the JavaScript Templates engine prints **falsy** values as empty strings.
-That is, **undefined**, **null**, **false**, **0** and **NaN** will all be converted to **''**.
-To be able to print e.g. the number 0, convert it to a String before using it as an output variable:
-
-```html
-
{%=0+''%}
-```
-
### Evaluation
+
Use **print(str)** to add escaped content to the output:
```html
@@ -296,7 +359,7 @@ Use **include(str, obj)** to include content from a different template:
```html
```
@@ -304,9 +367,9 @@ Use **include(str, obj)** to include content from a different template:
```html
{% if (o.author.url) { %}
- {%=o.author.name%}
+{%=o.author.name%}
{% } else { %}
- No author url.
+No author url.
{% } %}
```
@@ -321,26 +384,53 @@ Use **include(str, obj)** to include content from a different template:
```
## Compiled templates
-The JavaScript Templates project comes with a compilation script, that allows you to compile your templates into JavaScript code and combine them with a minimal Templates runtime into one minified JavaScript file.
-The compilation script is built for [node.js](http://nodejs.org/) and also requires [UglifyJS](https://github.com/mishoo/UglifyJS).
-To use it, first install both the JavaScript Templates project and UglifyJS via [npm](http://npmjs.org/):
+The JavaScript Templates project comes with a compilation script, that allows
+you to compile your templates into JavaScript code and combine them with a
+minimal Templates runtime into one combined JavaScript file.
+
+The compilation script is built for [Node.js](https://nodejs.org/).
+To use it, first install the JavaScript Templates project via
+[NPM](https://www.npmjs.org/):
```sh
-npm install uglify-js
npm install blueimp-tmpl
```
-This will put the executables **uglifyjs** and **tmpl.js** into the folder **node_modules/.bin**. It will also make them available on your PATH if you install the packages globally (by adding the **-g** flag to the install command).
+This will put the executable **tmpl.js** into the folder **node_modules/.bin**.
+It will also make it available on your PATH if you install the package globally
+(by adding the **-g** flag to the install command).
-The **tmpl.js** executable accepts the paths to one or multiple template files as command line arguments and prints the generated JavaScript code to the console output. The following command line shows you how to store the generated code in a new JavaScript file that can be included in your project:
+The **tmpl.js** executable accepts the paths to one or multiple template files
+as command line arguments and prints the generated JavaScript code to the
+console output. The following command line shows you how to store the generated
+code in a new JavaScript file that can be included in your project:
```sh
-tmpl.js templates/upload.html templates/download.html > tmpl.min.js
+tmpl.js index.html > tmpl.js
```
-The files given as command line arguments to **tmpl.js** can either be pure template files or HTML documents with embedded template script sections. For the pure template files, the file names (without extension) serve as template ids.
-The generated file can be included in your project as a replacement for the original **tmpl.js** runtime. It provides you with the same API and provides a **tmpl(id, data)** function that accepts the id of one of your templates as first and a data object as optional second parameter.
+The files given as command line arguments to **tmpl.js** can either be pure
+template files or HTML documents with embedded template script sections. For the
+pure template files, the file names (without extension) serve as template ids.
+The generated file can be included in your project as a replacement for the
+original **tmpl.js** runtime. It provides you with the same API and provides a
+**tmpl(id, data)** function that accepts the id of one of your templates as
+first and a data object as optional second parameter.
+
+## Tests
+
+The JavaScript Templates project comes with
+[Unit Tests](https://en.wikipedia.org/wiki/Unit_testing).
+There are two different ways to run the tests:
+
+- Open test/index.html in your browser or
+- run `npm test` in the Terminal in the root path of the repository package.
+
+The first one tests the browser integration, the second one the
+[Node.js](https://nodejs.org/) integration.
## License
-The JavaScript Templates script is released under the [MIT license](http://www.opensource.org/licenses/MIT).
+
+The JavaScript Templates script is released under the
+[MIT license](https://opensource.org/licenses/MIT).
diff --git a/bin/sync-vendor-libs.sh b/bin/sync-vendor-libs.sh
new file mode 100755
index 0000000..c2e27d9
--- /dev/null
+++ b/bin/sync-vendor-libs.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+cd "$(dirname "$0")/.."
+cp node_modules/chai/chai.js test/vendor/
+cp node_modules/mocha/mocha.js test/vendor/
+cp node_modules/mocha/mocha.css test/vendor/
diff --git a/compile.js b/compile.js
deleted file mode 100755
index ebca48a..0000000
--- a/compile.js
+++ /dev/null
@@ -1,82 +0,0 @@
-#!/usr/bin/env node
-/*
- * JavaScript Templates Compiler 2.1.0
- * https://github.com/blueimp/JavaScript-Templates
- *
- * Copyright 2011, Sebastian Tschan
- * https://blueimp.net
- *
- * Licensed under the MIT license:
- * http://www.opensource.org/licenses/MIT
- */
-
-/*jslint nomen: true */
-/*global require, __dirname, process, console */
-
-(function () {
- "use strict";
- var tmpl = require("./tmpl.js").tmpl,
- fs = require("fs"),
- path = require("path"),
- jsp = require("uglify-js").parser,
- pro = require("uglify-js").uglify,
- // Retrieve the content of the minimal runtime:
- runtime = fs.readFileSync(__dirname + "/runtime.js", "utf8"),
- // A regular expression to parse templates from script tags in a HTML page:
- regexp = /
-
-
-
< 1KB lightweight, fast & powerful JavaScript templating engine with zero dependencies.
- Compatible with server-side environments like node.js, module loaders like RequireJS and all web browsers.
+ 1KB lightweight, fast & powerful
+ JavaScript
+ templating engine with zero dependencies.
+ Compatible with server-side environments like
+ Node.js, module loaders like
+ RequireJS or
+ webpack and all web browsers.
+