Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stopsopa/dotenv-up
https://github.com/stopsopa/dotenv-up
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/stopsopa/dotenv-up
- Owner: stopsopa
- License: mit
- Created: 2019-01-13T22:34:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T01:15:06.000Z (about 2 years ago)
- Last Synced: 2024-10-05T00:09:00.128Z (about 1 month ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/dotenv-up)
[](https://github.com/stopsopa/dotenv-up/blob/master/LICENSE)
# Installation
```bash
yarn add dotenv-up
```
# Reference
```javascript
require('dotenv-up')(3, true, 'sandbox/server.js');
/**
* Use like
* require('dotenv-up')(2); // 2 - default assigned to 'deep' parameter
* require('dotenv-up')(2, false); // second param is "debug" flag - to show on not show each step on the screen
* require('dotenv-up')(2, false, 'name of load'); // plain text to describe individual use of this library
* require('dotenv-up')({
path = process.cwd(),
envfile = '.env',
override = true, // override values in process.env
deep = 1,
startfromlevel = 0,
justreturn = false, // don't add found values to the process.env global object
... other dotenv options https://www.npmjs.com/package/dotenv
* });
*
* @param opt
* @param debug (def: true)
* @param name
* @returns {} - object with all extracted variables
*/
```
# Docker use
```javascript
require('dotenv-up')({
override : false, // don't override existing parameters in process.env by those from .env file
deep : 3,
}, true, 'sandbox/server.js');
// instead of:
require('dotenv-up')(3, true, 'sandbox/server.js');
// because 'override' flag is by default true
```
# Stacking config in given order from multiple files
```javascript
const directly = require.main === module;
require('dotenv-up')({
deep : 2,
startfromlevel : 1,
}, !directly, 'index.server');
require('dotenv-up')({
deep : 1,
}, !directly, 'index.server');
if (directly) {
console.log(JSON.stringify(process.env, null, 4));
process.exit(0);
}
module.exports = () => {
return {
origin: "http://localhost:" + process.env.NODE_PORT,
delayms: 0.2 * 1000,
}
}
```
# Todo
- [ ] Early detection of spaces around "=" https://imgur.com/a/wWml96T
# Tip
If you need to include other file that use internally again dotenv-up tool in override mode but you don't want those changes of process.env affect proce.env in you'r scope, do:
const ttt = {...process.env};
require('./lib/lib.js') // with its own require('dotenv-up')(1);
process.env = ttt;