Name: helper-glob-files
Owner: Helpers
Description: Generic template helper for creating an array of vinyl file objects from a glob pattern.
Created: 2017-02-11 00:42:44.0
Updated: 2017-08-16 20:24:14.0
Pushed: 2017-02-11 00:43:37.0
Homepage: null
Size: 8
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Generic template helper for creating an array of vinyl file objects from a glob pattern.
Install with npm:
m install --save helper-glob-files
This can be used as a helper with handlebars, lodash, assemble, engine or directly as a utility function.
Heads up!
The purpose of this helper is to easily create an array of files to use in templates. This means that the source and dest patterns will need to be known at render time and, as such, this helper expects a dest path to be defined as a string on the helper options or on the context, otherwise an error is thrown.
glob = require('helper-glob-files');
ole.log(glob('*.js', {dest: ''}));
[ <File "example.js">, <File "index.js"> ]
handlebars = require('handlebars');
lebars.registerHelper('glob', glob);
Then in templates:
ach (glob "*") as |file|}}
file.path}}
ach}}
Tip
Get the contents for each file:
fs = require('fs');
lebars.registerHelper('read', function(filepath) {
turn fs.readFileSync(filepath, 'utf8');
Then in templates:
tmpl -->
ach (glob "*") as |file|}}
{read file.path}}</p>
ach}}
Then:
ompile
fn = handlebars.compile(tmpl);
ender
ole.log(fn());
template = require('lodash.template');
Then in templates:
tmpl -->
lob("*", {dest: ""}).map(function(item) { %>
item.stem %>
) %>
Then:
ompile
fn = template(tmpl, {imports: {glob: glob}});
ender
ole.log(fn());
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
m install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
m install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. MIT
This file was generated by verb-generate-readme, v0.4.2, on February 10, 2017.