README
aio-cna-core-config
This is a nodejs module to allow management of persistant and environment variable configuration.
The module can be added to your project with:
> yarn add aio-cna-core-config
or
> npm install aio-cna-core-config --save
Here is a snippet:
const config = require('aio-cna-core-config')
// set a key value
config.set('pgb.authtoken', 1234)
// reload data from files and environmental variables
config.reload()
// get all stored data
config.get()
// get data from a given key
config.get('pgb.authtoken')
// delete a key
config.delete('pgb.authtoken')
Peristent File Locations
User Configuration
The user default location is:
- ENV['AIO_CONFIG_FILE']
- ENV['XDG_CONFIG_HOME']/aio
- <HOME>/.config/aio
depending on whether the specified environmental variables exist
Project Configuration
Local configuration is loaded from $PWD/.aio
Dot Env Configuration
A local .env file is also loaded. This file can contain environmental variables
Resolving Values
Resolving configuration is done in two steps:
- .env file is read, parsed and hoisted to environment variables ( process.env )
- user and local files are read
Inheritance is similar to NPMRC and can be set using user file, project file and matching environment variables. Values are read and merged in the following order in increasing priority:
- user config eg. ~/.config/aio
- project config eg. $PWD/.aio
- environment variables matching AIO_<PLUGIN>_<KEY>
$ AIO_PGB_AUTHTOKEN=1234 node
> config.get('pgb.authtoken')
1234
$ AIO_PGB_AUTH__TOKEN=1234 node # use double underscores to specify an underscore
> config.get('pgb.auth_token')
1234
Contributing
Contributions are welcomed! Read the Contributing Guide for more information.
Licensing
This project is licensed under the Apache V2 License. See LICENSE for more information.