Common-config NPM

common-config

Config store for values that are commonly needed by project scaffolders, like Generate or Yeoman.

CLI

Installation

Install globally with npm

$ npm install --global common-config

Usage

$ common-config --help

  Usage: common-config <command> [value]

  Commands:
    --init, -i  Initialize a prompt to store common values
    --set,  -s  Save a value to the common-config store
    --get,  -g  Show all values, or a specific value from the common-config store
    --del,  -d  Delete a value from the common-config store
    --help      Display this menu

init

Initialize a prompt session to populate the store with default values:

$ common-config --init

Properties

Answers are used to populate the following properties on the config.data object:

author.name
author.username
author.twitter
author.url
license

Questions

To get the values, the following questions are asked:

Full name?: Your full name, saved to the author.name property.
GitHub username?: Your GitHub username, saved to the author.username property.
Twitter username?: Twitter username, saved to the author.twitter property.
URL?: URL, saved to the author.url property.
Preferred license?: Preferred license to use when initializing new projects. Saved to the license property.

API

Installation

Install with npm:

$ npm install --save common-config

Usage

Add to your application using node.js require() system:

var config = require('common-config');

config.set('author.name', 'Jon Schlinkert');
config.set('author.username', 'jonschlinkert');

console.log(config.get('author.name'));
//=> 'Jon Schlinkert'

console.log(config.get('author.username'));
//=> 'jonschlinkert'

console.log(config.get('author'));
//=> {name: 'Jon Schlinkert', username: 'jonschlinkert'}

console.log(config.data);
//=> {author: {name: 'Jon Schlinkert', username: 'jonschlinkert'}}

See the unit tests for more examples.

About

Related projects

You might also be interested in these projects:

base-store: Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object… more | homepage
data-store: Easily get, set and persist config data. | homepage