JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6
  • Score
    100M100P100Q31440F
  • License MIT

Base plugin that adds support for generating files from a declarative scaffold configuration.

Package Exports

  • base-scaffold

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (base-scaffold) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

base-scaffold NPM version NPM downloads Build Status

Base plugin that adds support for generating files from a declarative scaffold configuration.

Install

Install with npm:

$ npm install --save base-scaffold

Usage

Can be used with any base application. See example base applications.

var scaffold = require('base-scaffold');

API

.isScaffold

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

.scaffold

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'
    }
  }
});

Scaffold

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();

Base apps

The following projects are built on base.

  • assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
  • generate: Generate is a command line tool and developer framework for scaffolding out new GitHub projects… 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

About

related-list

Contributing

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

Building docs

(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

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on July 11, 2016.