helper-glob-files

Generic template helper for creating an array of vinyl file objects from a glob pattern.

Install

Install with npm:

$ npm install --save helper-glob-files

Usage

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.

var glob = require('helper-glob-files');
console.log(glob('*.js', {dest: ''}));
//=> [ <File "example.js">, <File "index.js"> ]

Handlebars usage

var handlebars = require('handlebars');
handlebars.registerHelper('glob', glob);

Then in templates:

{{#each (glob "*") as |file|}}
  {{file.path}}
{{/each}}

Tip

Get the contents for each file:

var fs = require('fs');
handlebars.registerHelper('read', function(filepath) {
  return fs.readFileSync(filepath, 'utf8');
});

Then in templates:

<!-- tmpl -->
{{#each (glob "*") as |file|}}
<p>{{read file.path}}</p>
{{/each}}

Then:

// compile
var fn = handlebars.compile(tmpl);
// render 
console.log(fn());

Lo-dash usage

var template = require('lodash.template');

Then in templates:

<!-- tmpl -->
<% glob("*", {dest: ""}).map(function(item) { %>
<%= item.stem %>
<% }) %>

Then:

// compile
var fn = template(tmpl, {imports: {glob: glob}});
// render 
console.log(fn());

About

Related projects

handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage

Contributing

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.

Building docs

(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:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

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:

$ npm install && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.4.2, on February 10, 2017.