common-middleware    

> Common middleware for applications built with base-methods (like assemble, verb, generate, and update)

Install

Install with npm:

``sh
$ npm install --save common-middleware
`

Usage

`js
var middleware = require('common-middleware');
var assemble = require('assemble-core');

// create your app
var app = assemble();

// register the middleware
app.use(middleware());
`

Middleware

The following middleware are included.

$3

Parses front-matter on files that match options.extRegex and
adds the resulting data object to file.data. This object is
passed as context to the template engine at render time.

$3

Registers a .preWrite middleware for unescaping escaped delimiters.

$3

Uses C-style macros to escape templates with {%%= foo %} or
<%= foo %> syntax, so they will not be evaluated by a template
engine when .render is called.

$3

Adds a json property to the file object when the file extension
matches options.jsonRegex. This allows JSON files to be updated
by other middleware or pipeline plugins without having to parse and
stringify with each modification.

$3

If file.contents has not already been updated directly, the file.contents property
is updated with stringified JSON before writing the file back to the file
system.

Options

$3

Customize the regex used for matching JSON files.

Example

`js
app.use(middleware({jsonRegex: /\.json$/}));
`

$3

Customize the regex used for matching template file extensions.

Example

`js
app.use(middleware({jsonRegex: /\.(hbs|tmpl)$/}));
`

$3

Customize the regex used for matching the extensions of files with templates to escape.

Example

`js
app.use(middleware({jsonRegex: /\.(tmpl|hbs)$/}));
`

About

$3

* assemble-core: The core assemble application with no presets or defaults. All configuration is left to the… more | homepage
* base: Framework for rapidly creating high quality node.js applications, using plugins like building blocks | homepage
* generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
* update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
* verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

$3

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

$3

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

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

$3

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

$3

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

$3

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

*

_This file was generated by verb-generate-readme, v0.6.0, on July 16, 2017._