config 3.3.4 → 3.3.8

package/History.md

@@ -1,3 +1,19 @@
+3.3.7 / 2022-01-11
+==================
+
+ * No new changes. 3.3.6 was not published to NPM in versioning mix-up.
+ * Release notes are moving to Github Releases page going forward.
+
+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/node-config/node-config/issues/628) Uncaught ReferenceError: node_env_var_name is not defined @prnake
+
 3.3.4 / 2021-02-26
 ==================
 
@@ -328,7 +344,7 @@ and you're not trying to mutate config arrays.
   * Simplify syntax for defer() functions. The 'this' value in the functions is now bound
     to the main configuration object, so it doesn't have to be passed into the function. (@markstos)
   * new defer sub-module introduced in 1.8.0 can now be accessed by require('config/defer')
-    For usage, see: https://github.com/lorenwest/node-config/wiki/Configuration-Files#javascript-module---js
+    For usage, see: https://github.com/node-config/node-config/wiki/Configuration-Files#javascript-module---js
   * Add test coverage for array merging cases. (@markstos)
   * Bump dependency on cson package to 1.6.1 (@markstos)
 
@@ -336,7 +352,7 @@ and you're not trying to mutate config arrays.
 ==================
 
   * Added deferred function for evaluating configs after load (@markstos)
-    For details, see: https://github.com/lorenwest/node-config/wiki/Configuration-Files#javascript-module---js
+    For details, see: https://github.com/node-config/node-config/wiki/Configuration-Files#javascript-module---js
   * Bumped js-yaml dependency (@markstos)
 
 1.7.0 / 2014-10-30
@@ -421,7 +437,7 @@ and you're not trying to mutate config arrays.
 ===================
 
   * Major revision.  Upgrade notes:
-    https://github.com/lorenwest/node-config/wiki/Upgrading-From-Config-0.x
+    https://github.com/node-config/node-config/wiki/Upgrading-From-Config-0.x
   * Update to semver versioning
   * Change load ordering
       from hostname.EXT --> deployment.EXT
@@ -440,7 +456,7 @@ and you're not trying to mutate config arrays.
   * Removed reliance on global.NODE_CONFIG so older versions can work with 1.x
   * Fix empty YAML file causing crash with latest js-yaml
   * Added SUPPRESS_NO_CONFIG_WARNING for better sub-module support
