https://github.com/joeybaker/jace

JSON Ampersand Configuration by Environment State
https://github.com/joeybaker/jace

Last synced: 6 days ago
JSON representation

JSON Ampersand Configuration by Environment State

• Host: GitHub
• URL: https://github.com/joeybaker/jace
• Owner: joeybaker
• License: other
• Created: 2014-08-03T00:34:27.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-07T01:34:48.000Z (over 10 years ago)
• Last Synced: 2024-12-27T02:10:03.043Z (20 days ago)
• Language: JavaScript
• Size: 184 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JACE

[![NPM](https://nodei.co/npm/jace.png)](https://nodei.co/npm/jace/) [![Build Status](https://travis-ci.org/joeybaker/jace.png?branch=master)](https://travis-ci.org/joeybaker/jace)

Node project configuration. Jace sounds like brace. Braces support things. Jace supports the whole project.

Jace is a configuration library for a node project that recognizes several levels of overrides. [ALCE](https://github.com/walmartlabs/ALCE) is used for JSON parsing so your JSON can have comments.

The order of preference, higher numbers override lower numbers.

1. default.json

2. {env}.json // env is determined by the `NODE_ENV` bash variable, or by the `env` option.

3. bash env vars, converted to nested objects.

4. options object

Every level merges and overrides the previous.

## Install

`npm i -S jace`

## Usage

```js

var jace = require('jace')

  , options = {

    db: {

      user: 'me'

    }

    , users: 0

    // defaults to './config'

    , configPath: __dirname

  }

  , config = jace(options)

// config is an ampersand-state object

config.env // will be the value of process.env.NODE_ENV if set, else 'default'

config.db.user // 'me'

```

### Setting env vars

Bash environmental variables are set with `export MY_VAR=rabbit`. Jace converts snake case (underscore separated) env vars into nested objects.

`MY_RABBIT=fluffy` becomes `{my: {rabbit: 'fluffy'}}`

`MY_RABBIT=fluffy; MY_BUNNY=cottontail` becomes `{my: {rabbit: 'fluffy', bunny: 'cottontail'}}`

## Options

### ` configPath`

Where should we look for `default.json` and other config files? Defaults to `./config`.

### ` allEnv`

Defaults to `false`. If `true`, will pull in all env vars, not just the ones defined in a JSON config file or the options.

NOTE: most systems have many irrelvant env vars. It's easy to pollute your config with uncessary properties if you turn this on.

## Tests

Tests are [prova](https://github.com/azer/prova), based on [tape](https://github.com/substack/tape). They can be run with `npm test`.

## Developing

To publish, run `gulp publish --bump=patch`

## Changelog

### 2.0.0

No longer uses ampersand-state for base config. It turned out too be too brittle and really, config should only be set once.

### 1.0.0

Initial Release