Base plugin that adds support for generating files from a declarative scaffold configuration.
Install with npm:
$ npm install --save base-scaffold
Can be used with any base application. See example base applications.
var scaffold = require('base-scaffold');
Returns true if the given value is a valid Scaffold.
Params
val {any}returns {Boolean}Example
app.isScaffold('foo');
//=> false
var Scaffold = require('scaffold');
var scaffold = new Scaffold();
app.isScaffold(scaffold);
//=> true
Get scaffold name from app.scaffolds, or set scaffold name with the given config.
Params
name {String|Object|Function}config {Object|Fucntion}returns {Object}: Returns the app instance when setting a scaffold, or the scaffold instance when getting a scaffold.Example
app.scaffold('foo', {
docs: {
options: {},
files: {
src: ['*'],
dest: 'foo'
}
}
});
// or
var scaffold = app.scaffold('foo');
Params
name {String}config {Object|Function}Example
app.addScaffold('foo', {
docs: {
options: {},
files: {
src: ['*'],
dest: 'foo'
}
}
});
Params
name {String}options {Object}Example
var scaffold = app.getScaffold('foo');
// or create an instance of `Scaffold` using the given object
var scaffold = app.getScaffold({
docs: {
options: {},
files: {
src: ['*'],
dest: 'foo'
}
}
});
Get or set the Scaffold constructor. Exposed as a getter/setter to allow it to be customized before or after instantiation.
Example
// set
app.Scaffold = CustomScaffoldFn;
// get
var scaffold = new app.Scaffold();
The following projects are built on base.
related-list
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This document was generated by verb-readme-generator (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
Generate readme and API documentation with verb:
$ npm install -g verb verb-readme-generator && 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, v0.9.0, on July 11, 2016.