Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
convict-dotenv
Advanced tools
Small Node.js library for settings/configuration. It uses dotenv with convict to provide a simple interface for getting config from the environment, including .env
files.
See convict for building your schema and create a .env
file in your project root (or elsewhere if you want to be explicit about it using an env var: DOTENV_CONFIG_PATH
).
Example:
const {getConfig} = require('convict-dotenv');
const schema = {
foo: {
env: 'FOO_EVAR',
format: String,
default: 'foodefault',
},
};
console.log(getConfig(schema).foo);
If you want to only parse your config if a specific enabled flag is set in your config, specify the prop, and it will be evaluated before parsing the rest of the config. If it's falsey, only the flag and any other defaults you pass will be returned:
const {getConfig} = require('convict-dotenv');
const schema = {
enabled: {
env: 'FOO_ENABLED',
format: String,
default: false,
},
somethingRequired: {
env: 'FOO_REQUIRED',
format: String,
default: null, // <== convicts way of making something required...
},
};
console.log(getConfig(schema, 'enabled', {theseAre: 'disabledDefaults'}));
/*
No error thrown and results in:
{
enabled: false,
theseAre: 'disabledDefaults'
}
*/
NODE_ENV
is set to test
, the default .env
location ${process.cwd()}/.env
) will not be loaded (you have to explicitly set DOTENV_CONFIG_PATH
if you want to load env vars from a file in tests: DOTENV_CONFIG_PATH=/somewhere/test.env node index.js
).process.env
shouldn't be changed by a library, which means not using dotenv package in it's standard setup: require('dotenv').config()
.Uses tap.
Run npm test
.
FAQs
Use convict with dotenv to build config
The npm package convict-dotenv receives a total of 80 weekly downloads. As such, convict-dotenv popularity was classified as not popular.
We found that convict-dotenv demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.