pax_global_header 0000666 0000000 0000000 00000000064 13254052404 0014511 g ustar 00root root 0000000 0000000 52 comment=11efc65852c7e7d36abf6f5fb770668db3ce7da6 consolidate.js-0.15.1/ 0000775 0000000 0000000 00000000000 13254052404 0014514 5 ustar 00root root 0000000 0000000 consolidate.js-0.15.1/.editorconfig 0000664 0000000 0000000 00000000405 13254052404 0017170 0 ustar 00root root 0000000 0000000 root = true [*] indent_style = space end_of_line = lf charset = utf-8 indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true [{**/{actual,fixtures,expected,templates}/**,*.md}] trim_trailing_whitespace = false insert_final_newline = false consolidate.js-0.15.1/.eslintrc.json 0000664 0000000 0000000 00000006775 13254052404 0017327 0 ustar 00root root 0000000 0000000 { "env": { "browser": false, "es6": true, "node": true, "mocha": true }, "globals": { "document": false, "navigator": false, "window": false }, "rules": { "accessor-pairs": 2, "arrow-spacing": [2, { "before": true, "after": true }], "block-spacing": [2, "always"], "brace-style": [2, "1tbs", { "allowSingleLine": true }], "comma-dangle": [2, "never"], "comma-spacing": [2, { "before": false, "after": true }], "comma-style": [2, "last"], "constructor-super": 2, "curly": [2, "multi-line"], "dot-location": [2, "property"], "eol-last": 2, "eqeqeq": [2, "allow-null"], "generator-star-spacing": [2, { "before": true, "after": true }], "handle-callback-err": [2, "^(err|error)$" ], "indent": [2, 2, { "SwitchCase": 1 }], "key-spacing": [2, { "beforeColon": false, "afterColon": true }], "keyword-spacing": [2, { "before": true, "after": true }], "new-cap": [2, { "newIsCap": true, "capIsNew": false }], "new-parens": 2, "no-array-constructor": 2, "no-caller": 2, "no-class-assign": 2, "no-cond-assign": 2, "no-const-assign": 2, "no-control-regex": 2, "no-debugger": 2, "no-delete-var": 2, "no-dupe-args": 2, "no-dupe-class-members": 2, "no-dupe-keys": 2, "no-duplicate-case": 2, "no-empty-character-class": 2, "no-eval": 2, "no-ex-assign": 2, "no-extend-native": 2, "no-extra-bind": 2, "no-extra-boolean-cast": 2, "no-extra-parens": [2, "functions"], "no-fallthrough": 2, "no-floating-decimal": 2, "no-func-assign": 2, "no-implied-eval": 2, "no-inner-declarations": [2, "functions"], "no-invalid-regexp": 2, "no-irregular-whitespace": 2, "no-iterator": 2, "no-label-var": 2, "no-labels": 2, "no-lone-blocks": 2, "no-mixed-spaces-and-tabs": 2, "no-multi-spaces": 2, "no-multi-str": 2, "no-multiple-empty-lines": [2, { "max": 1 }], "no-native-reassign": 0, "no-negated-in-lhs": 2, "no-new": 2, "no-new-func": 2, "no-new-object": 2, "no-new-require": 2, "no-new-wrappers": 2, "no-obj-calls": 2, "no-octal": 2, "no-octal-escape": 2, "no-proto": 0, "no-redeclare": 2, "no-regex-spaces": 2, "no-return-assign": 2, "no-self-compare": 2, "no-sequences": 2, "no-shadow-restricted-names": 2, "no-spaced-func": 2, "no-sparse-arrays": 2, "no-this-before-super": 2, "no-throw-literal": 2, "no-trailing-spaces": 0, "no-undef": 2, "no-undef-init": 2, "no-unexpected-multiline": 2, "no-unneeded-ternary": [2, { "defaultAssignment": false }], "no-unreachable": 2, "no-unused-vars": [2, { "vars": "all", "args": "none" }], "no-useless-call": 0, "no-with": 2, "one-var": [0, { "initialized": "never" }], "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], "padded-blocks": [0, "never"], "quotes": [2, "single", "avoid-escape"], "radix": 2, "semi": [2, "always"], "semi-spacing": [2, { "before": false, "after": true }], "space-before-blocks": [2, "always"], "space-before-function-paren": [2, "never"], "space-in-parens": [2, "never"], "space-infix-ops": 2, "space-unary-ops": [2, { "words": true, "nonwords": false }], "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], "use-isnan": 2, "valid-typeof": 2, "wrap-iife": [2, "any"], "yoda": [2, "never"] } } consolidate.js-0.15.1/.gitignore 0000664 0000000 0000000 00000000440 13254052404 0016502 0 ustar 00root root 0000000 0000000 # always ignore files *.DS_Store *.sublime-* # test related, or directories generated by tests test/actual actual coverage .nyc* # npm node_modules npm-debug.log # yarn yarn.lock yarn-error.log # misc _gh_pages _draft _drafts bower_components vendor temp tmp TODO.md package-lock.json consolidate.js-0.15.1/.npmignore 0000664 0000000 0000000 00000000035 13254052404 0016511 0 ustar 00root root 0000000 0000000 support test examples *.sock consolidate.js-0.15.1/.travis.yml 0000664 0000000 0000000 00000000146 13254052404 0016626 0 ustar 00root root 0000000 0000000 sudo: false os: - linux - osx language: node_js node_js: - node - '9' - '8' - '6' - '4' consolidate.js-0.15.1/History.md 0000664 0000000 0000000 00000005237 13254052404 0016506 0 ustar 00root root 0000000 0000000 0.15.1 / 2018-03-19 =================== * add support for underscore partials * updating metadata and configurations * lint and cleanup code and tests 0.15.0 / 2017-11-01 =================== * add plates support * add teacup support * add liquid-node support * add velocityjs support * allow absolute and relative partial paths * extend dot options * support layouts in vash 0.14.0 / 2016-01-24 =================== * add slm support * add vash support * add twig support * fixes lodash 4 options * fixes liquid file extensions and path resolving 0.13.0 / 2015-05-26 =================== * fixes react template error * adds promises when a callback function is not passed to `render` * documentation updates 0.11.0 / 2015-02-07 ================== * fix aptl tests * update jade caching * add HTMLing support * add hamlet support * readme updates * add tinyliquid support * pass `options` to ECT.js * update ractive * update travis-ci to test 0.10, 0.12, and iojs 0.10.0 / 2013-11-23 ================== * add lodash support * add nunjucks support 0.9.1 / 2013-04-29 ================== * Update ECT version * Added support for Handlebars helpers with test. * Invalidates built-in dust cache if caching disabled 0.9.0 / 2013-03-28 ================== * dust-helpers support, latest version of dust * Re-add doT - global leaks fixed * improving templayed support 0.8.0 / 2013-01-23 ================== * add templayed support * add `then-jade` as an alternative to `jade` 0.7.0 / 2012-12-28 ================== * add atpl support 0.6.0 2012-12-22 ================== * add partials support * add support for toffee templates * remove dot it still leaks and the author has not fixed it 0.5.0 / 2012-10-29 ================== * add `mote` support * add support to `dust` partials * add support for `ECT` * add support for rendering without file * add support for `JUST` * improve Haml-Coffee caching. 0.4.0 / 2012-07-30 ================== * add doT support [sannis] * add mustache support [ForbesLindesay] * add walrus support [kagd] 0.3.1 / 2012-06-28 ================== * add QEJS support * add underscore support * change whiskers to use pre-defined `.__express` * remove engines. Closes #37 * remove kernel, cannot comply with our caching 0.3.0 / 2012-04-18 ================== * Added partials loading for whiskers [gsf] * Added dustjs-linkedin support 0.2.0 / 2012-04-04 ================== * Added support for dust [fatjonny] * Added handlebars support [jstewmon] 0.1.0 / 2012-01-03 ================== * Added support for several more engines 0.0.1 / 2010-01-03 ================== * Initial release consolidate.js-0.15.1/Makefile 0000664 0000000 0000000 00000000154 13254052404 0016154 0 ustar 00root root 0000000 0000000 REPORTER = spec test: @./node_modules/.bin/mocha \ --slow 30 \ --reporter $(REPORTER) .PHONY: test consolidate.js-0.15.1/Readme.md 0000664 0000000 0000000 00000021725 13254052404 0016242 0 ustar 00root root 0000000 0000000 # Consolidate.js Template engine consolidation library. ## Installation $ npm install consolidate ## Supported template engines - [atpl](https://github.com/soywiz/atpl.js) - [bracket](https://github.com/danlevan/bracket-template) - [doT.js](https://github.com/olado/doT) [(website)](http://olado.github.io/doT/) - [dust (unmaintained)](https://github.com/akdubya/dustjs) [(website)](http://akdubya.github.com/dustjs/) - [dustjs-linkedin (maintained fork of dust)](https://github.com/linkedin/dustjs) [(website)](http://linkedin.github.io/dustjs/) - [eco](https://github.com/sstephenson/eco) - [ect](https://github.com/baryshev/ect) [(website)](http://ectjs.com/) - [ejs](https://github.com/mde/ejs) [(website)](http://ejs.co/) - [haml](https://github.com/visionmedia/haml.js) - [haml-coffee](https://github.com/9elements/haml-coffee) - [hamlet](https://github.com/gregwebs/hamlet.js) - [handlebars](https://github.com/wycats/handlebars.js/) [(website)](http://handlebarsjs.com/) - [hogan](https://github.com/twitter/hogan.js) [(website)](http://twitter.github.com/hogan.js/) - [htmling](https://github.com/codemix/htmling) - [jade](https://github.com/visionmedia/jade) [(website)](http://jade-lang.com/) - [jazz](https://github.com/shinetech/jazz) - [jqtpl](https://github.com/kof/jqtpl) - [JUST](https://github.com/baryshev/just) - [liquor](https://github.com/chjj/liquor) - [lodash](https://github.com/bestiejs/lodash) [(website)](http://lodash.com/) - [marko](https://github.com/marko-js/marko) [(website)](http://markojs.com) - [mote](https://github.com/satchmorun/mote) [(website)](http://satchmorun.github.io/mote/) - [mustache](https://github.com/janl/mustache.js) - [nunjucks](https://github.com/mozilla/nunjucks) [(website)](https://mozilla.github.io/nunjucks) - [plates](https://github.com/flatiron/plates) - [pug (formerly jade)](https://github.com/pugjs/pug) [(website)](http://jade-lang.com/) - [QEJS](https://github.com/jepso/QEJS) - [ractive](https://github.com/Rich-Harris/Ractive) - [react](https://github.com/facebook/react) - [slm](https://github.com/slm-lang/slm) - [swig (unmaintained)](https://github.com/paularmstrong/swig) - [swig (maintained fork)](https://github.com/node-swig/swig-templates) - [teacup](https://github.com/goodeggs/teacup) - [templayed](http://archan937.github.com/templayed.js/) - [twig](https://github.com/justjohn/twig.js) - [liquid](https://github.com/leizongmin/tinyliquid) [(website)](http://liquidmarkup.org/) - [toffee](https://github.com/malgorithms/toffee) - [underscore](https://github.com/documentcloud/underscore) [(website)](http://underscorejs.org/#template) - [vash](https://github.com/kirbysayshi/vash) - [walrus](https://github.com/jeremyruppel/walrus) [(website)](http://documentup.com/jeremyruppel/walrus/) - [whiskers](https://github.com/gsf/whiskers.js) __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 3.x 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. ```js 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: ```js 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: ```js 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. ```js 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 `Function`s 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 Express 3 or higher: `app.locals.cache = true` or set NODE_ENV to 'production' and Express will do this for you. ## Express 3.x example ```js 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({ name: 'tobi' }); users.push({ name: 'loki' }); users.push({ name: 'jane' }); app.get('/', function(req, res){ res.render('index', { title: 'Consolidate.js' }); }); app.get('/users', function(req, res){ res.render('users', { title: 'Users', users: users }); }); app.listen(3000); console.log('Express server listening on port 3000'); ``` ## Template Engine Instances Template engines are exposed via the `cons.requires` object, but they are not instantiated until you've called the `cons[engine].render()` method. You can instantiate them manually beforehand if you want to add filters, globals, mixins, or other engine features. ```js var cons = require('consolidate'), nunjucks = require('nunjucks'); // add nunjucks to requires so filters can be // added and the same instance will be used inside the render method cons.requires.nunjucks = nunjucks.configure(); cons.requires.nunjucks.addFilter('foo', function () { return 'bar'; }); ``` ## Notes * If you're using Nunjucks, please take a look at the `exports.nunjucks.render` function in `lib.consolidate.js`. You can pass your own engine/environment via `options.nunjucksEnv`, or if you want to support Express you can pass `options.settings.views`, or if you have another use case, pass `options.nunjucks` (see the code for more insight). * You can pass **partials** with `options.partials` * For using **template inheritance** with nunjucks, you can pass a loader with `options.loader`. * To use **filters** with tinyliquid, use `options.filters` and specify an array of properties, each of which is a named filter function. A filter function takes a string as a parameter and returns a modified version of it. * To use **custom tags** with tinyliquid, use `options.customTags` to specify an array of tag functions that follow the tinyliquid [custom tag](https://github.com/leizongmin/tinyliquid/wiki/Custom-Tag) definition. * The default directory used with the **include** tag with tinyliquid is the current working directory. To override this, use `options.includeDir`. * `React` To render content into a html base template (eg. `index.html` of your React app), pass the path of the template with `options.base`. ## Running tests Install dev deps: $ npm install -d Run the tests: $ make test ## License (The MIT License) Copyright (c) 2011-2016 TJ Holowaychuk <tj@vision-media.ca> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. consolidate.js-0.15.1/appveyor.yml 0000664 0000000 0000000 00000000427 13254052404 0017107 0 ustar 00root root 0000000 0000000 environment: matrix: - nodejs_version: '9' - nodejs_version: '8' - nodejs_version: '6' - nodejs_version: '4' install: - ps: 'Install-Product node $env:nodejs_version' - npm install test_script: - node --version - npm --version - npm test build: 'off' consolidate.js-0.15.1/examples/ 0000775 0000000 0000000 00000000000 13254052404 0016332 5 ustar 00root root 0000000 0000000 consolidate.js-0.15.1/examples/express.js 0000664 0000000 0000000 00000001201 13254052404 0020353 0 ustar 00root root 0000000 0000000 // npm install express var express = require('../../express'); var cons = require('../'); var app = express(); var path = require('path'); app.engine('html', cons.swig); app.set('view engine', 'html'); app.set('views', path.join(__dirname, 'views')); var users = []; users.push({ name: 'tobi' }); users.push({ name: 'loki' }); users.push({ name: 'jane' }); app.get('/', function(req, res) { res.render('index', { title: 'Consolidate.js' }); }); app.get('/users', function(req, res) { res.render('users', { title: 'Users', users: users }); }); app.listen(3000); console.log('Express server listening on port 3000'); consolidate.js-0.15.1/examples/views/ 0000775 0000000 0000000 00000000000 13254052404 0017467 5 ustar 00root root 0000000 0000000 consolidate.js-0.15.1/examples/views/index.html 0000664 0000000 0000000 00000000170 13254052404 0021462 0 ustar 00root root 0000000 0000000
Welcome to the {{title}} demo. Click a link: