base-config-schema

base-config-schema

Schema for the base-config plugin, used for normalizing config values before passing them to config.process().

Install

Install with npm:

$ npm install --save base-config-schema

Usage

var Base = require('base');
var config = require('base-config');
var configSchema = require('base-config-schema');

var app = new Base();
app.use(config());
var schema = configSchema(app);

var pkg = require('./package');
var obj = schema.normalize(pkg.verb);

app.config.process(obj, function(err) {
  if (err) throw err;
});

API

.asyncHelpers

Register async template helpers. Can be an array of module names or filepaths, or an object where the keys are filepaths or module names, and the values are options objects.

Example

{
  "asyncHelpers": ["helper-foo", "helper-bar"]
}

.disable

Disable one or more options. This is the API-equivalent of calling app.disable('foo'), or app.option('foo', false).

Example

{disable: 'foo'}
// or
{disable: ['foo', 'bar']}

.enable

Enable one or more options. This is the API-equivalent of calling app.enable('foo'), or app.option('foo', false).

Example

{enable: 'foo'}
// or
{enable: ['foo', 'bar']}

About

Related projects

• base-cli: Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… more | homepage
• base-config: base-methods plugin that adds a config method for mapping declarative configuration values to other 'base… more | homepage
• base-option: Adds a few options methods to base, like option, enable and disable. See the readme… more | homepage

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

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

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

This file was generated by verb-generate-readme, v0.1.28, on July 30, 2016.