boneskull / rc-yaml

Extend the "rc" module with YAML parsing
2 stars 3 forks source link
cli config configuration json parse parsing rc rc-yaml yaml

rc-yaml

rc + YAML - INI = this module

This module cannibalizes the rc module and tries to parse a YAML "rc" file, in addition to JSON and INI formats.

Key Differences Between this and rc

Usage

var rc = require('rc-yaml');

var config = rc('name', {
  defaults: 'go here'
});

Custom parsers are still supported. See rc's README.md for full usage.

If you just want the parsing function for some reason, it's accessible via:

var parser = require('rc-yaml').parser;

A Note About Peer Dependencies

This module depends on the rc module, which means installing them both side-by-side is unnecessary. One or the other, people.

Using peerDependencies here may be more politically correct, but at a cost. Since rc is "for lazy people", when in Rome...

Author, Somewhat

Christopher Hiller

License

MIT