config 1.30.0 → 2.0.2

package/History.md

@@ -1,3 +1,30 @@
+2.0.2 / 2018-08-28
+==================
+
+   * Added dot notation to setModuleDefaults - bertho-zero
+   * Updated copyright year - JemiloII
+
+2.0.1 / 2018-07-26
+==================
+
+  * Removed deprecated code - jpwilliams
+
+2.0.0 / 2018-07-26
+==================
+
+Potential for backward incompatibility requiring a major version bump.
+
+Safe to upgrade to major version 2 if you're using a recent NodeJS version
+and you're not trying to mutate config arrays.
+
+  * Added array immutability - jacobemerick
+  * Removed Node V.4 support
+
+1.31.0 / 2018-05-22
+===================
+
+  * Load new coffeescript module instead of coffee-script - bastbijl
+
 1.30.0 / 2018-02-26
 ===================
 

package/README.md

@@ -152,18 +152,18 @@ Contributors
 <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/1443067?v=4><a href="https://github.com/IvanVergiliev">IvanVergiliev</a></td>
-</tr><tr><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://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>
 <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://avatars3.githubusercontent.com/u/8650543?v=4><a href="https://github.com/leonardovillela">leonardovillela</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>
+</tr><tr><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>
-</tr><tr><td><img src=https://avatars2.githubusercontent.com/u/1355559?v=4><a href="https://github.com/superoven">superoven</a></td>
+<td><img src=https://avatars2.githubusercontent.com/u/1355559?v=4><a href="https://github.com/superoven">superoven</a></td>
 <td><img src=https://avatars2.githubusercontent.com/u/54934?v=4><a href="https://github.com/wmertens">wmertens</a></td>
 <td><img src=https://avatars3.githubusercontent.com/u/2842176?v=4><a href="https://github.com/XadillaX">XadillaX</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/4425455?v=4><a href="https://github.com/ncuillery">ncuillery</a></td>
-<td><img src=https://avatars0.githubusercontent.com/u/2015295?v=4><a href="https://github.com/patrickpilch">patrickpilch</a></td>
-<td><img src=https://avatars1.githubusercontent.com/u/618330?v=4><a href="https://github.com/adityabansod">adityabansod</a></td>
+<td><img src=https://avatars2.githubusercontent.com/u/527814?v=4><a href="https://github.com/jacobemerick">jacobemerick</a></td>
 </tr></table>
 
 License
