Miss any of our Open RFC calls?Watch the recordings here! »

load-templates

0.9.1 • Public • Published

load-templates NPM version Build Status

Load templates.

Install

Install with npm

$ npm i load-templates --save

Usage

In addition to what's shown in the below examples, if a glob pattern or valid filepath is passed, a stat object will be added to the file object as well.

var loader = require('load-templates');
// optionally pass an object to use for caching the views
var cache = {};
var views = loader(cache);
 
// object of views
views({
  a: {path: 'a'},
  b: {path: 'b'},
  c: {path: 'c'}
});
 
// key-value pairs
views('d', {path: 'd'});
views('e', {path: 'e'});
views('f', {path: 'f'});
 
// glob pattern or file path, string or array
views('views/*.js'); // g, h, i

Results in:

{
  a: {path: 'a'},
  b: {path: 'b'},
  c: {path: 'c'},
  d: {path: 'd'},
  e: {path: 'e'},
  f: {path: 'f'},
  g: {path: 'g'},
  h: {path: 'h'},
  i: {path: 'i'},
  j: {path: 'j'}
}

Options

options.renameKey

Rename the key of each file object.

Type: Function

Default: noop Full filepath or whatever key is passed.

glob options

All options are also passed to globby.

Related projects

  • assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more
  • templates: System for creating and managing template collections, and rendering templates with any node.js template engine.… more
  • verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more

Running tests

Install dev dependencies:

$ npm i -d && npm test

Coverage summary

As of version 0.9.1

Statements   : 100% (81/81)
Branches     : 100% (44/44)
Functions    : 100% (13/13)
Lines        : 100% (79/79)

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on September 11, 2015.