@reimorg/config 1.0.0

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@reimorg/config",
+  "version": "1.0.0",
+  "author": "Reimorg",
+  "description": "Configuration manager",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./index.js",
+      "default": "./index.js"
+    },
+    "./lib/get.js": "./lib/get.js",
+    "./lib/get.d.ts": "./lib/get.d.ts",
+    "./lib/raw.js": "./lib/raw.js",
+    "./lib/raw.d.ts": "./lib/raw.d.ts",
+    "./lib/util.js": "./lib/util.js",
+    "./lib/util.d.ts": "./lib/util.d.ts"
+  },
+  "keywords": [
+    "config",
+    "configuration",
+    "env",
+    "environment",
+    "environment-variables"
+  ],
+  "directories": {
+    "lib": "./lib"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^7.0.8",
+    "c8": "^10.1.3",
+    "coffeescript": "2.2.4",
+    "cson": "^3.0.1",
+    "hjson": "^1.2.0",
+    "properties": "~1.2.1",
+    "request": "^2.88.2",
+    "semver": "5.3.0",
+    "toml": "^2.0.6",
+    "ts-node": "^3.3.0",
+    "typescript": "^2.4.2",
+    "underscore": "^1.8.3",
+    "x2js": "^2.0.1",
+    "yaml": "^2.8.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/reimorg/config.git"
+  },
+  "engines": {
+    "node": ">= 20.0.0"
+  },
+  "c8": {
+    "include": [
+      "*.js",
+      "*.d.ts",
+      "lib/**/*.js",
+      "lib/**/*.d.ts"
+    ],
+    "report-dir": "./coverage",
+    "reporter": "lcov"
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS='--no-experimental-strip-types' c8 node --test"
+  }
+}

package/parser.d.ts

@@ -0,0 +1,134 @@
+/**
+ * Parser function type for parsing configuration files
+ */
+type ParserFunction = (filename: string, content: string) => any;
+
+/**
+ * Parser object with methods for parsing various configuration file formats
+ */
+declare namespace Parser {
+  /**
+   * Parse a configuration file based on its extension
+   * @param filename The filename (used to determine file type)
+   * @param content The file content to parse
+   * @returns Parsed configuration object
+   */
+  function parse(filename: string, content: string): any;
+
+  /**
+   * Parse XML configuration files
+   */
+  function xmlParser(filename: string, content: string): any;
+
+  /**
+   * Parse JavaScript configuration files (.js, .cjs, .mjs)
+   */
+  function jsParser(filename: string, content: string): any;
+
+  /**
+   * Parse TypeScript configuration files (.ts)
+   */
+  function tsParser(filename: string, content: string): any;
+
+  /**
+   * Parse CoffeeScript configuration files (.coffee)
+   */
+  function coffeeParser(filename: string, content: string): any;
+
+  /**
+   * Parse Iced CoffeeScript configuration files (.iced)
+   */
+  function icedParser(filename: string, content: string): any;
+
+  /**
+   * Parse YAML configuration files (.yaml, .yml)
+   */
+  function yamlParser(filename: string, content: string): any;
+
+  /**
+   * Parse JSON configuration files (.json, .jsonc)
+   */
+  function jsonParser(filename: string, content: string): any;
+
+  /**
+   * Parse JSON5 configuration files (.json5)
+   */
+  function json5Parser(filename: string, content: string): any;
+
+  /**
+   * Parse HJSON configuration files (.hjson)
+   */
+  function hjsonParser(filename: string, content: string): any;
+
+  /**
+   * Parse TOML configuration files (.toml)
+   */
+  function tomlParser(filename: string, content: string): any;
+
+  /**
+   * Parse CSON configuration files (.cson)
+   */
+  function csonParser(filename: string, content: string): any;
+
+  /**
+   * Parse Properties configuration files (.properties)
+   */
+  function propertiesParser(filename: string, content: string): any;
+
+  /**
+   * Strip YAML comments from the string
+   * @param fileStr The string to strip comments from
+   * @returns The string with comments stripped
+   */
+  function stripYamlComments(fileStr: string): string;
+
+  /**
+   * Parses the environment variable to the boolean equivalent.
+   * Defaults to false
+   * @param filename The filename (unused but required for consistency)
+   * @param content Environment variable value
+   * @returns Boolean value of the passed variable value
+   */
+  function booleanParser(filename: string, content: string): boolean;
+
+  /**
+   * Parses the environment variable to the number equivalent.
+   * Defaults to undefined
+   * @param filename The filename (unused but required for consistency)
+   * @param content Environment variable value
+   * @returns Number value of the passed variable value, or undefined if not a number
+   */
+  function numberParser(filename: string, content: string): number | undefined;
+
+  /**
+   * Get a parser function by name
+   * @param name The parser name (e.g., 'json', 'yaml', 'toml')
+   * @returns The parser function, or undefined if not found
+   */
+  function getParser(name: string): ParserFunction | undefined;
+
+  /**
+   * Set a custom parser function for a file extension
+   * @param name The file extension name (e.g., 'json', 'yaml')
+   * @param parser The parser function to use
+   */
+  function setParser(name: string, parser: ParserFunction): void;
+
+  /**
+   * Get the file order array or the index of a specific file type
+   * @param name Optional file type name to get index for
+   * @returns If name is provided, returns the index. Otherwise returns the full order array
+   */
+  function getFilesOrder(name?: string): number | string[];
+
+  /**
+   * Set the file order
+   * @param name File type name or array of file types
+   * @param newIndex Optional new index position (if name is a string)
+   * @returns The updated order array
+   */
+  function setFilesOrder(name: string | string[], newIndex?: number): string[];
+}
+
+export = Parser;
+

