https://github.com/panates/ncfg

Configuration management library for Node.js
https://github.com/panates/ncfg

config configuration configuration-management environment environment-variables javascript node nodejs schema validation

Last synced: 3 months ago
JSON representation

Configuration management library for Node.js

• Host: GitHub
• URL: https://github.com/panates/ncfg
• Owner: panates
• License: mit
• Created: 2018-11-14T12:59:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T03:43:32.000Z (almost 2 years ago)
• Last Synced: 2024-07-30T05:36:54.875Z (3 months ago)
• Topics: config, configuration, configuration-management, environment, environment-variables, javascript, node, nodejs, schema, validation
• Language: JavaScript
• Size: 533 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
  

[![NPM Version][npm-image]][npm-url]

[![NPM Downloads][downloads-image]][downloads-url]

[![Build Status][travis-image]][travis-url]

[![Test Coverage][coveralls-image]][coveralls-url]

[![Dependencies][dependencies-image]][dependencies-url]

[![DevDependencies][devdependencies-image]][devdependencies-url]

[![Package Quality][quality-image]][quality-url]

## About NCfg (Nested-Configuration)

NCfg helps applications to manage configurations within nested nodes. This saves your day if your application has many sub modules. 

## Features

- *Nested structure:* Configuration organized in a tree structure

- *Environmental variables:* Values can be derived from environmental variables

- *Command-line arguments:* Values can also be derived from command-line arguments

- *Validation:* Configurations are validated against given schema. Can throw immediately or generate a report with all errors that are found

- *Multi parser support:* Can register many file parsers like (json5, hjson, yaml, etc..) 

You can report bugs and discuss features on the [GitHub issues](https://github.com/panates/ncfg/issues) page

## Installation

```bash

$ npm install ncfg --save

```

## Node Compatibility

  - node >= 6.x

  

## Change log

To see changelog click [here](https://github.com/panates/ncfg/commits/master)

  

### License

ncfg is available under [MIT](LICENSE) license.

[npm-image]: https://img.shields.io/npm/v/ncfg.svg

[npm-url]: https://npmjs.org/package/ncfg

[travis-image]: https://img.shields.io/travis/panates/ncfg/master.svg

[travis-url]: https://travis-ci.org/panates/ncfg

[coveralls-image]: https://img.shields.io/coveralls/panates/ncfg/master.svg

[coveralls-url]: https://coveralls.io/r/panates/ncfg

[downloads-image]: https://img.shields.io/npm/dm/ncfg.svg

[downloads-url]: https://npmjs.org/package/ncfg

[dependencies-image]: https://david-dm.org/panates/ncfg/status.svg

[dependencies-url]:https://david-dm.org/panates/ncfg

[devdependencies-image]: https://david-dm.org/panates/ncfg/dev-status.svg

[devdependencies-url]:https://david-dm.org/panates/ncfg?type=dev

[quality-image]: http://npm.packagequality.com/shield/ncfg.png

[quality-url]: http://packagequality.com/#?package=ncfg