config 1.29.2 → 1.31.0

package/History.md

@@ -1,3 +1,23 @@
+1.31.0 / 2018-05-22
+===================
+
+  * Load new coffeescript module instead of coffee-script - bastbijl
+
+1.30.0 / 2018-02-26
+===================
+
+  * Support for nested raw() in javascript configurations - patrickpilch
+
+1.29.4 / 2018-02-03
+===================
+
+  * Re-publish - last changes didn't make it to npm
+
+1.29.3 / 2018-02-03
+===================
+
+  * Added soft dependencies so transpilers don't include everything - gewentao
+
 1.29.2 / 2018-01-12
 ===================
 

package/README.md

@@ -155,15 +155,15 @@ Contributors
 </tr><tr><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>
-<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>
+</tr><tr><td><img src=https://avatars2.githubusercontent.com/u/498929?v=4><a href="https://github.com/roncli">roncli</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://avatars1.githubusercontent.com/u/618330?v=4><a href="https://github.com/adityabansod">adityabansod</a></td>
-<td><img src=https://avatars3.githubusercontent.com/u/270632?v=4><a href="https://github.com/thetalecrafter">thetalecrafter</a></td>
+<td><img src=https://avatars0.githubusercontent.com/u/2015295?v=4><a href="https://github.com/patrickpilch">patrickpilch</a></td>
 </tr></table>
 
 License

package/lib/config.js

@@ -32,6 +32,20 @@ var DEFAULT_CLONE_DEPTH = 20,
     checkMutability = true,      // Check for mutability/immutability on first get
     gitCryptTestRegex = /^.GITCRYPT/; // regular expression to test for gitcrypt files.
 
+// Define soft dependencies so transpilers don't include everything
+var COFFEE_2_DEP = "coffeescript",
+COFFEE_DEP = "coffee-script",
+ICED_DEP = "iced-coffee-script",
+JS_YAML_DEP = "js-yaml",
+YAML_DEP = "yaml",
+JSON5_DEP = "json5",
+HJSON_DEP = "hjson",
+TOML_DEP = "toml",
+CSON_DEP = "cson",
+PPARSER_DEP = "properties",
+XML_DEP = "x2js",
+TS_DEP = "ts-node";
+
 /**
  * <p>Application Configurations</p>
  *
@@ -173,13 +187,6 @@ Config.prototype.get = function(property) {
   if(property === null || property === undefined){
     throw new Error("Calling config.get with null or undefined argument");
   }
-  var t = this,
-      value = getImpl(t, property);
-
-  // Produce an exception if the property doesn't exist
-  if (value === undefined) {
-    throw new Error('Configuration property "' + property + '" is not defined');
-  }
 
   // Make configurations immutable after first get (unless disabled)
   if (checkMutability) {
@@ -188,9 +195,12 @@ Config.prototype.get = function(property) {
     }
     checkMutability = false;
   }
+  var t = this,
+      value = getImpl(t, property);
 
-  if (value instanceof RawConfig) {
-    value = value.resolve();
+  // Produce an exception if the property doesn't exist
+  if (value === undefined) {
+    throw new Error('Configuration property "' + property + '" is not defined');
   }
 
   // Return the value
@@ -539,7 +549,13 @@ util.makeImmutable = function(object, property, value) {
     var propertyName = properties[i],
         value = object[propertyName];
 
-    if (!(value instanceof RawConfig)) {
+    if (value instanceof RawConfig) {
+      Object.defineProperty(object, propertyName, {
+        value: value.resolve(),
+        writable: false,
+        configurable: false
+      });
+    } else {
       Object.defineProperty(object, propertyName, {
         value: value,
         writable : false,
@@ -646,6 +662,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);
@@ -676,22 +695,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) {
@@ -876,7 +899,7 @@ util.parseFile = function(fullFilename) {
     }
     else if (extension === 'ts') {
       if (!require.extensions['.ts']) {
-        require('ts-node').register({
+        require(TS_DEP).register({
           lazy: true,
           compilerOptions: {
             allowJs: true,
@@ -904,7 +927,14 @@ util.parseFile = function(fullFilename) {
         //  Coffee = require("coffee-script");
         //}
 
-        Coffee = require("coffee-script");
+        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) {
@@ -915,7 +945,7 @@ util.parseFile = function(fullFilename) {
       configObject = require(fullFilename);
     }
     else if (extension === 'iced') {
-      Iced = require("iced-coffee-script");
+      Iced = require(ICED_DEP);
 
       // coffee-script >= 1.7.0 requires explicit registration for require() to work
       if (Iced.register) {
@@ -981,12 +1011,12 @@ util.parseString = function (content, format) {
       // Lazy loading
       try {
         // Try to load the better js-yaml module
-        Yaml = require('js-yaml');
+        Yaml = require(JS_YAML_DEP);
       }
       catch (e) {
         try {
           // If it doesn't exist, load the fallback visionmedia yaml module.
-          VisionmediaYaml = require('yaml');
+          VisionmediaYaml = require(YAML_DEP);
         }
         catch (e) { }
       }
@@ -1017,7 +1047,7 @@ util.parseString = function (content, format) {
       }
 
       if (!JSON5) {
-        JSON5 = require('json5');
+        JSON5 = require(JSON5_DEP);
       }
 
       configObject = JSON5.parse(content);
@@ -1026,7 +1056,7 @@ util.parseString = function (content, format) {
   else if (format === 'json5') {
 
     if (!JSON5) {
-      JSON5 = require('json5');
+      JSON5 = require(JSON5_DEP);
     }
 
     configObject = JSON5.parse(content);
@@ -1034,7 +1064,7 @@ util.parseString = function (content, format) {
   } else if (format === 'hjson') {
 
     if (!HJSON) {
-      HJSON = require('hjson');
+      HJSON = require(HJSON_DEP);
     }
 
     configObject = HJSON.parse(content);
@@ -1042,14 +1072,14 @@ util.parseString = function (content, format) {
   } else if (format === 'toml') {
 
     if(!TOML) {
-      TOML = require('toml');
+      TOML = require(TOML_DEP);
     }
 
     configObject = TOML.parse(content);
   }
   else if (format === 'cson') {
     if (!CSON) {
-      CSON = require('cson');
+      CSON = require(CSON_DEP);
     }
     // Allow comments in CSON files
     if (typeof CSON.parseSync === 'function') {
@@ -1060,13 +1090,13 @@ util.parseString = function (content, format) {
   }
   else if (format === 'properties') {
     if (!PPARSER) {
-      PPARSER = require('properties');
+      PPARSER = require(PPARSER_DEP);
     }
     configObject = PPARSER.parse(content, { namespaces: true, variables: true, sections: true });
   } else if (format === 'xml') {
 
     if (!XML) {
-      XML = require('x2js');
+      XML = require(XML_DEP);
     }
 
     var x2js = new XML();
@@ -1696,15 +1726,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) {
@@ -1714,11 +1749,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: ';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "config",
-  "version": "1.29.2",
+  "version": "1.31.0",
   "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",

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?)