package/parser.js

@@ -0,0 +1,299 @@
+// External libraries are lazy-loaded only if these file types exist.
+
+// webpack can't solve dynamic module
+// @see https://github.com/node-config/node-config/issues/755
+// @see https://webpack.js.org/guides/dependency-management/#require-with-expression
+const JSON5Module = require('json5');
+
+// webpack resolves json5 with module field out of the box which lead to this usage
+// @see https://github.com/node-config/node-config/issues/755
+// @see https://github.com/json5/json5/issues/240
+const JSON5 = JSON5Module.default || JSON5Module;
+
+var Yaml = null,
+    JSYaml = null,
+    Coffee = null,
+    Iced = null,
+    CSON = null,
+    PPARSER = null,
+    TOML = null,
+    HJSON = null,
+    XML = null;
+
+// 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';
+
+/**
+ * @typedef Parser {Object}
+ */
+var Parser = module.exports;
+
+Parser.parse = function(filename, content) {
+  var parserName = filename.substr(filename.lastIndexOf('.') +1);  // file extension
+  if (typeof definitions[parserName] === 'function') {
+    return definitions[parserName](filename, content);
+  }
+  // TODO: decide what to do in case of a missing parser
+};
+
+Parser.xmlParser = function(filename, content) {
+  if (!XML) {
+    XML = require(XML_DEP);
+  }
+  var x2js = new XML();
+  var configObject = x2js.xml2js(content);
+  var rootKeys = Object.keys(configObject);
+  if(rootKeys.length === 1) {
+    return configObject[rootKeys[0]];
+  }
+  return configObject;
+};
+
+Parser.jsParser = function(filename, content) {
+  var configObject = require(filename);
+
+  if (configObject.__esModule && isObject(configObject.default)) {
+    return configObject.default
+  }
+  return configObject;
+};
+
+Parser.tsParser = function(filename, content) {
+  if (!require.extensions['.ts']) {
+    require(TS_DEP).register({
+      lazy: true,
+      ignore: ['(?:^|/)node_modules/', '.*(?<!\.ts)$'],
+      transpileOnly: true,
+      compilerOptions: {
+        allowJs: true,
+      }
+    });
+  }
+
+  // Imports config if it is exported via module.exports = ...
+  // 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)
+  // Therefore config is a value of `default` key.
+  if (configObject.default) {
+    return configObject.default
+  }
+  return configObject;
+};
+
+Parser.coffeeParser = function(filename, content) {
+  // .coffee files can be loaded with either coffee-script or iced-coffee-script.
+  // Prefer iced-coffee-script, if it exists.
+  // Lazy load the appropriate extension
+  if (!Coffee) {
+    Coffee = {};
+
+    // The following enables iced-coffee-script on .coffee files, if iced-coffee-script is available.
+    // This is commented as per a decision on a pull request.
+    //try {
+    //  Coffee = require('iced-coffee-script');
+    //}
+    //catch (e) {
+    //  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) {
+      Coffee.register();
+    }
+  }
+  // Use the built-in parser for .coffee files with coffee-script
+  return require(filename);
+};
+
+Parser.icedParser = function(filename, content) {
+  Iced = require(ICED_DEP);
+
+  // coffee-script >= 1.7.0 requires explicit registration for require() to work
+  if (Iced.register) {
+    Iced.register();
+  }
+};
+
+Parser.yamlParser = function(filename, content) {
+  if (!Yaml && !JSYaml) {
+    // Lazy loading
+    try {
+      Yaml = require(YAML_DEP);
+    } catch (e) {
+      try {
+        JSYaml = require(JS_YAML_DEP);
+      } catch (e) {}
+    }
+  }
+
+  if (Yaml) {
+    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.')
+  }
+};
+
+Parser.jsonParser = function(filename, content) {
+  /**
+   * Default JSON parsing to JSON5 parser.
+   * This is due to issues with removing supported comments.
+   * More information can be found here: https://github.com/node-config/node-config/issues/715
+   */
+  return JSON5.parse(content);
+};
+
+Parser.json5Parser = function(filename, content) {
+  return JSON5.parse(content);
+};
+
+Parser.hjsonParser = function(filename, content) {
+  if (!HJSON) {
+    HJSON = require(HJSON_DEP);
+  }
+  return HJSON.parse(content);
+};
+
+Parser.tomlParser = function(filename, content) {
+  if(!TOML) {
+    TOML = require(TOML_DEP);
+  }
+  return TOML.parse(content);
+};
+
+Parser.csonParser = function(filename, content) {
+  if (!CSON) {
+    CSON = require(CSON_DEP);
+  }
+  // Allow comments in CSON files
+  if (typeof CSON.parseSync === 'function') {
+    return CSON.parseSync(content);
+  }
+  return CSON.parse(content);
+};
+
+Parser.propertiesParser = function(filename, content) {
+  if (!PPARSER) {
+    PPARSER = require(PPARSER_DEP);
+  }
+  return PPARSER.parse(content, { namespaces: true, variables: true, sections: true });
+};
+
+/**
+ * Strip YAML comments from the string
+ *
+ * The 2.0 yaml parser doesn't allow comment-only or blank lines.  Strip them.
+ *
+ * @protected
+ * @method stripYamlComments
+ * @param fileStr {string} The string to strip comments from
+ * @return {string} The string with comments stripped.
+ */
+Parser.stripYamlComments = function(fileStr) {
+  // First replace removes comment-only lines
+  // Second replace removes blank lines
+  return fileStr.replace(/^\s*#.*/mg,'').replace(/^\s*[\n|\r]+/mg,'');
+};
+
+/**
+ * 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', 'mjs', 'ts', 'json', 'jsonc', '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,
+  iced: Parser.icedParser,
+  js: Parser.jsParser,
+  json: Parser.jsonParser,
+  jsonc: Parser.jsonParser,
+  json5: Parser.json5Parser,
+  mjs: Parser.jsParser,
+  properties: Parser.propertiesParser,
+  toml: Parser.tomlParser,
+  ts: Parser.tsParser,
+  xml: Parser.xmlParser,
+  yaml: Parser.yamlParser,
+  yml: Parser.yamlParser,
+  boolean: Parser.booleanParser,
+  number: Parser.numberParser
+};
+
+Parser.getParser = function(name) {
+  return definitions[name];
+};
+
+Parser.setParser = function(name, parser) {
+  definitions[name] = parser;
+  if (order.indexOf(name) === -1) {
+    order.push(name);
+  }
+};
+
+Parser.getFilesOrder = function(name) {
+  if (name) {
+    return order.indexOf(name);
+  }
+  return order;
+};
+
+Parser.setFilesOrder = function(name, newIndex) {
+  if (Array.isArray(name)) {
+    return order = name;
+  }
+  if (typeof newIndex === 'number') {
+    var index = order.indexOf(name);
+    order.splice(newIndex, 0, name);
+    if (index > -1) {
+      order.splice(index >= newIndex ? index +1 : index, 1);
+    }
+  }
+  return order;
+};
+
+function isObject(arg) {
+  return (arg !== null) && (typeof arg === 'object');
+}

package/raw.d.ts

@@ -0,0 +1,18 @@
+/**
+ * RawConfig prototype class
+ * This is meant to wrap configuration objects that should be left as is,
+ * meaning that the object or its prototype will not be modified in any way
+ */
+declare class RawConfig {
+  resolve(): any;
+}
+
+/**
+ * Wraps a configuration object to mark it as raw/unmodified
+ * @param rawObj The configuration object to wrap
+ * @returns A RawConfig object with a resolve method that returns the original object
+ */
+declare function raw(rawObj: any): RawConfig;
+
+export { raw, RawConfig };
+

package/raw.js

@@ -0,0 +1,15 @@
+/**
+ * This is meant to wrap configuration objects that should be left as is,
+ * meaning that the object or its prototype will not be modified in any way
+ */
+function RawConfig () {
+}
+
+function raw(rawObj) {
+  var obj = Object.create(RawConfig.prototype);
+  obj.resolve = function () { return rawObj; }
+  return obj;
+}
+
+module.exports.RawConfig = RawConfig;
+module.exports.raw = raw;