# assemble-loader

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

Latest version **1.0.5** (published 2017-02-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install assemble-loader
pnpm add assemble-loader
yarn add assemble-loader
bun add assemble-loader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2017-02-20 |
| First published | 2015-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | assemble, assembleplugin, blog, boilerplate, build, cli, cli-app, collection, command-line, create, dev, development, framework, front, frontend, loader, page, plugin, post, project, projects, scaffold, scaffolder, scaffolding, site, template, templates, view, webapp, yeoman, yo |

## Links

- npm: https://www.npmjs.com/package/assemble-loader
- Repository: https://github.com/assemble/assemble-loader
- Issues: https://github.com/assemble/assemble-loader/issues
- npm.io page: https://npm.io/package/assemble-loader

## Dependencies (8)

- [isobject](https://npm.io/package/isobject.md) ^3.0.0
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.2
- [file-contents](https://npm.io/package/file-contents.md) ^1.0.1
- [is-registered](https://npm.io/package/is-registered.md) ^0.1.5
- [is-valid-glob](https://npm.io/package/is-valid-glob.md) ^0.3.0
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
- [load-templates](https://npm.io/package/load-templates.md) ^1.0.2
- [is-valid-instance](https://npm.io/package/is-valid-instance.md) ^0.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2017-02-20
- 1.0.4 — 2017-02-20
- 1.0.3 — 2017-02-10
- 1.0.2 — 2017-02-10
- 1.0.1 — 2017-02-04
- 1.0.0 — 2017-02-03
- 0.7.0 — 2017-02-03
- 0.6.1 — 2016-06-03
- 0.6.0 — 2016-05-28
- 0.5.0 — 2016-05-21
- 0.4.0 — 2016-05-07
- 0.3.0 — 2016-01-19
- 0.2.6 — 2015-12-27
- 0.2.5 — 2015-12-18
- 0.2.4 — 2015-10-21
- … 7 more at https://npm.io/package/assemble-loader/versions

## README

# assemble-loader [![NPM version](https://img.shields.io/npm/v/assemble-loader.svg?style=flat)](https://www.npmjs.com/package/assemble-loader) [![NPM monthly downloads](https://img.shields.io/npm/dm/assemble-loader.svg?style=flat)](https://npmjs.org/package/assemble-loader)  [![NPM total downloads](https://img.shields.io/npm/dt/assemble-loader.svg?style=flat)](https://npmjs.org/package/assemble-loader) [![Linux Build Status](https://img.shields.io/travis/assemble/assemble-loader.svg?style=flat&label=Travis)](https://travis-ci.org/assemble/assemble-loader)

> 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](https://www.npmjs.com/):

```sh
$ npm install --save assemble-loader
```

## Usage

```js
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

```js
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:

```js
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.

```js
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.

```js
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](https://www.npmjs.com/package/load-templates): Load templates/views using globs, file paths, objects, arrays, or key-value pairs. | [homepage](https://github.com/jonschlinkert/load-templates "Load templates/views using globs, file paths, objects, arrays, or key-value pairs.")
* [matched](https://www.npmjs.com/package/matched): Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and… [more](https://github.com/jonschlinkert/matched) | [homepage](https://github.com/jonschlinkert/matched "Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and resolving to global npm modules.")
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ 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:

```sh
$ npm install && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
MIT

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 20, 2017._

---
_Source: https://npm.io/package/assemble-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._