Neapolitan Pizza Margherita

    assemble-loader

    1.0.5 • Public • Published

    assemble-loader NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with verb or other Templates.js based applications.

    Install

    Install with npm:

    $ npm install --save assemble-loader

    Usage

    var assemble = require('assemble');
    var loader = require('assemble-loader');
    var app = assemble()
    app.use(loader());
     
    app.create('pages', {cwd: 'src/pages'});
    app.create('partials', {cwd: 'src/partials'});
     
    // you can now load globs of templates onto any collection
    app.pages('*.hbs');
    app.partials('*.hbs');

    API

    var assemble = require('assemble');
    var loader = require('assemble-loader');
    var app = assemble()
     
    // use the plugin
    app.use(loader());

    Optionally pass glob patterns to the plugin:

    var app = assemble();
    // this can only be done once when the plugin is registered
    app.use(loader('foo/*.hbs'));
     
    // you can use the `.loadViews()` method any number of times
    app.create('pages')
      .use(loader('foo/*.hbs'))
      .loadViews('bar/*.hbs')
      .loadViews('baz/*.hbs')
      .loadViews('qux/*.hbs');

    Collections

    All collections

    When the plugin is added to the app instance (as in the previous example), a .load method will also be added to every collection created.

    var app = assemble()
      .use(loader());
     
    // cache views on `app.views.posts`
    app.create('posts')
      .load('content/*.md');
     
    // cache views on `app.views.docs`
    app.create('docs')
      .load('docs/*.md');

    Specific collections

    If you only want to add the loader to a specific collection, you can pass the plugin to the .use method on the collection.

    var app = assemble();
     
    // `create` returns the collection instance
    app.create('posts')
      .use(loader())
      .load('content/*.md');
     
    // this works too, since `create` adds methods to `app` 
    // for the collection
    app.posts
      .load('*.hbs')
      .load('*.txt');

    About

    Related projects

    • load-templates: Load templates/views using globs, file paths, objects, arrays, or key-value pairs. | homepage
    • matched: Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and… more | homepage
    • micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage

    Contributing

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

    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

    Copyright © 2017, Jon Schlinkert. MIT


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

    Install

    npm i assemble-loader

    DownloadsWeekly Downloads

    25,469

    Version

    1.0.5

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert