@northscaler/config-custom-environment-variables-generator
Version:
Generator of config/custom-environment-variables.json File for config-Based Projects
161 lines (133 loc) • 5.48 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: src/generator.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: src/generator.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>'use strict'
const path = require('path')
const DEFAULT_PREFIX = 'NODE_APP'
const DEFAULT_NO_PREFIX = false
const PACKAGE_NAME_PREFIX_PLACEHOLDER = '@'
const DEFAULT_SEPARATOR = '_'
const CASING_UPPER = 'upper'
const CASING_LOWER = 'lower'
const CASING_UNCHANGED = 'unchanged'
const DEFAULT_CASING = CASING_UPPER
const DEFAULT_EMPTIES = false
/**
* Generates an object suitable for use with [config](https://npmjs.com/package/config)'s `config/custom-environment-variables.json`, skipping any functions encountered in the given object.
* Example:
* ```
* const fs = require('fs');
* const config = require('config');
* const cev = require('config-custom-environment-variables-generator');
* fs.writeFileSync('config/custom-environment-variables.json', JSON.stringify(cev.generate(config, { prefix: 'MYAPP' }), null, 2)));
* ```
* @param {object} obj An object, most likely the one returned by `require('config')`.
* @param {string} [opts.prefix='NODE_APP'] Prefix to use on environment variables. Use `@` to use the name of your application (see exported `DEFAULT_PREFIX`).
* @param {boolean} [opts.noPrefix=false] Overrides use of any prefix (see exported `DEFAULT_NO_PREFIX`).
* @param {separator} [opts.separator='_'] The word separator in environment variables (see exported `DEFAULT_SEPARATOR`).
* @param {'upper'|'lower'|undefined} [opts.casing='upper'] The case to use. `upper` forces upper case, `lower` forces lower case, else case is unchanged (see exported `DEFAULT_CASING`, `CASING_UPPER`, `CASING_LOWER`, and `CASING_UNCHANGED`).
* @param {boolean} [opts.empties=false] If `true`, preserves empty objects that didn't have any environment variables, else skips entries that wouldn't have any environment variables (functions are always skipped).
* @param {object} [opts.formats={}] If given, must be an object that specifies the __format value for the corresponding key of the first argument,
* @returns {object} An object containing the generated environment variables for each key in the input object.
*/
const generate = function generate (obj, opts) {
obj = obj || {}
opts = opts || {}
opts.formats = opts.formats || {}
let prefix = ''
const noPrefix = opts.noPrefix
if (!noPrefix) {
prefix = opts.prefix || module.exports.DEFAULT_PREFIX
if (prefix === PACKAGE_NAME_PREFIX_PLACEHOLDER) {
prefix = require(path.resolve('package.json')).name
}
}
const separator = opts.separator || module.exports.DEFAULT_SEPARATOR
const keys = Object.keys(opts)
const casing = keys.indexOf('casing') === -1
? DEFAULT_CASING
: opts.casing.toString().toLowerCase()
const empties = keys.indexOf('empties') === -1
? DEFAULT_EMPTIES
: (!!opts.empties)
const vars = {}
Object.keys(obj).forEach(function (key) {
if ((obj[key] instanceof Function)) {
return null // skip
}
if (obj[key] instanceof Object) { // recurse
const pre = applyCasing((prefix ? (prefix + separator) : '') + key, casing)
vars[key] = generate(obj[key], {
prefix: pre,
separator: separator,
casing: casing,
empties: empties,
formats: opts.formats[key]
})
if ((!Object.keys(vars[key]).length) && !empties) delete vars[key]
} else { // add
const v = applyCasing((prefix ? prefix + separator : '') + key, casing)
// support __format feature
if (opts.formats[key]) {
vars[key] = {
__name: v,
__format: opts.formats[key]
}
} else {
vars[key] = v
}
}
})
return vars
}
function applyCasing (value, casing) {
value = value.toString()
switch (casing) {
case CASING_UPPER:
return value.toUpperCase()
case CASING_LOWER:
return value.toLowerCase()
default: // CASING_UNCHANGED
return value
}
}
module.exports = generate
module.exports.generate = generate
module.exports.DEFAULT_PREFIX = DEFAULT_PREFIX
module.exports.DEFAULT_NO_PREFIX = DEFAULT_NO_PREFIX
module.exports.DEFAULT_SEPARATOR = DEFAULT_SEPARATOR
module.exports.DEFAULT_EMPTIES = DEFAULT_EMPTIES
module.exports.DEFAULT_CASING = DEFAULT_CASING
module.exports.CASING_UPPER = CASING_UPPER
module.exports.CASING_LOWER = CASING_LOWER
module.exports.CASING_UNCHANGED = CASING_UNCHANGED
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#generate">generate</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sat Jan 15 2022 05:15:30 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>