jonschlinkert/common-config

Config store for setting/getting globally available values that are commonly needed for project scaffolders, like Generate or Yeoman.

common-config

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

TOC

• CLI
  • Installation
  • Usage
  • init
• API
  • Installation
  • Usage
• About
  • Related projects
  • Contributing
  • Running tests
  • Author
  • License

(TOC generated by verb using markdown-toc)

It's common for build systems, project scaffolders and other applications to need certain basic information about the user. For example, author.name might be used for populating templates or commit messages, etc.

This library is an API and CLI for setting and getting these commonly needed values from a config store in the ~/.data-store/common-config directory.

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

Contributing

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

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, v0.9.0, on July 11, 2016.