config 3.3.1 → 3.3.6

package/History.md

@@ -1,3 +1,32 @@
+3.3.6 / 2021-03-08
+==================
+
+* Added publishConfig element to package.json to prevent publishing to the wrong repository - @lorenwest
+
+3.3.5 / 2021-03-05
+==================
+
+* FIX [#628](https://github.com/lorenwest/node-config/issues/628) Uncaught ReferenceError: node_env_var_name is not defined @prnake
+
+3.3.4 / 2021-02-26
+==================
+
+* FIX #517 0 loadFileConfigs incorrectly adds to getConfigSources @NguyenMatthieu
+
+3.3.3 / 2020-11-26
+==================
+
+* FIX #460 - Strict mode warning refer to appropriate env variable @iCodeOkay
+* Use Buffer.alloc and Buffer.from instead of contrsuctor @Fcmam5
+* Add support for experimental .cjs modules @lenkan
+
+
+3.3.2 / 2020-09-24
+==================
+
+* Fixed issue with Buffers in config throwing error in util.makeImmutable (#608) - Michal Wadas
+* Added boolean and numeric types to custom environment variables - Ankur Narkhede @ankurnarkhede
+
 3.3.1 / 2020-03-25
 ==================
 

package/README.md

@@ -134,36 +134,36 @@ If you still don't see what you are looking for, here are some more resources to
 
 Contributors
 ------------
-<table id="contributors"><tr><td><img src=https://avatars2.githubusercontent.com/u/373538?v=4><a href="https://github.com/lorenwest">lorenwest</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/25829?v=4><a href="https://github.com/markstos">markstos</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/1083065?v=4><a href="https://github.com/iMoses">iMoses</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/447151?v=4><a href="https://github.com/elliotttf">elliotttf</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/8839447?v=4><a href="https://github.com/jfelege">jfelege</a></td>
-<td><img src=https://avatars0.githubusercontent.com/u/66902?v=4><a href="https://github.com/leachiM2k">leachiM2k</a></td>
-</tr><tr><td><img src=https://avatars1.githubusercontent.com/u/791137?v=4><a href="https://github.com/josx">josx</a></td>
-<td><img src=https://avatars2.githubusercontent.com/u/133277?v=4><a href="https://github.com/enyo">enyo</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/4307697?v=4><a href="https://github.com/leosuncin">leosuncin</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/1077378?v=4><a href="https://github.com/arthanzel">arthanzel</a></td>
-<td><img src=https://avatars2.githubusercontent.com/u/1656140?v=4><a href="https://github.com/eheikes">eheikes</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/138707?v=4><a href="https://github.com/th507">th507</a></td>
-</tr><tr><td><img src=https://avatars2.githubusercontent.com/u/506460?v=4><a href="https://github.com/Osterjour">Osterjour</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/1751645?v=4><a href="https://github.com/cunneen">cunneen</a></td>
-<td><img src=https://avatars0.githubusercontent.com/u/842998?v=4><a href="https://github.com/nsabovic">nsabovic</a></td>
-<td><img src=https://avatars0.githubusercontent.com/u/5138570?v=4><a href="https://github.com/BadgerBadgerBadgerBadger">BadgerBadgerBadgerBadger</a></td>
-<td><img src=https://avatars2.githubusercontent.com/u/2529835?v=4><a href="https://github.com/simon-scherzinger">simon-scherzinger</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/8650543?v=4><a href="https://github.com/leonardovillela">leonardovillela</a></td>
-</tr><tr><td><img src=https://avatars1.githubusercontent.com/u/175627?v=4><a href="https://github.com/axelhzf">axelhzf</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/7782055?v=4><a href="https://github.com/benkroeger">benkroeger</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/1872824?v=4><a href="https://github.com/fgheorghe">fgheorghe</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/1443067?v=4><a href="https://github.com/IvanVergiliev">IvanVergiliev</a></td>
-<td><img src=https://avatars0.githubusercontent.com/u/1736957?v=4><a href="https://github.com/jpwilliams">jpwilliams</a></td>
-<td><img src=https://avatars2.githubusercontent.com/u/1246875?v=4><a href="https://github.com/jaylynch">jaylynch</a></td>
-</tr><tr><td><img src=https://avatars1.githubusercontent.com/u/145742?v=4><a href="https://github.com/jberrisch">jberrisch</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/9355665?v=4><a href="https://github.com/kgoerlitz">kgoerlitz</a></td>
-<td><img src=https://avatars0.githubusercontent.com/u/8525267?v=4><a href="https://github.com/bertho-zero">bertho-zero</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/1918551?v=4><a href="https://github.com/nitzan-shaked">nitzan-shaked</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/3058150?v=4><a href="https://github.com/robertrossmann">robertrossmann</a></td>
-<td><img src=https://avatars2.githubusercontent.com/u/498929?v=4><a href="https://github.com/roncli">roncli</a></td>
+<table id="contributors"><tr><td><img src=https://avatars.githubusercontent.com/u/373538?v=4><a href="https://github.com/lorenwest">lorenwest</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/25829?v=4><a href="https://github.com/markstos">markstos</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1083065?v=4><a href="https://github.com/iMoses">iMoses</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/447151?v=4><a href="https://github.com/elliotttf">elliotttf</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/8839447?v=4><a href="https://github.com/jfelege">jfelege</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/66902?v=4><a href="https://github.com/leachiM2k">leachiM2k</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/791137?v=4><a href="https://github.com/josx">josx</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/133277?v=4><a href="https://github.com/enyo">enyo</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/4307697?v=4><a href="https://github.com/leosuncin">leosuncin</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1077378?v=4><a href="https://github.com/arthanzel">arthanzel</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1656140?v=4><a href="https://github.com/eheikes">eheikes</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/138707?v=4><a href="https://github.com/th507">th507</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/506460?v=4><a href="https://github.com/Osterjour">Osterjour</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1751645?v=4><a href="https://github.com/cunneen">cunneen</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/842998?v=4><a href="https://github.com/nsabovic">nsabovic</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/5138570?v=4><a href="https://github.com/BadgerBadgerBadgerBadger">BadgerBadgerBadgerBadger</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/2529835?v=4><a href="https://github.com/simon-scherzinger">simon-scherzinger</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/8650543?v=4><a href="https://github.com/leonardovillela">leonardovillela</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/175627?v=4><a href="https://github.com/axelhzf">axelhzf</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/7782055?v=4><a href="https://github.com/benkroeger">benkroeger</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1872824?v=4><a href="https://github.com/fgheorghe">fgheorghe</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1443067?v=4><a href="https://github.com/IvanVergiliev">IvanVergiliev</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1736957?v=4><a href="https://github.com/jpwilliams">jpwilliams</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1246875?v=4><a href="https://github.com/jaylynch">jaylynch</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/145742?v=4><a href="https://github.com/jberrisch">jberrisch</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/9355665?v=4><a href="https://github.com/kgoerlitz">kgoerlitz</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/8525267?v=4><a href="https://github.com/bertho-zero">bertho-zero</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/6686044?v=4><a href="https://github.com/NguyenMatthieu">NguyenMatthieu</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/1918551?v=4><a href="https://github.com/nitzan-shaked">nitzan-shaked</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/3058150?v=4><a href="https://github.com/robertrossmann">robertrossmann</a></td>
 </tr></table>
 
 License

package/async.js

@@ -43,7 +43,7 @@ function resolveAsyncConfigs(config) {
   (function iterate(prop) {
     var propsToSort = [];
     for (var property in prop) {
-      if (prop.hasOwnProperty(property) && prop[property] != null) {
+      if (Object.hasOwnProperty.call(prop, property) && prop[property] != null) {
         propsToSort.push(property);
       }
     }

package/lib/config.js

@@ -15,7 +15,7 @@ var deferConfig = require('../defer').deferConfig,
 // Static members
 var DEFAULT_CLONE_DEPTH = 20,
     NODE_CONFIG, CONFIG_DIR, RUNTIME_JSON_FILENAME, NODE_ENV, APP_INSTANCE,
-    HOST, HOSTNAME, ALLOW_CONFIG_MUTATIONS, CONFIG_SKIP_GITCRYPT,
+    HOST, HOSTNAME, ALLOW_CONFIG_MUTATIONS, CONFIG_SKIP_GITCRYPT, NODE_ENV_VAR_NAME,
     NODE_CONFIG_PARSER,
     env = {},
     privateUtil = {},
@@ -369,6 +369,9 @@ util.makeHidden = function(object, property, value) {
  * @return object {object} - The original object is returned - for chaining.
  */
 util.makeImmutable = function(object, property, value) {
+  if (Buffer.isBuffer(object)) {
+    return object;
+  }
   var properties = null;
 
   // Backwards compatibility mode where property/value can be specified
@@ -444,6 +447,29 @@ util.getConfigSources = function() {
   return configSources.slice(0);
 };
 
+/**
+ * Looks into an options object for a specific attribute
+ *
+ * <p>
+ * This method looks into the options object, and if an attribute is defined, returns it,
+ * and if not, returns the default value
+ * </p>
+ *
+ * @method getOption
+ * @param options {Object | undefined} the options object
+ * @param optionName {string} the attribute name to look for
+ * @param defaultValue { any } the default in case the options object is empty, or the attribute does not exist.
+ * @return options[optionName] if defined, defaultValue if not.
+ */
+util.getOption = function(options, optionName, defaultValue) {
+  if (options !== undefined && options[optionName] !== undefined){
+    return options[optionName];
+  } else {
+    return defaultValue;
+  }
+};
+
+
 /**
  * Load the individual file configurations.
  *
@@ -484,7 +510,7 @@ util.getConfigSources = function() {
  *
  * <p>
  * (deployment) is the deployment type, found in the $NODE_ENV environment
- * variable (which can be overriden by using $NODE_CONFIG_ENV
+ * variable (which can be overridden by using $NODE_CONFIG_ENV
  * environment variable). Defaults to 'development'.
  * </p>
  *
@@ -496,25 +522,42 @@ util.getConfigSources = function() {
  * <p>
  * If the $NODE_APP_INSTANCE environment variable (or --NODE_APP_INSTANCE
  * command line parameter) is set, then files with this appendage will be loaded.
- * See the Multiple Application Instances section of the main documentaion page
+ * See the Multiple Application Instances section of the main documentation page
  * for more information.
  * </p>
  *
  * @protected
  * @method loadFileConfigs
+ * @param configDir { string | null } the path to the directory containing the configurations to load
+ * @param options { object | undefined } parsing options. Current supported option: skipConfigSources: true|false
  * @return config {Object} The configuration object
  */
-util.loadFileConfigs = function(configDir) {
+util.loadFileConfigs = function(configDir, options) {
 
   // Initialize
   var t = this,
       config = {};
 
-  // Initialize parameters from command line, environment, or default
-  NODE_ENV = util.initParam('NODE_ENV', 'development');
+  // Specify variables that can be used to define the environment
+  var node_env_var_names = ['NODE_CONFIG_ENV', 'NODE_ENV'];
 
-  // Override, NODE_ENV if NODE_CONFIG_ENV is specified.
-  NODE_ENV = util.initParam('NODE_CONFIG_ENV', NODE_ENV);
+  // Loop through the variables to try and set environment
+  for (const node_env_var_name of node_env_var_names) {
+    NODE_ENV = util.initParam(node_env_var_name);
+    if (!!NODE_ENV) {
+      NODE_ENV_VAR_NAME = node_env_var_name;
+      break;
+    }
+  }
+
+  // If we haven't successfully set the environment using the variables, we'll default it
+  if (!NODE_ENV) {
+    NODE_ENV = 'development';
+  }
+
+  node_env_var_names.forEach(node_env_var_name => {
+    env[node_env_var_name] = NODE_ENV;
+  });
 
   // Split files name, for loading multiple files.
   NODE_ENV = NODE_ENV.split(',');
@@ -598,7 +641,7 @@ util.loadFileConfigs = function(configDir) {
 
   var locatedFiles = util.locateMatchingFiles(CONFIG_DIR, allowedFiles);
   locatedFiles.forEach(function(fullFilename) {
-    var configObj = util.parseFile(fullFilename);
+    var configObj = util.parseFile(fullFilename, options);
     if (configObj) {
       util.extendDeep(config, configObj);
     }
@@ -615,10 +658,13 @@ util.loadFileConfigs = function(configDir) {
         console.error('The $NODE_CONFIG environment variable is malformed JSON');
       }
       util.extendDeep(config, envConfig);
-      configSources.push({
-        name: "$NODE_CONFIG",
-        parsed: envConfig,
-      });
+      var skipConfigSources = util.getOption(options,'skipConfigSources', false);
+      if (!skipConfigSources){
+        configSources.push({
+          name: "$NODE_CONFIG",
+          parsed: envConfig,
+        });
+      }
     }
 
     // Override configurations from the --NODE_CONFIG command line
@@ -630,10 +676,13 @@ util.loadFileConfigs = function(configDir) {
         console.error('The --NODE_CONFIG={json} command line argument is malformed JSON');
       }
       util.extendDeep(config, cmdLineConfig);
-      configSources.push({
-        name: "--NODE_CONFIG argument",
-        parsed: cmdLineConfig,
-      });
+      var skipConfigSources = util.getOption(options,'skipConfigSources', false);
+      if (!skipConfigSources){
+        configSources.push({
+          name: "--NODE_CONFIG argument",
+          parsed: cmdLineConfig,
+        });
+      }
     }
 
     // Place the mixed NODE_CONFIG into the environment
@@ -695,7 +744,7 @@ util.resolveDeferredConfigs = function (config) {
 
     // First step is to put the properties of interest in an array
     for (var property in prop) {
-      if (prop.hasOwnProperty(property) && prop[property] != null) {
+      if (Object.hasOwnProperty.call(prop, property) && prop[property] != null) {
         propsToSort.push(property);
       }
     }
@@ -750,9 +799,10 @@ util.resolveDeferredConfigs = function (config) {
  * @protected
  * @method parseFile
  * @param fullFilename {string} The full file path and name
+ * @param options { object | undefined } parsing options. Current supported option: skipConfigSources: true|false
  * @return configObject {object|null} The configuration object parsed from the file
  */
-util.parseFile = function(fullFilename) {
+util.parseFile = function(fullFilename, options) {
   var t = this,  // Initialize
       configObject = null,
       fileContent = null,
@@ -794,8 +844,9 @@ util.parseFile = function(fullFilename) {
     throw new Error("Cannot parse config file: '" + fullFilename + "': " + e3);
   }
 
-  // Keep track of this configuration sources, including empty ones
-  if (typeof configObject === 'object') {
+  // Keep track of this configuration sources, including empty ones, unless the skipConfigSources flag is set to true in the options
+  var skipConfigSources = util.getOption(options,'skipConfigSources', false);
+  if (typeof configObject === 'object' && !skipConfigSources) {
     configSources.push({
       name: fullFilename,
       original: fileContent,
@@ -807,7 +858,7 @@ util.parseFile = function(fullFilename) {
 };
 
 /**
- * Parse and return the specied string with the specified format.
+ * Parse and return the specified string with the specified format.
  *
  * The format determines the parser to use.
  *
@@ -949,7 +1000,7 @@ util.cloneDeep = function cloneDeep(parent, depth, circular, prototype) {
     } else if (Utils.isDate(parent)) {
       child = new Date(parent.getTime());
     } else if (useBuffer && Buffer.isBuffer(parent)) {
-      child = new Buffer(parent.length);
+      child = Buffer.alloc(parent.length);
       parent.copy(child);
       return child;
     } else {
@@ -1005,7 +1056,7 @@ util.setPath = function (object, path, value) {
   }
   else {
     nextKey = path.shift();
-    if (!object.hasOwnProperty(nextKey)) {
+    if (!Object.hasOwnProperty.call(object, nextKey)) {
       object[nextKey] = {};
     }
     util.setPath(object[nextKey], path, value);
@@ -1020,9 +1071,9 @@ util.setPath = function (object, path, value) {
  *
  * @protected
  * @method substituteDeep
- * @param substitionMap {object} - an object whose terminal (non-subobject) values are strings
+ * @param substitutionMap {object} - an object whose terminal (non-subobject) values are strings
  * @param variables {object[string:value]} - usually process.env, a flat object used to transform
- *      terminal values in a copy of substititionMap.
+ *      terminal values in a copy of substitutionMap.
  * @returns {object} - deep copy of substitutionMap with only those paths whose terminal values
  *      corresponded to a key in `variables`
  */
@@ -1067,7 +1118,7 @@ util.substituteDeep = function (substitutionMap, variables) {
  *
  * @protected
  * @method getCustomEnvVars
- * @param CONFIG_DIR {string} - the passsed configuration directory
+ * @param CONFIG_DIR {string} - the passed configuration directory
  * @param extNames {Array[string]} - acceptable configuration file extension names.
  * @returns {object} - mapped environment variables or {} if there are none
  */
@@ -1239,7 +1290,7 @@ util.extendDeep = function(mergeInto) {
       var fromIsDeferredFunc = mergeFrom[prop] instanceof DeferredConfig;
       var isDeferredFunc = mergeInto[prop] instanceof DeferredConfig;
 
-      if (fromIsDeferredFunc && mergeInto.hasOwnProperty(prop)) {
+      if (fromIsDeferredFunc && Object.hasOwnProperty.call(mergeInto, prop)) {
         mergeFrom[prop]._original = isDeferredFunc ? mergeInto[prop]._original : mergeInto[prop];
       }
       // Extend recursively if both elements are objects and target is not really a deferred function
@@ -1406,15 +1457,15 @@ util.runStrictnessChecks = function (config) {
     });
     // development is special-cased because it's the default value
     if (env && (env !== 'development') && !anyFilesMatchEnv) {
-      _warnOrThrow("NODE_ENV value of '"+env+"' did not match any deployment config file names.");
+      _warnOrThrow(NODE_ENV_VAR_NAME+" value of '"+env+"' did not match any deployment config file names.");
     }
     // Throw if NODE_ENV matches' default' or 'local'
     if ((env === 'default') || (env === 'local')) {
-      _warnOrThrow("NODE_ENV value of '"+env+"' is ambiguous.");
+      _warnOrThrow(NODE_ENV_VAR_NAME+" value of '"+env+"' is ambiguous.");
     }
   });
 
-  // Throw an exception if there's no explict config file for NODE_APP_INSTANCE
+  // Throw an exception if there's no explicit config file for NODE_APP_INSTANCE
   var anyFilesMatchInstance = sourceFilenames.some(function (filename) {
       return filename.match(APP_INSTANCE);
   });

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "config",
-  "version": "3.3.1",
+  "version": "3.3.6",
   "main": "./lib/config.js",
   "description": "Configuration control for production node deployments",
   "author": "Loren West <open_source@lorenwest.com>",
   "homepage": "http://lorenwest.github.com/node-config",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
   "keywords": [
     "conf",
     "config",
@@ -41,7 +44,7 @@
     "url": "http://github.com/lorenwest/node-config.git"
   },
   "engines": {
-    "node": ">= 6.0.0"
+    "node": ">= 10.0.0"
   },
   "scripts": {
     "test": "./node_modules/vows/bin/vows test/*.js --spec"

package/parser.js

@@ -281,8 +281,33 @@ Parser.stripYamlComments = function(fileStr) {
   return fileStr.replace(/^\s*#.*/mg,'').replace(/^\s*[\n|\r]+/mg,'');
 };
 
-var order = ['js', 'ts', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml'];
+/**
+ * Parses the environment variable to the boolean equivalent.
+ * Defaults to false
+ *
+ * @param {String} content - Environment variable value
+ * @return {boolean} - Boolean value fo the passed variable value
+ */
+Parser.booleanParser = function(filename, content) {
+  return content === 'true';
+};
+
+/**
+ * Parses the environment variable to the number equivalent.
+ * Defaults to undefined
+ *
+ * @param {String} content - Environment variable value
+ * @return {Number} - Number value fo the passed variable value
+ */
+Parser.numberParser = function(filename, content) {
+  const numberValue = Number(content);
+  return Number.isNaN(numberValue) ? undefined : numberValue;
+};
+
+var order = ['js', 'cjs', 'ts', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml',
+  'boolean', 'number'];
 var definitions = {
+  cjs: Parser.jsParser,
   coffee: Parser.coffeeParser,
   cson: Parser.csonParser,
   hjson: Parser.hjsonParser,
@@ -296,6 +321,8 @@ var definitions = {
   xml: Parser.xmlParser,
   yaml: Parser.yamlParser,
   yml: Parser.yamlParser,
+  boolean: Parser.booleanParser,
+  number: Parser.numberParser
 };
 
 Parser.getParser = function(name) {

package/raw.js

@@ -1,6 +1,6 @@
 /**
  * This is meant to wrap configuration objects that should be left as is,
- * meaning that the object or its protoype will not be modified in any way
+ * meaning that the object or its prototype will not be modified in any way
  */
 function RawConfig () {
 }