universal-config-manager
v1.0.2
Published
A universal configuration manager that loads and merges config files from JSON, YAML, and ENV formats with environment-specific overrides.
Downloads
2
Maintainers
Readme
Universal Config Manager
A universal configuration manager that loads and merges config files from JSON, YAML, and ENV formats with environment-specific overrides.
Installation
npm install universal-config-manager
Setup
Create Configuration Files
In the root of your project, create a config directory:
mkdir config
Add Configuration Files
Inside the config
directory, add your configuration files in the following formats:
- JSON (
default.json
,development.json
,production.json
) ... - YAML (
default.yaml
,development.yaml
,production.yaml
) ... - ENV (
.env.default
,.env.development
,.env.production
) ...
Usage - merge all config files
const loadConfig = require('universal-config-manager');
const config = loadConfig();
console.log(config);
Usage - merge some config files
const loadConfig = require('universal-config-manager');
const config = loadConfig({ files: ['default.json', 'development.yaml'] });
console.log(config)
Usage - workspace based merge
const loadConfig = require('universal-config-manager');
const config = loadConfig({ env: 'production' });
console.log(config);
Configuration Files
Place your configuration files in a config
directory at the root of your project. The following formats are supported:
- JSON (
default.json
,development.json
,production.json
) - YAML (
default.yaml
,development.yaml
,production.yaml
) - ENV (
.env.default
,.env.development
,.env.production
)
The configurations will be merged in the following order of precedence (from lowest to highest):
default.json
,default.yaml
,.env.default
development.json
,development.yaml
,.env.development
(or corresponding environment)