# base-config-schema

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

Latest version **0.1.24** (published 2017-05-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install base-config-schema
pnpm add base-config-schema
yarn add base-config-schema
bun add base-config-schema
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.24 |
| Published | 2017-05-05 |
| First published | 2016-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.0 |
| Dependencies | 18 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | api, app, application, base, base-plugin, baseplugin, building-blocks, config, create, framework, normalize, plugin, plugins, schema, tool, toolkit, tools |

## Links

- npm: https://www.npmjs.com/package/base-config-schema
- Repository: https://github.com/node-base/base-config-schema
- Issues: https://github.com/node-base/base-config-schema/issues
- npm.io page: https://npm.io/package/base-config-schema

## Dependencies (18)

- [debug](https://npm.io/package/debug.md) ^2.6.6
- [kind-of](https://npm.io/package/kind-of.md) ^3.2.0
- [matched](https://npm.io/package/matched.md) ^0.4.4
- [resolve](https://npm.io/package/resolve.md) ^1.3.3
- [base-pkg](https://npm.io/package/base-pkg.md) ^0.2.4
- [has-glob](https://npm.io/package/has-glob.md) ^1.0.0
- [has-value](https://npm.io/package/has-value.md) ^0.3.1
- [camel-case](https://npm.io/package/camel-case.md) ^3.0.0
- [inflection](https://npm.io/package/inflection.md) ^1.12.0
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.2
- [map-schema](https://npm.io/package/map-schema.md) ^0.2.4
- [mixin-deep](https://npm.io/package/mixin-deep.md) ^1.2.0
- [arr-flatten](https://npm.io/package/arr-flatten.md) ^1.0.3
- [array-unique](https://npm.io/package/array-unique.md) ^0.3.2
- [export-files](https://npm.io/package/export-files.md) ^2.1.1
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
- [load-templates](https://npm.io/package/load-templates.md) ^1.0.2
- [define-property](https://npm.io/package/define-property.md) ^1.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.1.24 (latest) — 2017-05-05
- 0.1.22 — 2016-08-09
- 0.1.21 — 2016-07-30
- 0.1.20 — 2016-07-30
- 0.1.19 — 2016-07-29
- 0.1.18 — 2016-07-13
- 0.1.17 — 2016-07-13
- 0.1.16 — 2016-07-13
- 0.1.15 — 2016-06-15
- 0.1.14 — 2016-06-09
- 0.1.13 — 2016-06-01
- 0.1.12 — 2016-05-23
- 0.1.11 — 2016-05-23
- 0.1.10 — 2016-05-23
- 0.1.9 — 2016-04-28
- … 8 more at https://npm.io/package/base-config-schema/versions

## README

# base-config-schema [![NPM version](https://img.shields.io/npm/v/base-config-schema.svg?style=flat)](https://www.npmjs.com/package/base-config-schema) [![NPM downloads](https://img.shields.io/npm/dm/base-config-schema.svg?style=flat)](https://npmjs.org/package/base-config-schema) [![Build Status](https://img.shields.io/travis/node-base/base-config-schema.svg?style=flat)](https://travis-ci.org/node-base/base-config-schema)

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

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save base-config-schema
```

## Usage

```js
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](lib/fields/asyncHelpers.js#L21)

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

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

### [.disable](lib/fields/disable.js#L16)

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

**Example**

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

### [.enable](lib/fields/enable.js#L16)

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

**Example**

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

## About

### Related projects

* [base-cli](https://www.npmjs.com/package/base-cli): Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… [more](https://github.com/node-base/base-cli) | [homepage](https://github.com/node-base/base-cli "Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a few plugins, like 'base-store', 'base-options' and 'base-data'.")
* [base-config](https://www.npmjs.com/package/base-config): base-methods plugin that adds a `config` method for mapping declarative configuration values to other 'base… [more](https://github.com/node-base/base-config) | [homepage](https://github.com/node-base/base-config "base-methods plugin that adds a `config` method for mapping declarative configuration values to other 'base' methods or custom functions.")
* [base-option](https://www.npmjs.com/package/base-option): Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme… [more](https://github.com/node-base/base-option) | [homepage](https://github.com/node-base/base-option "Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme for the full API.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_

To generate the readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-generate-readme && verb
```

### Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

### License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/node-base/base-config-schema/blob/master/LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.28, on July 30, 2016._

---
_Source: https://npm.io/package/base-config-schema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._