Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/constantiner/resolve-node-configs-hierarchy
Fight configuration headaches for different environments without pain
https://github.com/constantiner/resolve-node-configs-hierarchy
configuration configuration-files configuration-management dotenv env environment environment-variables hierarchical-configuration javascript library nodejs
Last synced: about 2 months ago
JSON representation
Fight configuration headaches for different environments without pain
- Host: GitHub
- URL: https://github.com/constantiner/resolve-node-configs-hierarchy
- Owner: Constantiner
- License: mit
- Created: 2018-10-09T14:10:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:36:12.000Z (about 2 years ago)
- Last Synced: 2024-08-09T23:05:24.044Z (5 months ago)
- Topics: configuration, configuration-files, configuration-management, dotenv, env, environment, environment-variables, hierarchical-configuration, javascript, library, nodejs
- Language: JavaScript
- Homepage: https://constantiner.github.io/resolve-node-configs-hierarchy/
- Size: 3.37 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# resolve-node-configs-hierarchy
[](https://travis-ci.org/Constantiner/resolve-node-configs-hierarchy) [](https://codecov.io/gh/Constantiner/resolve-node-configs-hierarchy)
Simple library to resolve configuration files hierarchy in Node projects for producing effective configuration from them.
It is very convenient if you need to have local configuration for local environment and not place it in version control system. Or to have separate configurations for `development` or `test` or `production` environments to apply them automatically.
So the library allows to manage configurations for any environment and the same code base.
**Note** Don't forget to put `local` files to `.gitignore`.
- [Changelog](#changelog)
- [Documentation](#documentation)
- [getConfigFiles](#getconfigfiles)
- [getConfigFile](#getconfigfile)
- [getConfigFilesSync](#getconfigfilessync)
- [getConfigFileSync](#getconfigfilesync)
- [Installation](#installation)
- [Usage](#usage)
## Changelog
Versions [changelog](docs/CHANGELOG.md).
## Documentation
See the full documentation [here](https://constantiner.github.io/resolve-node-configs-hierarchy/).
The utility was inspired by [create-react-app](https://github.com/facebook/create-react-app) and may contain some chunks of code from it.
**Note** To use in Node environment, not in browser.
The base idea is [the following](https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use):
It will list the following files, starting from the bottom. The first value set (or those already defined in the environment) take precedence:
* `.env` - The Original®
* `.env.development`, `.env.test`, `.env.production` - Environment-specific settings.
* `.env.local` - Local overrides. This file is loaded for all environments except test (you can include it with flag as the second parameter).
* `.env.development.local`, `.env.test.local` (for `test` environment you can include it with flag as the second parameter), `.env.production.local` - Local overrides of environment-specific settings.
It uses `process.env.NODE_ENV` for setting environment.
For test environment it will not list `.env.local` and `.env.test.local` from this list by default since normally you expect tests to produce the same results for everyone. You can include them by passing the second parameter with `true` value.
It may use any relative path as the base path even with extension.
It contains the following methods:
### getConfigFiles
Returns a list of absolute file paths of existing files in the order to apply from first to last (in order of precedence).
for example if you pass `"configuration/log4js.json"` it will produce the following list for development environment (if all of these files are exist in file system):
* `/configuration/log4js.development.local.json`
* `/configuration/log4js.local.json`
* `/configuration/log4js.development.json`
* `/configuration/log4js.json`
This utility is asynchronous and returns a promise resolving to file list. Use [`getConfigFilesSync`](#getconfigfilessync) for synchronous version.
This utility was inspired by [create-react-app](https://github.com/facebook/create-react-app) and may contain some chunks of code from it.
**Note** The bundle contains only ES6 modules version. Use Babel, Rollup, Webpack etc. to produce commonjs version.
### getConfigFile
Returns the most relevant absolute file path of existing files in files hierarchy.
for example if you pass `"configuration/log4js.json"` it will return the following file path for development environment (if it exists in file system):
* `/configuration/log4js.development.local.json`
This utility is asynchronous and returns a promise resolving to absolute file path as `String` (or resolving to `null`). Use [`getConfigFileSync`](#getconfigfilesync) for synchronous version.
### getConfigFilesSync
Synchronous version of [`getConfigFiles`](#getconfigfiles).
### getConfigFileSync
Synchronous version of [`getConfigFile`](#getconfigfile).
## Installation
```bash
npm install @constantiner/resolve-node-configs-hierarchy
```
## Usage
Import it first:
```JavaScript
import { getConfigFiles } from "@constantiner/resolve-node-configs-hierarchy";
```
Then you can use it:
```JavaScript
getConfigFiles("src/.env").then(files => {
files.forEach(file => {
dotenv.config({
path: file
})
})
});
```
Or for getting the single most actual config file:
```JavaScript
import { getConfigFile } from "@constantiner/resolve-node-configs-hierarchy";
getConfigFile("src/.env").then(filePath => {
if (filePath) {
const config = require(filePath);
}
});
```
To include `local` files in `test` environment you may pass corresponding flag (it is `false` by default):
```JavaScript
getConfigFiles("src/.env", true).then(files => {
files.forEach(file => {
dotenv.config({
path: file
})
})
});
```
Or the same for `getConfigFile`:
```JavaScript
getConfigFile("src/.env", true).then(filePath => {
if (filePath) {
const config = require(filePath);
}
});
```
The same is for synchronous versions:
```JavaScript
import { getConfigFilesSync } from "@constantiner/resolve-node-configs-hierarchy";
```
Then you can use it:
```JavaScript
getConfigFilesSync("src/.env").forEach(file => {
dotenv.config({
path: file
})
});
```
Or for getting the single most actual config file:
```JavaScript
import { getConfigFileSync } from "@constantiner/resolve-node-configs-hierarchy";
const filePath = getConfigFileSync("src/.env");
if (filePath) {
const config = require(filePath);
}
```