config 4.1.0 → 4.2.0

package/lib/config.js

@@ -231,46 +231,6 @@ util.setModuleDefaults = function (moduleName, defaultProperties) {
   return util.attachProtoDeep(Util.getPath(t, path));
 };
 
-/**
- * <p>Make a configuration property hidden so it doesn't appear when enumerating
- * elements of the object.</p>
- *
- * <p>
- * The property still exists and can be read from and written to, but it won't
- * show up in for ... in loops, Object.keys(), or JSON.stringify() type methods.
- * </p>
- *
- * <p>
- * If the property already exists, it will be made hidden.  Otherwise it will
- * be created as a hidden property with the specified value.
- * </p>
- *
- * <p><i>
- * This method was built for hiding configuration values, but it can be applied
- * to <u>any</u> javascript object.
- * </i></p>
- *
- * <p>Example:</p>
- * <pre>
- *   const CONFIG = require('config');
- *   ...
- *
- *   // Hide the Amazon S3 credentials
- *   CONFIG.util.makeHidden(CONFIG.amazonS3, 'access_id');
- *   CONFIG.util.makeHidden(CONFIG.amazonS3, 'secret_key');
- * </pre>
- *
- * @deprecated use Util.makeHidden
- * @method makeHidden
- * @param object {Object} - The object to make a hidden property into.
- * @param property {string} - The name of the property to make hidden.
- * @param value {*} - (optional) Set the property value to this (otherwise leave alone)
- * @return object {Object} - The original object is returned - for chaining.
- */
-util.makeHidden = function(object, property, value) {
-  return Util.makeHidden(object, property, value);
-}
-
 /**
  * <p>Make a javascript object property immutable (assuring it cannot be changed
  * from the current value).</p>
@@ -421,26 +381,6 @@ util.getConfigSources = function() {
   return FIRST_LOAD.getSources();
 };
 
-/**
- * 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
- * @deprecated use Util.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) {
-  return Util.getOption(options, optionName, defaultValue);
-};
-
-
 /**
  * Load the individual file configurations.
  *
@@ -557,98 +497,6 @@ function _init(load) {
   load.scan(additional);
 }
 
-/**
- * Return a list of fullFilenames who exists in allowedFiles
- * Ordered according to allowedFiles argument specifications
- *
- * @protected
- * @deprecated use Util.locateMatchingFiles
- * @method locateMatchingFiles
- * @param configDirs {string}   the config dir, or multiple dirs separated by a column (:)
- * @param allowedFiles {Object} an object. keys and supported filenames
- *                              and values are the position in the resolution order
- * @returns {string[]}          fullFilenames - path + filename
- */
-util.locateMatchingFiles = function(configDirs, allowedFiles) {
-  return Util.locateMatchingFiles(configDirs, allowedFiles);
-};
-
-/**
- * @deprecated use Util.resolveDeferredConfigs
- * @param config
- */
-// Using basic recursion pattern, find all the deferred values and resolve them.
-util.resolveDeferredConfigs = function (config) {
-  return Util.resolveDeferredConfigs(config);
-};
-
-/**
- * Parse and return the specified configuration file.
- *
- * If the file exists in the application config directory, it will
- * parse and return it as a JavaScript object.
- *
- * The file extension determines the parser to use.
- *
- * .js = File to run that has a module.exports containing the config object
- * .coffee = File to run that has a module.exports with coffee-script containing the config object
- * .iced = File to run that has a module.exports with iced-coffee-script containing the config object
- * All other supported file types (yaml, toml, json, cson, hjson, json5, properties, xml)
- * are parsed with util.parseString.
- *
- * If the file doesn't exist, a null will be returned.  If the file can't be
- * parsed, an exception will be thrown.
- *
- * This method performs synchronous file operations, and should not be called
- * after synchronous module loading.
- *
- * @protected
- * @deprecated
- * @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, options = {}) {
-  let loadOpts = {...FIRST_LOAD.options}; //TODO: Support full LoadOptions?
-  let loadInfo = new Load(loadOpts);
-
-  loadInfo.loadFile(fullFilename);
-
-  return loadInfo.config;
-}
-
-/**
- * Parse and return the specified string with the specified format.
- *
- * The format determines the parser to use.
- *
- * json = File is parsed using JSON.parse()
- * yaml (or yml) = Parsed with a YAML parser
- * toml = Parsed with a TOML parser
- * cson = Parsed with a CSON parser
- * hjson = Parsed with a HJSON parser
- * json5 = Parsed with a JSON5 parser
- * properties = Parsed with the 'properties' node package
- * xml = Parsed with a XML parser
- *
- * If the file doesn't exist, a null will be returned.  If the file can't be
- * parsed, an exception will be thrown.
- *
- * This method performs synchronous file operations, and should not be called
- * after synchronous module loading.
- *
- * @protected
- * @deprecated
- * @method parseString
- * @param content {string} The full content
- * @param format {string} The format to be parsed
- * @return {configObject} The configuration object parsed from the string
- */
-util.parseString = function (content, format) {
-  return FIRST_LOAD.parseString(content, format);
-};
-
 /**
  * Attach the Config class prototype to all config objects recursively.
  *
@@ -698,267 +546,6 @@ util.attachProtoDeep = function(toObject, depth) {
   return toObject;
 };
 
-/**
- * Return a deep copy of the specified object.
- *
- * This returns a new object with all elements copied from the specified
- * object.  Deep copies are made of objects and arrays so you can do anything
- * with the returned object without affecting the input object.
- *
- * @protected
- * @deprecated please see Util.cloneDeep
- * @method cloneDeep
- * @param parent {Object} The original object to copy from
- * @param [depth=20] {number} Maximum depth (default 20)
- * @return {Object} A new object with the elements copied from the copyFrom object
- */
-util.cloneDeep = function cloneDeep(parent, depth, circular, prototype) {
-  return Util.cloneDeep(parent, depth, circular, prototype);
-};
-
-/**
- * Set objects given a path as a string list
- *
- * @protected
- * @deprecated see Util.setPath()
- *
- * @method setPath
- * @param object {Object} - Object to set the property on
- * @param path {array[string]} - Array path to the property
- * @param value {*} - value to set, ignoring null
- */
-util.setPath = function (object, path, value) {
-  Util.setPath(object, path, value);
-};
-
-/**
- * Create a new object patterned after substitutionMap, where:
- * 1. Terminal string values in substitutionMap are used as keys
- * 2. To look up values in a key-value store, variables
- * 3. And parent keys are created as necessary to retain the structure of substitutionMap.
- *
- * @protected
- * @deprecated
- *
- * @method substituteDeep
- * @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 substitutionMap.
- * @returns {Object} - deep copy of substitutionMap with only those paths whose terminal values
- *      corresponded to a key in `variables`
- */
-util.substituteDeep = function (substitutionMap, variables) {
-  return FIRST_LOAD.substituteDeep(substitutionMap, variables);
-};
-
-/**
- *  Map environment variables into the configuration if a mapping file,
- * `custom-environment-variables.EXT` exists.
- *
- * @protected
- * @deprecated
- * @method getCustomEnvVars
- * @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 (configDir, extNames) {
-  let options = {...FIRST_LOAD.options, configDir};
-  let load = new Load(options);
-
-  load.loadCustomEnvVars(extNames);
-
-  return load.config;
-};
-
-/**
- * Return true if two objects have equal contents.
- *
- * @protected
- * @deprecated see Util.equalsDeep()
- *
- * @method equalsDeep
- * @param object1 {Object} The object to compare from
- * @param object2 {Object} The object to compare with
- * @param depth {integer} An optional depth to prevent recursion.  Default: 20.
- * @return {boolean} True if both objects have equivalent contents
- */
-util.equalsDeep = function(object1, object2, depth) {
-  return Util.equalsDeep(object1, object2, depth);
-};
-
-/**
- * Returns an object containing all elements that differ between two objects.
- * <p>
- * This method was designed to be used to create the runtime.json file
- * contents, but can be used to get the diffs between any two Javascript objects.
- * </p>
- * <p>
- * It works best when object2 originated by deep copying object1, then
- * changes were made to object2, and you want an object that would give you
- * the changes made to object1 which resulted in object2.
- * </p>
- *
- * <b>This function has a number of issues and you may be better off with lodash</b>
- *
- * @protected
- * @deprecated please investigate lodash or similar tools for object traversal
- * @method diffDeep
- * @param object1 {Object} The base object to compare to
- * @param object2 {Object} The object to compare with
- * @param depth {integer} An optional depth to prevent recursion.  Default: 20.
- * @return {Object} A differential object, which if extended onto object1 would
- *                  result in object2.
- */
-util.diffDeep = function(object1, object2, depth) {
-  // Recursion detection
-  const diff = {};
-  depth = (depth === null ? DEFAULT_CLONE_DEPTH : depth);
-  if (depth < 0) {
-    return {};
-  }
-
-  // Process each element from object2, adding any element that's different
-  // from object 1.
-  for (const parm in object2) {
-    const value1 = object1[parm];
-    const value2 = object2[parm];
-    if (value1 && value2 && Util.isObject(value2)) {
-      if (!(Util.equalsDeep(value1, value2))) {
-        diff[parm] = util.diffDeep(value1, value2, depth - 1);
-      }
-    }
-    else if (Array.isArray(value1) && Array.isArray(value2)) {
-      if(!Util.equalsDeep(value1, value2)) {
-        diff[parm] = value2;
-      }
-    }
-    else if (value1 !== value2){
-      diff[parm] = value2;
-    }
-  }
-
-  // Return the diff object
-  return diff;
-};
-
-/**
- * Extend an object, and any object it contains.
- *
- * This does not replace deep objects, but dives into them
- * replacing individual elements instead.
- *
- * @protected
- * @deprecated please use Util.extendDeep()
- * @method extendDeep
- * @param mergeInto {Object} The object to merge into
- * @param mergeFrom... {object[]} - Any number of objects to merge from
- * @param depth {integer} An optional depth to prevent recursion.  Default: 20.
- * @return {Object} The altered mergeInto object is returned
- */
-util.extendDeep = function(mergeInto, ...vargs) {
-  return Util.extendDeep(mergeInto, ...vargs);
-};
-
-/**
- * Is the specified argument a regular javascript object?
- *
- * The argument is an object if it's a JS object, but not an array.
- *
- * @protected
- * @deprecated please use Util.isObject()
- * @method isObject
- * @param obj {*} An argument of any type.
- * @return {boolean} TRUE if the arg is an object, FALSE if not
- */
-util.isObject = function(obj) {
-  return Util.isObject(obj);
-};
-
-/**
- * Is the specified argument a javascript promise?
- *
- * @protected
- * @deprecated please use Util.isPromise()
- * @method isPromise
- * @param obj {*} An argument of any type.
- * @returns {boolean}
- */
-util.isPromise = function(obj) {
-  return Util.isPromise(obj);
-};
-
-/**
- * <p>Initialize a parameter from the command line or process environment</p>
- *
- * <p>
- * This method looks for the parameter from the command line in the format
- * --PARAMETER=VALUE, then from the process environment, then from the
- * default specified as an argument.
- * </p>
- *
- * @method initParam
- * @deprecated
- * @param paramName {String} Name of the parameter
- * @param [defaultValue] {*} Default value of the parameter
- * @return {*} The found value, or default value
- */
-util.initParam = function (paramName, defaultValue) {
-  return FIRST_LOAD.initParam(paramName, defaultValue);
-}
-
-/**
- * <p>Get Command Line Arguments</p>
- *
- * <p>
- * This method allows you to retrieve the value of the specified command line argument.
- * </p>
- *
- * <p>
- * The argument is case sensitive, and must be of the form '--ARG_NAME=value'
- * </p>
- *
- * @method getCmdLineArg
- * @deprecated
- * @param searchFor {String} The argument name to search for
- * @return {*} false if the argument was not found, the argument value if found
- */
-util.getCmdLineArg = function (searchFor) {
-  return FIRST_LOAD.getCmdLineArg(searchFor);
-}
-
-
-/**
- * <p>Get a Config Environment Variable Value</p>
- *
- * <p>
- * This method returns the value of the specified config environment variable,
- * including any defaults or overrides.
- * </p>
- *
- * @method getEnv
- * @deprecated
- * @param varName {String} The environment variable name
- * @return {String} The value of the environment variable
- */
-util.getEnv = function (varName) {
-  return FIRST_LOAD.getEnv(varName);
-}
-
-
-
-/**
- * Returns a string of flags for regular expression `re`.
- *
- * @protected
- * @deprecated This is an internal implementation detail
- * @param {RegExp} re Regular expression
- * @returns {string} Flags
- */
-util.getRegExpFlags = function (re) {
-  return Util.getRegExpFlags(re);
-};
-
 /**
  * Returns a new deep copy of the current config object, or any part of the config if provided.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "config",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "main": "./lib/config.js",
   "description": "Configuration control for production node deployments",
   "author": "Loren West <open_source@lorenwest.com>",
@@ -30,7 +30,6 @@
     "coffeescript": "2.2.4",
     "cson": "^3.0.1",
     "hjson": "^1.2.0",
-    "js-yaml": "^3.2.2",
     "properties": "~1.2.1",
     "request": "^2.88.2",
     "semver": "5.3.0",
@@ -38,8 +37,8 @@
     "ts-node": "^3.3.0",
     "typescript": "^2.4.2",
     "underscore": "^1.8.3",
-    "vows": ">=0.8.1",
-    "x2js": "^2.0.1"
+    "x2js": "^2.0.1",
+    "yaml": "^2.8.2"
   },
   "repository": {
     "type": "git",
@@ -57,7 +56,6 @@
     "reporter": "lcov"
   },
   "scripts": {
-    "test": "c8 vows test/*.js --spec",
-    "vows": "c8 vows"
+    "test": "NODE_OPTIONS='--no-experimental-strip-types' c8 node --test"
   }
 }

package/parser.js

@@ -11,7 +11,7 @@ const JSON5Module = require('json5');
 const JSON5 = JSON5Module.default || JSON5Module;
 
 var Yaml = null,
-    VisionmediaYaml = null,
+    JSYaml = null,
     Coffee = null,
     Iced = null,
     CSON = null,
@@ -135,34 +135,23 @@ Parser.icedParser = function(filename, content) {
 };
 
 Parser.yamlParser = function(filename, content) {
-  if (!Yaml && !VisionmediaYaml) {
+  if (!Yaml && !JSYaml) {
     // Lazy loading
     try {
-      // Try to load the better js-yaml module
-      Yaml = require(JS_YAML_DEP);
-    }
-    catch (e) {
+      Yaml = require(YAML_DEP);
+    } catch (e) {
       try {
-        // If it doesn't exist, load the fallback visionmedia yaml module.
-        VisionmediaYaml = require(YAML_DEP);
-      }
-      catch (e) { }
+        JSYaml = require(JS_YAML_DEP);
+      } catch (e) {}
     }
   }
+
   if (Yaml) {
-    return Yaml.load(content);
-  }
-  else if (VisionmediaYaml) {
-    // 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';
-    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.')
+    return Yaml.parse(content);
+  } else if (JSYaml) {
+    return JSYaml.load(content);
+  } else {
+    console.error('No YAML parser loaded.  Suggest adding yaml dependency to your package.json file.')
   }
 };