-  * Moved all documentation [to the wiki](https://github.com/lorenwest/node-config/wiki).
+  * Moved all documentation [to the wiki](https://github.com/node-config/node-config/wiki).
 
 0.4.37 / 2014-07-22
 ===================

package/LICENSE

@@ -1,4 +1,4 @@
-// Copyright 2010-2020, Loren West and other contributors
+// Copyright 2010-2022, Loren West and other contributors
 
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to

package/README.md

@@ -2,8 +2,8 @@ Configure your Node.js Applications
 ===================================
 
 [![NPM](https://nodei.co/npm/config.svg?downloads=true&downloadRank=true)](https://nodei.co/npm/config/)  
-[![Build Status](https://secure.travis-ci.org/lorenwest/node-config.svg?branch=master)](https://travis-ci.org/lorenwest/node-config)  
-[release notes](https://github.com/lorenwest/node-config/blob/master/History.md)
+[![Build Status](https://secure.travis-ci.org/node-config/node-config.svg?branch=master)](https://travis-ci.org/lorenwest/node-config)  
+[release notes](https://github.com/node-config/node-config/blob/master/History.md)
 
 Introduction
 ------------
@@ -14,8 +14,8 @@ It lets you define a set of default parameters,
 and extend them for different deployment environments (development, qa,
 staging, production, etc.).
 
-Configurations are stored in [configuration files](https://github.com/lorenwest/node-config/wiki/Configuration-Files) within your application, and can be overridden and extended by [environment variables](https://github.com/lorenwest/node-config/wiki/Environment-Variables),
- [command line parameters](https://github.com/lorenwest/node-config/wiki/Command-Line-Overrides), or [external sources](https://github.com/lorenwest/node-config/wiki/Configuring-from-an-External-Source).
+Configurations are stored in [configuration files](https://github.com/node-config/node-config/wiki/Configuration-Files) within your application, and can be overridden and extended by [environment variables](https://github.com/lorenwest/node-config/wiki/Environment-Variables),
+ [command line parameters](https://github.com/node-config/node-config/wiki/Command-Line-Overrides), or [external sources](https://github.com/lorenwest/node-config/wiki/Configuring-from-an-External-Source).
 
 This gives your application a consistent configuration interface shared among a
 [growing list of npm modules](https://www.npmjs.org/browse/depended/config) also using node-config.
@@ -31,7 +31,7 @@ Project Guidelines
 
 Quick Start
 ---------------
-The following examples are in JSON format, but configurations can be in other [file formats](https://github.com/lorenwest/node-config/wiki/Configuration-Files#file-formats).
+The following examples are in JSON format, but configurations can be in other [file formats](https://github.com/node-config/node-config/wiki/Configuration-Files#file-formats).
 
 **Install in your app directory, and edit the default config file.**
 
@@ -108,29 +108,29 @@ come from the `production.json` override file.
 Articles
 --------
 
-* [Configuration Files](https://github.com/lorenwest/node-config/wiki/Configuration-Files)
-  * [Special features for JavaScript configuration files](https://github.com/lorenwest/node-config/wiki/Special-features-for-JavaScript-configuration-files)
-* [Common Usage](https://github.com/lorenwest/node-config/wiki/Common-Usage)
-* [Environment Variables](https://github.com/lorenwest/node-config/wiki/Environment-Variables)
-* [Reserved Words](https://github.com/lorenwest/node-config/wiki/Reserved-Words)
-* [Command Line Overrides](https://github.com/lorenwest/node-config/wiki/Command-Line-Overrides)
-* [Multiple Node Instances](https://github.com/lorenwest/node-config/wiki/Multiple-Node-Instances)
-* [Sub-Module Configuration](https://github.com/lorenwest/node-config/wiki/Sub-Module-Configuration)
-* [Configuring from a DB / External Source](https://github.com/lorenwest/node-config/wiki/Configuring-from-an-External-Source)
-* [Securing Production Config Files](https://github.com/lorenwest/node-config/wiki/Securing-Production-Config-Files)
-* [External Configuration Management Tools](https://github.com/lorenwest/node-config/wiki/External-Configuration-Management-Tools)
-* [Examining Configuration Sources](https://github.com/lorenwest/node-config/wiki/Examining-Configuration-Sources)
-* [Using Config Utilities](https://github.com/lorenwest/node-config/wiki/Using-Config-Utilities)
-* [Upgrading from Config 0.x](https://github.com/lorenwest/node-config/wiki/Upgrading-From-Config-0.x)
-* [Webpack usage](https://github.com/lorenwest/node-config/wiki/Webpack-Usage)
+* [Configuration Files](https://github.com/node-config/node-config/wiki/Configuration-Files)
+  * [Special features for JavaScript configuration files](https://github.com/node-config/node-config/wiki/Special-features-for-JavaScript-configuration-files)
+* [Common Usage](https://github.com/node-config/node-config/wiki/Common-Usage)
+* [Environment Variables](https://github.com/node-config/node-config/wiki/Environment-Variables)
+* [Reserved Words](https://github.com/node-config/node-config/wiki/Reserved-Words)
+* [Command Line Overrides](https://github.com/node-config/node-config/wiki/Command-Line-Overrides)
+* [Multiple Node Instances](https://github.com/node-config/node-config/wiki/Multiple-Node-Instances)
+* [Sub-Module Configuration](https://github.com/node-config/node-config/wiki/Sub-Module-Configuration)
+* [Configuring from a DB / External Source](https://github.com/node-config/node-config/wiki/Configuring-from-an-External-Source)
+* [Securing Production Config Files](https://github.com/node-config/node-config/wiki/Securing-Production-Config-Files)
+* [External Configuration Management Tools](https://github.com/node-config/node-config/wiki/External-Configuration-Management-Tools)
+* [Examining Configuration Sources](https://github.com/node-config/node-config/wiki/Examining-Configuration-Sources)
+* [Using Config Utilities](https://github.com/node-config/node-config/wiki/Using-Config-Utilities)
+* [Upgrading from Config 0.x](https://github.com/node-config/node-config/wiki/Upgrading-From-Config-0.x)
+* [Webpack usage](https://github.com/node-config/node-config/wiki/Webpack-Usage)
 
 Further Information
 ---------------------
 If you still don't see what you are looking for, here are some more resources to check: 
 
- * The [wiki may have more pages](https://github.com/lorenwest/node-config/wiki) which are not directly linked from here.
+ * The [wiki may have more pages](https://github.com/node-config/node-config/wiki) which are not directly linked from here.
  * Review [questions tagged with node-config](https://stackexchange.com/filters/207096/node-config) on StackExchange. These are monitored by `node-config` contributors.
- * [Search the issue tracker](https://github.com/lorenwest/node-config/issues). Hundreds of issues have already been discussed and resolved there.
+ * [Search the issue tracker](https://github.com/node-config/node-config/issues). Hundreds of issues have already been discussed and resolved there.
 
 Contributors
 ------------
@@ -169,8 +169,8 @@ Contributors
 License
 -------
 
-May be freely distributed under the [MIT license](https://raw.githubusercontent.com/lorenwest/node-config/master/LICENSE).
+May be freely distributed under the [MIT license](https://raw.githubusercontent.com/node-config/node-config/master/LICENSE).
 
-Copyright (c) 2010-2020 Loren West 
-[and other contributors](https://github.com/lorenwest/node-config/graphs/contributors)
+Copyright (c) 2010-2022 Loren West 
+[and other contributors](https://github.com/node-config/node-config/graphs/contributors)
 

package/lib/config.js

@@ -1,11 +1,10 @@
-// config.js (c) 2010-2020 Loren West and other contributors
+// config.js (c) 2010-2022 Loren West and other contributors
 // May be freely distributed under the MIT license.
 // For further details and documentation:
 // http://lorenwest.github.com/node-config
 
 // Dependencies
-var deferConfig = require('../defer').deferConfig,
-    DeferredConfig = require('../defer').DeferredConfig,
+var DeferredConfig = require('../defer').DeferredConfig,
     RawConfig = require('../raw').RawConfig,
     Parser = require('../parser'),
     Utils = require('util'),
@@ -14,12 +13,10 @@ 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, NODE_ENV_VAR_NAME,
+    CONFIG_DIR, NODE_ENV, APP_INSTANCE,
+    CONFIG_SKIP_GITCRYPT, NODE_ENV_VAR_NAME,
     NODE_CONFIG_PARSER,
     env = {},
-    privateUtil = {},
-    deprecationWarnings = {},
     configSources = [],          // Configuration sources - array of {name, original, parsed}
     checkMutability = true,      // Check for mutability/immutability on first get
     gitCryptTestRegex = /^.GITCRYPT/; // regular expression to test for gitcrypt files.
@@ -410,19 +407,28 @@ util.makeImmutable = function(object, property, value) {
         value: Object.freeze(value)
       });
     } else {
+      // Call recursively if an object.
+      if (util.isObject(value)) {
+        // Create a proxy, to capture user updates of configuration options, and throw an exception for awareness, as per:
+        // https://github.com/lorenwest/node-config/issues/514
+        value = new Proxy(util.makeImmutable(value), {
+          set (target, name) {
+            const message = (Reflect.has(target, name) ? 'update' : 'add');
+            // Notify the user.
+            throw Error(`Can not ${message} runtime configuration property: "${name}". Configuration objects are immutable unless ALLOW_CONFIG_MUTATIONS is set.`)
+          }
+        })
+      }
+
       Object.defineProperty(object, propertyName, {
         value: value,
         writable : false,
         configurable: false
       });
 
-      // Ensure new properties can not be added.
-      Object.preventExtensions(object)
-
-      // Call recursively if an object.
-      if (util.isObject(value)) {
-        util.makeImmutable(value);
-      }
+      // Ensure new properties can not be added, as per:
+      // https://github.com/lorenwest/node-config/issues/505
+      Object.preventExtensions(object[propertyName])
     }
   }
 
@@ -542,7 +548,7 @@ util.loadFileConfigs = function(configDir, options) {
   var node_env_var_names = ['NODE_CONFIG_ENV', 'NODE_ENV'];
 
   // Loop through the variables to try and set environment
-  for (node_env_var_name of node_env_var_names) {
+  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;
@@ -562,25 +568,21 @@ util.loadFileConfigs = function(configDir, options) {
   // 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);
-  }
+  var dir = configDir || util.initParam('NODE_CONFIG_DIR', Path.join( process.cwd(), 'config') );
+  dir = _toAbsolutePath(dir);
 
   APP_INSTANCE = util.initParam('NODE_APP_INSTANCE');
-  HOST = util.initParam('HOST');
-  HOSTNAME = util.initParam('HOSTNAME');
   CONFIG_SKIP_GITCRYPT = util.initParam('CONFIG_SKIP_GITCRYPT');
 
   // This is for backward compatibility
-  RUNTIME_JSON_FILENAME = util.initParam('NODE_CONFIG_RUNTIME_JSON', Path.join(CONFIG_DIR , 'runtime.json') );
+  var runtimeFilename = util.initParam('NODE_CONFIG_RUNTIME_JSON', Path.join(dir , 'runtime.json') );
 
   NODE_CONFIG_PARSER = util.initParam('NODE_CONFIG_PARSER');
   if (NODE_CONFIG_PARSER) {
     try {
       var parserModule = Path.isAbsolute(NODE_CONFIG_PARSER)
         ? NODE_CONFIG_PARSER
-        : Path.join(CONFIG_DIR, NODE_CONFIG_PARSER);
+        : Path.join(dir, NODE_CONFIG_PARSER);
       Parser = require(parserModule);
     }
     catch (e) {
@@ -589,6 +591,9 @@ util.loadFileConfigs = function(configDir, options) {
     }
   }
 
+  var HOST = util.initParam('HOST');
+  var HOSTNAME = util.initParam('HOSTNAME');
+
   // Determine the host name from the OS module, $HOST, or $HOSTNAME
   // Remove any . appendages, and default to null if not set
   try {
@@ -639,7 +644,7 @@ util.loadFileConfigs = function(configDir, options) {
     });
   });
 
-  var locatedFiles = util.locateMatchingFiles(CONFIG_DIR, allowedFiles);
+  var locatedFiles = util.locateMatchingFiles(dir, allowedFiles);
   locatedFiles.forEach(function(fullFilename) {
     var configObj = util.parseFile(fullFilename, options);
     if (configObj) {
@@ -651,6 +656,9 @@ util.loadFileConfigs = function(configDir, options) {
   // NODE_CONFIG only applies to the base config
   if (!configDir) {
     var envConfig = {};
+
+    CONFIG_DIR = dir;
+
     if (process.env.NODE_CONFIG) {
       try {
         envConfig = JSON.parse(process.env.NODE_CONFIG);
@@ -690,11 +698,11 @@ util.loadFileConfigs = function(configDir, options) {
   }
 
   // Override with environment variables if there is a custom-environment-variables.EXT mapping file
-  var customEnvVars = util.getCustomEnvVars(CONFIG_DIR, extNames);
+  var customEnvVars = util.getCustomEnvVars(dir, extNames);
   util.extendDeep(config, customEnvVars);
 
   // Extend the original config with the contents of runtime.json (backwards compatibility)
-  var runtimeJson = util.parseFile(RUNTIME_JSON_FILENAME) || {};
+  var runtimeJson = util.parseFile(runtimeFilename) || {};
   util.extendDeep(config, runtimeJson);
 
   util.resolveDeferredConfigs(config);
@@ -718,6 +726,7 @@ util.locateMatchingFiles = function(configDirs, allowedFiles) {
   return configDirs.split(Path.delimiter)
     .reduce(function(files, configDir) {
       if (configDir) {
+        configDir = _toAbsolutePath(configDir);
         try {
           FileSystem.readdirSync(configDir).forEach(function(file) {
             if (allowedFiles[file]) {
@@ -1084,12 +1093,12 @@ util.substituteDeep = function (substitutionMap, variables) {
     for (var prop in map) {
       var value = map[prop];
       if (typeof(value) === 'string') { // We found a leaf variable name
-        if (vars[value] !== undefined) { // if the vars provide a value set the value in the result map
+        if (vars[value] !== undefined && vars[value] !== '') { // if the vars provide a value set the value in the result map
           util.setPath(result, pathTo.concat(prop), vars[value]);
         }
       }
       else if (util.isObject(value)) { // work on the subtree, giving it a clone of the pathTo
-        if ('__name' in value && '__format' in value && vars[value.__name] !== undefined) {
+        if ('__name' in value && '__format' in value && vars[value.__name] !== undefined && vars[value.__name] !== '') {
           try {
             var parsedValue = util.parseString(vars[value.__name], value.__format);
           } catch(err) {
@@ -1118,18 +1127,18 @@ util.substituteDeep = function (substitutionMap, variables) {
  *
  * @protected
  * @method getCustomEnvVars
- * @param CONFIG_DIR {string} - the passed configuration directory
+ * @param configDir {string} - the passed configuration directory
  * @param extNames {Array[string]} - acceptable configuration file extension names.
  * @returns {object} - mapped environment variables or {} if there are none
  */
-util.getCustomEnvVars = function (CONFIG_DIR, extNames) {
+util.getCustomEnvVars = function (configDir, extNames) {
   var result = {};
   var resolutionIndex = 1;
   var allowedFiles = {};
   extNames.forEach(function (extName) {
     allowedFiles['custom-environment-variables' + '.' + extName] = resolutionIndex++;
   });
-  var locatedFiles = util.locateMatchingFiles(CONFIG_DIR, allowedFiles);
+  var locatedFiles = util.locateMatchingFiles(configDir, allowedFiles);
   locatedFiles.forEach(function (fullFilename) {
     var configObj = util.parseFile(fullFilename);
     if (configObj) {
@@ -1476,7 +1485,7 @@ util.runStrictnessChecks = function (config) {
   function _warnOrThrow (msg) {
     var beStrict = process.env.NODE_CONFIG_STRICT_MODE;
     var prefix = beStrict ? 'FATAL: ' : 'WARNING: ';
-    var seeURL = 'See https://github.com/lorenwest/node-config/wiki/Strict-Mode';
+    var seeURL = 'See https://github.com/node-config/node-config/wiki/Strict-Mode';
 
     console.error(prefix+msg);
     console.error(prefix+seeURL);
@@ -1488,6 +1497,15 @@ util.runStrictnessChecks = function (config) {
   }
 };
 
+// Helper functions shared accross object members
+function _toAbsolutePath (configDir) {
+  if (configDir.indexOf('.') === 0) {
+    return Path.join(process.cwd(), configDir);
+  }
+
+  return configDir;
+}
+
 // Instantiate and export the configuration
 var config = module.exports = new Config();
 

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "config",
-  "version": "3.3.4",
+  "version": "3.3.8",
   "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",
+  "homepage": "http://github.com/node-config/node-config.git",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
   "keywords": [
     "conf",
     "config",
@@ -19,7 +22,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "json5": "^2.1.1"
+    "json5": "^2.2.1"
   },
   "devDependencies": {
     "@types/node": "^7.0.8",
@@ -38,7 +41,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "http://github.com/lorenwest/node-config.git"
+    "url": "http://github.com/node-config/node-config.git"
   },
   "engines": {
     "node": ">= 10.0.0"

package/parser.js

@@ -55,6 +55,7 @@ Parser.tsParser = function(filename, content) {
   if (!require.extensions['.ts']) {
     require(TS_DEP).register({
       lazy: true,
+      transpileOnly: true,
       compilerOptions: {
         allowJs: true,
       }
@@ -62,7 +63,7 @@ Parser.tsParser = function(filename, content) {
   }
 
   // Imports config if it is exported via module.exports = ...
-  // See https://github.com/lorenwest/node-config/issues/524
+  // See https://github.com/node-config/node-config/issues/524
   var configObject = require(filename);
 
   // Because of ES6 modules usage, `default` is treated as named export (like any other)
@@ -136,7 +137,10 @@ Parser.yamlParser = function(filename, content) {
     // The yaml library doesn't like strings that have newlines but don't
     // end in a newline: https://github.com/visionmedia/js-yaml/issues/issue/13
     content += '\n';
-    return VisionmediaYaml.eval(Parser.stripYamlComments(content));
+    if (typeof VisionmediaYaml.eval === 'function') {
+      return VisionmediaYaml.eval(Parser.stripYamlComments(content));
+    }
+    return VisionmediaYaml.parse(Parser.stripYamlComments(content));
   }
   else {
     console.error('No YAML parser loaded.  Suggest adding js-yaml dependency to your package.json file.')