Generate a scaffold from a declarative configuration.
Install with npm:
$ npm install --save generate-scaffold
var scaffolds = require('generate-scaffold');
var scaffolds = require('generate-scaffold');
var generate = require('generate');
var Scaffold = require('scaffold');
var scaffold = new Scaffold();
var app = generate();
app.use(scaffolds);
/**
* Add a basic "target" to our scaffold. Scaffolds are like
* grunt "tasks" and can have any number of targets
*/
scaffold.addTarget('abc', {
options: {
pipeline: generate.renderFile,
data: {
site: { title: 'My Blog' }
}
},
src: 'templates/*.hbs',
dest: 'site',
});
/**
* Template engine for rendering handlebars templates
*/
app.engine('hbs', require('engine-handlebars'));
/**
* Generate the scaffold!
*/
app.scaffold('site', scaffold)
.generate()
.on('error', console.log)
.on('data', console.log)
.on('end', function() {
console.log('done!');
});
See the scaffold library for additional information.
Asynchronously generate files from a declarative scaffold configuration.
Params
scaffold {Object}: Scaffold configuration object.cb {Function}: Optional callback function. If not passed, .scaffoldStream will be called and a stream will be returned.Example
var Scaffold = require('scaffold');
var scaffold = new Scaffold({
options: {cwd: 'source'},
posts: {
src: ['content/*.md']
},
pages: {
src: ['templates/*.hbs']
}
});
app.scaffoldSeries(scaffold, function(err) {
if (err) console.log(err);
});
Generate files from a declarative scaffold configuration.
Params
config {Object}: scaffold configuration object.returns {Stream}: returns a stream with all processed files.Example
var Scaffold = require('scaffold');
var scaffold = new Scaffold({
options: {cwd: 'source'},
posts: {
src: ['content/*.md']
},
pages: {
src: ['templates/*.hbs']
}
});
app.scaffoldStream(scaffold)
.on('error', console.error)
.on('end', function() {
console.log('done!');
});
Breaking changes
app.use(scaffold()), you should now do app.use(scaffold).Fixed
Added
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.28, on July 29, 2016.