Load your configuration in hierarchy. If exists the following occurs:
package.json
is read (mainly useful for name
and version
).
global config
file is read, and deeply merged with the existing object.
environment config
file is finally read, deeply merging with the existing object.
Config-Handler doesn't modify any existing files, simply reads the configuration, deep merge occurs so entire blocks aren't erased.
const config = require('config-handler')();
console.log(config) // { name: 'hi', verion: '1.0.0' } ...
Here is an example of how the config object is handled:
// package.json
{
name: 'my-project',
version: '1.0.0'
}
// config/all.js
module.exports = {
server: {
port: 3000,
db: {
user: 'name',
pass: 'secr3t'
}
}
}
// assume either NODE_ENV=development or not set
// config/development.js
module.exports = {
server: {
port: 3333,
db: {
pass: 'supersecr3t'
}
}
}
Resulting config object:
{
name: 'my-project',
version: '1.0.0',
server: {
port: 3333,
db: {
user: 'name',
pass: 'supersecr3t'
}
}
}
Check out the test folder and example folder for more!
$ npm install config-handler
- Deeply merge multiple configuration files in hierarchy.
- Includes package.json if exists.
- Loads global configuration file.
- Loads local environment configuration file.
- Catches errors in config files.
- Configurable.
- Supports
.js
,.json
,.node
extensions. - Simple, fast and light-weight.
- Written in ES6+ for node.js 6+
The options are passed in as an object to the config:
const config = require('config')({ /* options */ });
dir
- {string} - Name of the config dir, defaults toconfig
.log
- {boolean} - Whether or not to output logging, defaults tofalse
.cwd
- {string} - Current working directory location, defaults toprocess.cwd()
env
- {string} - environment name for local config file, defaults toNODE_ENV
ordevelopment
.global
- {string} - name of the global config file to load, defaults toall
.logger
- {function | object} - logger to use, defaults toconsole
.
From the package
$ npm test