@@ -171,6 +171,6 @@ License
 
 May be freely distributed under the [MIT license](https://raw.githubusercontent.com/lorenwest/node-config/master/LICENSE).
 
-Copyright (c) 2010-2015 Loren West 
+Copyright (c) 2010-2018 Loren West 
 [and other contributors](https://github.com/lorenwest/node-config/graphs/contributors)
 

package/lib/config.js

@@ -33,7 +33,8 @@ var DEFAULT_CLONE_DEPTH = 20,
     gitCryptTestRegex = /^.GITCRYPT/; // regular expression to test for gitcrypt files.
 
 // Define soft dependencies so transpilers don't include everything
-var COFFEE_DEP = "coffee-script",
+var COFFEE_2_DEP = "coffeescript",
+COFFEE_DEP = "coffee-script",
 ICED_DEP = "iced-coffee-script",
 JS_YAML_DEP = "js-yaml",
 YAML_DEP = "yaml",
@@ -229,141 +230,6 @@ Config.prototype.has = function(property) {
   return (getImpl(t, property) !== undefined);
 };
 
-/**
- * <p>Monitor a javascript property for runtime changes.</p>
- *
- * <p>
- * This method was built for an earlier version of node-config that allowed
- * configuration value mutations.  Since version 1.0.0, node-config no longer
- * allows configuration mutations, and is no longer used in node-config.
- * </p>
- *
- * <p>
- * It is deprecated, and will be removed in the next semver incompatible release 2.0.0.
- * </p>
- *
- * @method watch
- * @deprecated
- * @param object {object} - The object to watch.
- * @param property {string} - The property name to watch.  Watch all object properties if null.
- * @param handler {function(object, propertyName, priorValue, newValue)} - Handler called when a property change is detected.
- *   The handler is run along with other handlers registered for notification.
- *   If your handler changes the value of the property, that change is applied after all handlers have finished processing the current change.
- *   Then all handlers (including this one) will be called again with the newly changed value.
- * @param depth {integer} (optional) - If watching all object properties or if the specified property is an object, this specifies the depth of the object graph to watch for changes.  Default 6.
- * @return object {object} - The original object is returned - for chaining.
- */
-util.watch = function(object, property, handler, depth) {
-
-  // Initialize
-  var t = this, o = object;
-  var allProperties = property ? [property] : Object.keys(o);
-
-  // Deprecation warning
-  if (!deprecationWarnings.watch) {
-    console.error('WARNING: config.' + fnName + '() is deprecated, and will not be supported in release 2.0.');
-    console.error('WARNING: See https://github.com/lorenwest/node-config/wiki/Future-Compatibility#upcoming-incompatibilities');
-    deprecationWarnings.watch = true;
-  }
-
-  // Depth detection
-  depth = (depth === null ? DEFAULT_CLONE_DEPTH : depth);
-  if (depth < 0) {
-    return;
-  }
-
-  // Create hidden properties on the object
-  if (!o.__watchers)
-    util.makeHidden(o, '__watchers', {});
-  if (!o.__propertyValues)
-    util.makeHidden(o, '__propertyValues', {});
-
-  // Attach watchers to all requested properties
-  allProperties.forEach(function(prop){
-
-    // Setup the property for watching (first time only)
-    if (typeof(o.__propertyValues[prop]) === 'undefined') {
-
-      // Don't error re-defining the property if immutable
-      var descriptor = Object.getOwnPropertyDescriptor(o, prop);
-      if (descriptor && descriptor.writable === false)
-        return;
-
-      // Copy the value to the hidden field, and add the property to watchers
-      o.__propertyValues[prop] = [o[prop]];
-      o.__watchers[prop] = [];
-
-      // Attach the property watcher
-      Object.defineProperty(o, prop, {
-        enumerable : true,
-
-        get : function(){
-          // If more than 1 item is in the values array,
-          // then we're currently processing watchers.
-          if (o.__propertyValues[prop].length === 1)
-            // Current value
-            return o.__propertyValues[prop][0];
-          else
-            // [0] is prior value, [1] is new value being processed
-            return o.__propertyValues[prop][1];
-        },
-
-        set : function(newValue) {
-
-          // Return early if no change
-          var origValue = o[prop];
-          if (util.equalsDeep(origValue, newValue))
-            return;
-
-          // Remember the new value, and return if we're in another setter
-          o.__propertyValues[prop].push(newValue);
-          if (o.__propertyValues[prop].length > 2)
-            return;
-
-          // Call all watchers for each change requested
-          var numIterations = 0;
-          while (o.__propertyValues[prop].length > 1) {
-
-            // Detect recursion
-            if (++numIterations > 20) {
-              o.__propertyValues[prop] = [origValue];
-              throw new Error('Recursion detected while setting [' + prop + ']');
-            }
-
-            // Call each watcher for the current values
-            var oldValue = o.__propertyValues[prop][0];
-            newValue = o.__propertyValues[prop][1];
-            o.__watchers[prop].forEach(function(watcher) {
-              try {
-                watcher(o, prop, oldValue, newValue);
-              } catch (e) {
-                // Log an error and continue with subsequent watchers
-                console.error("Exception in object watcher for " + prop, e);
-              }
-            });
-
-            // Done processing this value
-            o.__propertyValues[prop].splice(0,1);
-          }
-        }
-      });
-
-    } // Done setting up the property for watching (first time)
-
-    // Add the watcher to the property
-    o.__watchers[prop].push(handler);
-
-    // Recurs if this is an object...
-    if (o[prop] && typeof(o[prop]) === 'object') {
-      util.watch(o[prop], null, handler, depth - 1);
-    }
-
-  }); // Done processing each property
-
-  // Return the original object - for chaining
-  return o;
-};
-
 /**
  * <p>
  * Set default configurations for a node.js module.
@@ -410,17 +276,18 @@ util.setModuleDefaults = function (moduleName, defaultProperties) {
       parsed: {}
     });
   }
-  configSources[0].parsed[moduleName] = {};
-  util.extendDeep(configSources[0].parsed[moduleName], defaultProperties);
+  util.setPath(configSources[0].parsed, moduleName.split('.'), {});
+  util.extendDeep(getImpl(configSources[0].parsed, moduleName), defaultProperties);
 
   // Create a top level config for this module if it doesn't exist
-  t[moduleName] = t[moduleName] || {};
+  util.setPath(t, moduleName.split('.'), getImpl(t, moduleName) || {});
 
   // Extend local configurations into the module config
-  util.extendDeep(moduleConfig, t[moduleName]);
+  util.setPath(moduleConfig, moduleName.split('.'), getImpl(moduleConfig, moduleName) || {});
+  util.extendDeep(moduleConfig, getImpl(t, moduleName));
 
   // Merge the extended configs without replacing the original
-  util.extendDeep(t[moduleName], moduleConfig);
+  util.extendDeep(getImpl(t, moduleName), moduleConfig);
 
   // reset the mutability check for "config.get" method.
   // we are not making t[moduleName] immutable immediately,
@@ -430,7 +297,7 @@ util.setModuleDefaults = function (moduleName, defaultProperties) {
   }
 
   // Attach handlers & watchers onto the module config object
-  return util.attachProtoDeep(t[moduleName]);
+  return util.attachProtoDeep(getImpl(t, moduleName));
 };
 
 /**
@@ -554,6 +421,10 @@ util.makeImmutable = function(object, property, value) {
         writable: false,
         configurable: false
       });
+    } else if (Array.isArray(value)) {
+      Object.defineProperty(object, propertyName, {
+        value: Object.freeze(value)
+      });
     } else {
       Object.defineProperty(object, propertyName, {
         value: value,
@@ -661,6 +532,9 @@ util.loadFileConfigs = function(configDir) {
   // Override, NODE_ENV if NODE_CONFIG_ENV is specified.
   NODE_ENV = util.initParam('NODE_CONFIG_ENV', NODE_ENV);
 
+  // Split files name, for loading multiple files.
+  NODE_ENV = NODE_ENV.split(',');
+
   CONFIG_DIR = configDir || util.initParam('NODE_CONFIG_DIR', Path.join( process.cwd(), 'config') );
   if (CONFIG_DIR.indexOf('.') === 0) {
     CONFIG_DIR = Path.join(process.cwd() , CONFIG_DIR);
@@ -691,22 +565,26 @@ util.loadFileConfigs = function(configDir) {
   env.HOSTNAME = hostName;
 
   // Read each file in turn
-  var baseNames = ['default', NODE_ENV];
+  var baseNames = ['default'].concat(NODE_ENV);
 
   // #236: Also add full hostname when they are different.
   if ( hostName ) {
     var firstDomain = hostName.split('.')[0];
 
-    // Backward compatibility
-    baseNames.push(firstDomain, firstDomain + '-' + NODE_ENV);
+    NODE_ENV.forEach(function(env) {
+      // Backward compatibility
+      baseNames.push(firstDomain, firstDomain + '-' + env);
 
-    // Add full hostname when it is not the same
-    if ( hostName != firstDomain ) {
-      baseNames.push(hostName, hostName + '-' + NODE_ENV);
-    }
+      // Add full hostname when it is not the same
+      if ( hostName != firstDomain ) {
+        baseNames.push(hostName, hostName + '-' + env);
+      }
+    });
   }
 
-  baseNames.push('local', 'local-' + NODE_ENV);
+  NODE_ENV.forEach(function(env) {
+    baseNames.push('local', 'local-' + env);
+  });
 
   var extNames = ['js', 'ts', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml'];
   baseNames.forEach(function(baseName) {
@@ -919,7 +797,14 @@ util.parseFile = function(fullFilename) {
         //  Coffee = require("coffee-script");
         //}
 
-        Coffee = require(COFFEE_DEP);
+        try {
+          // Try to load coffeescript
+          Coffee = require(COFFEE_2_DEP);
+        }
+        catch (e) {
+          // If it doesn't exist, try to load it using the deprecated module name
+          Coffee = require(COFFEE_DEP);
+        }
 
         // coffee-script >= 1.7.0 requires explicit registration for require() to work
         if (Coffee.register) {
@@ -1711,15 +1596,20 @@ util.runStrictnessChecks = function (config) {
     return Path.basename(src.name);
   });
 
-
-  // Throw an exception if there's no explicit config file for NODE_ENV
-  var anyFilesMatchEnv = sourceFilenames.some(function (filename) {
-      return filename.match(NODE_ENV);
+  NODE_ENV.forEach(function(env) {
+    // Throw an exception if there's no explicit config file for NODE_ENV
+    var anyFilesMatchEnv = sourceFilenames.some(function (filename) {
+        return filename.match(env);
+    });
+    // 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.");
+    }
+    // Throw if NODE_ENV matches' default' or 'local'
+    if ((env === 'default') || (env === 'local')) {
+      _warnOrThrow("NODE_ENV value of '"+env+"' is ambiguous.");
+    }
   });
-  // development is special-cased because it's the default value
-  if (NODE_ENV && (NODE_ENV !== 'development') && !anyFilesMatchEnv) {
-    _warnOrThrow("NODE_ENV value of '"+NODE_ENV+"' did not match any deployment config file names.");
-  }
 
   // Throw an exception if there's no explict config file for NODE_APP_INSTANCE
   var anyFilesMatchInstance = sourceFilenames.some(function (filename) {
@@ -1729,11 +1619,6 @@ util.runStrictnessChecks = function (config) {
     _warnOrThrow("NODE_APP_INSTANCE value of '"+APP_INSTANCE+"' did not match any instance config file names.");
   }
 
-  // Throw if NODE_ENV matches' default' or 'local'
-  if ((NODE_ENV === 'default') || (NODE_ENV === 'local')) {
-    _warnOrThrow("NODE_ENV value of '"+NODE_ENV+"' is ambiguous.");
-  }
-
   function _warnOrThrow (msg) {
     var beStrict = process.env.NODE_CONFIG_STRICT_MODE;
     var prefix = beStrict ? 'FATAL: ' : 'WARNING: ';
@@ -1749,35 +1634,6 @@ util.runStrictnessChecks = function (config) {
   }
 }
 
-// Process pre-1.0 utility names
-var utilWarnings = {};
-['watch', 'setModuleDefaults', 'makeHidden', 'makeImmutable', 'getConfigSources', '_loadFileConfigs',
- '_parseFile', '_attachProtoDeep', '_cloneDeep', '_equalsDeep', '_diffDeep', '_extendDeep', '_stripYamlComments',
- '_stripComments', '_isObject', '_initParam', '_getCmdLineArg'].forEach(function(oldName) {
-
-  // Config.util names don't have underscores
-  var newName = oldName;
-  if (oldName.indexOf('_') === 0) {
-    newName = oldName.substr(1);
-  }
-
-  // Build the wrapper with warning
-  Config.prototype[oldName] = function(){
-
-    // Produce the warning
-    if (!utilWarnings[oldName]) {
-      console.error('WARNING: config.' + oldName + '() is deprecated.  Use config.util.' + newName + '() instead.');
-      console.error('WARNING: See https://github.com/lorenwest/node-config/wiki/Future-Compatibility#upcoming-incompatibilities');
-      utilWarnings[oldName] = true;
-    }
-
-    // Forward the call
-    return util[newName].apply(this, arguments);
-  }
-});
-
-
-
 // Instantiate and export the configuration
 var config = module.exports = new Config();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "config",
-  "version": "1.30.0",
+  "version": "2.0.2",
   "main": "./lib/config.js",
   "description": "Configuration control for production node deployments",
   "author": "Loren West <open_source@lorenwest.com>",
@@ -19,12 +19,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "json5": "0.4.0",
-    "os-homedir": "1.0.2"
+    "json5": "^1.0.1"
   },
   "devDependencies": {
     "@types/node": "^7.0.8",
-    "coffee-script": ">=1.7.0",
+    "coffeescript": "2.2.4",
     "cson": "^3.0.1",
     "hjson": "^1.2.0",
     "js-yaml": "^3.2.2",
@@ -42,7 +41,7 @@
     "url": "http://github.com/lorenwest/node-config.git"
   },
   "engines": {
-    "node": ">= 4.0.0"
+    "node": ">= 6.0.0"
   },
   "scripts": {
     "test": "./node_modules/vows/bin/vows test/*.js --spec"

package/ISSUE_TEMPLATE.md

@@ -1,24 +0,0 @@
-**Note: for support questions, please use [StackOverflow](https://stackoverflow.com/questions/tagged/node-config) and tag your question with `node-config`**. *This repository's issues are reserved for feature requests and bug reports.*
-
-Before submitting a bug report, please search the issue tracker the wiki first. Many issues have already been discussed.
-
-The wiki is located at: https://github.com/lorenwest/node-config/wiki
-
-### I'm submitting a ... 
-  - [  ] bug report
-  - [  ] feature request
-  - [  ] support request or question => Please do not submit support request or questions here, see note at the top of this template.
-
-### What is the current behavior?
-*If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem*:
-
-### What is the expected behavior?
-
-### Please tell us about your environment:
-
- -  node-config version: x.x.x
- -  node-version: x.x.x
- 
-### Other information
-
-(e.g. are you using an environment besides Node.js?)