load-templates    

> Load templates/views using globs, file paths, objects, arrays, or key-value pairs.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

``sh
$ npm install --save load-templates
`

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.

`js
const Loader = require('load-templates');
const loader = new Loader([options]);
const files = loader.load('*.hbs');
console.log(files); //<= object of vinyl files
`

Supported formats

`js
// filepath
loader.load('a/b/c/some-template.hbs');

// array of filepaths
loader.load([
'a/b/c/some-template.hbs',
'a/b/c/other-template.hbs'
]);

// glob pattern
loader.load('*.hbs');

// array of globs
loader.load(['.hbs', '.tmpl']);

// object
loader.load({path: 'foo'});

// key-value
loader.load('d', {path: 'd'});
loader.load('e', {path: 'e'});
loader.load('f', {path: 'f'});

// object of objects
loader.load({
a: {path: 'a'},
b: {path: 'b'},
c: {path: 'c'}
});

// array of objects
loader.load([
{path: 'a'},
{path: 'b'},
{path: 'c'}
]);

// array of nested objects
loader.load([
{
a: {path: 'test/fixtures/a.md'},
b: {path: 'test/fixtures/b.md'},
c: {path: 'test/fixtures/c.md'},
},
{
d: {path: 'test/fixtures/d.md'},
e: {path: 'test/fixtures/e.md'},
f: {path: 'test/fixtures/f.md'},
}
]);
`

Options

$3

Type: String

Default: process.cwd()

Pass the current working directory to use for resolving paths.

$3

Type: Function

Default: file.path The path that was given or globbed when the file was created.

Function to modify file.key, which is the property used for setting files on loader.cache.

Example

`js
const loader = new Loader({ renameKey: file => file.basename });
`

This is functionally equivalent to:

`js
loader.cache[file.basename] = file;
`

$3

Type: Function

Default: undefined

Function to run on each file before it's added to the cache.

`js
const loader = new Loader({
onLoad: file => {
// optionally return a new file, or just modify properties
}
});
`

API

$3

Create an instance of Loader with the given options.

Params

* options {Object}

Example

`js
const Loader = require('load-templates');
const loader = new Loader();
`

$3

Load one or more templates from a filepath, glob pattern, object, or array of filepaths, glob patterns or objects. This method detects the type of value to be handled then calls one of the other methods to do the actual loading.

Params

* value {Object}
* options {Object}
* returns {Object}: Returns the views from loader.cache

Example

`js
const loader = new Loader();
console.log(loader.load(['foo/.hbs', 'bar/.hbs']));
console.log(loader.load({path: 'a/b/c.md'}));
console.log(loader.load('index', {path: 'a/b/c.md'}));
`

$3

Create a view from the given template and cache it on loader.cache.

Params

* template {String|Object}
* options {Object}
* returns {Object}: Returns the Loader instance for chaining

Example

`js
const loader = new Loader();
loader.addView('foo.hbs');
console.log(loader.cache);
`

$3

Create from an array or object of templates and cache them on loader.cache.

Params

* templates {Object}
* options {Object}

Example

`js
const loader = new Loader();
loader.addViews([
{path: 'test/fixtures/a.md'},
{path: 'test/fixtures/b.md'},
{path: 'test/fixtures/c.md'},
]);
loader.addViews({
d: {path: 'test/fixtures/d.md'},
e: {path: 'test/fixtures/e.md'},
f: {path: 'test/fixtures/f.md'},
});
loader.addViews([{
g: {path: 'test/fixtures/g.md'},
h: {path: 'test/fixtures/h.md'},
i: {path: 'test/fixtures/i.md'},
}]);
console.log(loader.cache);
`

$3

Create a view object from the given template. View objects are instances of vinyl.

Params

* template {Object|String}: Filepath or object with path or contents properties.
* options {Object}
* returns {Object}: Returns the view.

Example

`js
console.log(loader.createView('test/fixtures/foo/bar.hbs'));
console.log(loader.createView('foo/bar.hbs', {cwd: 'test/fixtures'}));
`

$3

Load templates from one or more glob patterns with the given options, then cache them on loader.cache.

Params

* patterns {String|Array}
* options {Object}
* returns {Object}: Returns loader.cache

Example

`js
const loader = new Loader();
const views = loader.globViews('*.hbs', {cwd: 'templates'});
`

Release history

v2.0.0

* The loaderFn option has been deprecated and renamed to onLoad, use options.onLoad going forward.

About

$3

You might also be interested in these projects:

* assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
* templates: System for creating and managing template collections, and rendering templates with any node.js template engine… more | homepage
* verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

$3

| Commits | Contributor |
| --- | --- |
| 220 | jonschlinkert |
| 2 | doowb |

$3

Jon Schlinkert

* LinkedIn Profile
* GitHub Profile
* Twitter Profile

$3

Copyright © 2018, Jon Schlinkert.
Released under the MIT License.

*

_This file was generated by verb-generate-readme, v0.6.0, on March 05, 2018._