Consolidate.js

Template engine consolidation library.

Installation

$ npm install consolidate

Supported Express versions

• Express 4.x
• Express 3.x

Supported template engines

Some package has the same key name, consolidate will load them according to the order number. By example for dust, consolidate will try to use in this order: dust, dustjs-helpers and dustjs-linkedin. If dust is installed, dustjs-linkedin will not be used by consolidate.

| Name cons.* | Package Name / Order | Website / State | | - | - | - | | atpl | npm install atpl | - | | bracket | npm install bracket-template | - | | dot | npm install dot | (website) | | ~~dust~~ | npm install dust (1) | (website) / (unmaintained)<br>See: dustjs-linkedin | | dust | npm install dustjs-helpers (2) or<br>npm install dustjs-linkedin (3) | (website) | | ~~eco~~ | npm install eco | /!\ Security issue | | ect | npm install ect | (website) | | ejs | npm install ejs | (website) | | hamlet | npm install hamlet | - | | hamljs | npm install hamljs | - | | haml-coffee | npm install haml-coffee | - | | handlebars | npm install handlebars | (website) | | hogan | npm install hogan.js | (website) | | htmling | npm install htmling | - | | ~~jade~~ | npm install jade | (website) / (renamed pug) | | jazz | npm install jazz | - | | ~~jqtpl~~ | npm install jqtpl | (deprecated) | | just | npm install just | - | | liquid | npm install tinyliquid | (website)<br>will never add any new features | | liquor | npm install liquor | - | | lodash | npm install lodash | (website) | | marko | npm install marko | (website) | | mote | npm install mote | (website) | | mustache | npm install mustache | - | | nunjucks | npm install nunjucks | (website) | | plates | npm install plates | - | | pug | npm install pug | (website) / (formerly jade) | | qejs | npm install qejs | - | | ractive | npm install ractive | - | | razor | npm install razor | - | | react | npm install react | - | | slm | npm install slm | - | | squirrelly | npm install squirrelly | (website) | | ~~swig~~ | npm install swig (1) | (unmaintained)<br>See: swig-templates | | swig | npm install swig-templates (2) | - | | teacup | npm install teacup | - | | templayed | npm install templayed | (website) | | toffee | npm install toffee | - | | twig | npm install twig | (wiki) | | twing | npm install twing | (website) | | underscore | npm install underscore | (website) | | vash | npm install vash | - | | velocityjs | BETA | (website) | | walrus | npm install walrus | (website) | | whiskers | npm install whiskers | - |

NOTE: you must still install the engines you wish to use, add them to your package.json dependencies.

API

All templates supported by this library may be rendered using the signature (path[, locals], callback) as shown below, which happens to be the signature that Express supports so any of these engines may be used within Express.

NOTE: All this example code uses cons.swig for the swig template engine. Replace swig with whatever templating you are using. For example, use cons.hogan for hogan.js, cons.jade for jade, etc. console.log(cons) for the full list of identifiers.

var cons = require('consolidate');
cons.swig('views/page.html', { user: 'tobi' }, function(err, html){
  if (err) throw err;
  console.log(html);
});

Or without options / local variables:

var cons = require('consolidate');
cons.swig('views/page.html', function(err, html){
  if (err) throw err;
  console.log(html);
});

To dynamically pass the engine, simply use the subscript operator and a variable:

var cons = require('consolidate')
  , name = 'swig';

cons[name]('views/page.html', { user: 'tobi' }, function(err, html){
  if (err) throw err;
  console.log(html);
});

Promises

Additionally, all templates optionally return a promise if no callback function is provided. The promise represents the eventual result of the template function which will either resolve to a string, compiled from the template, or be rejected. Promises expose a then method which registers callbacks to receive the promise’s eventual value and a catch method which the reason why the promise could not be fulfilled. Promises allow more synchronous-like code structure and solve issues like race conditions.

var cons = require('consolidate');

cons.swig('views/page.html', { user: 'tobi' })
  .then(function (html) {
    console.log(html);
  })
  .catch(function (err) {
    throw err;
  });

Caching

To enable caching simply pass { cache: true }. Engines may use this option to cache things reading the file contents, compiled Functions etc. Engines which do not support this may simply ignore it. All engines that consolidate.js implements I/O for will cache the file contents, ideal for production environments. When using consolidate directly: cons.swig('views/page.html', { user: 'tobi', cache:true }, callback); Using supported Express versions: app.locals.cache = true or set NODE_ENV to 'production' and Express will do this for you.

Express example

var express = require('express')
  , cons = require('consolidate')
  , app = express();

// assign the swig engine to .html files
app.engine('html', cons.swig);

// set .html as the default extension
app.set('view engine', 'html');
app.set('views', __dirname + '/views');

var users = [];
users.push({ na