@creativefeather/config/src/index.js

/**
 * @file @creativefeather/config/src/index.js
 * @author creativefeather <creativefeather@outlook.com>
 * @license MIT
 * 
 * @Symbols:
 *   Symbol.for('config module root')
 *   Symbol.for('config options')
 *   Symbol.for('utils')
 */
const path = require('path'),
      { getConfig } = require('./lib');

const MODULE_ROOT = path.join(__dirname, '../');
const debug_i = require('./lib/debug-logger')('index');

let utils = Object.create(null);
let _isConfigFrozen = (() => {

})();

/**
 * Gets the configuration specified from options
 * @param {string | object} options 
 */
utils.get = (options) => {
  let config = getConfig(null, options);

  config[Symbol.for('utils')] = utils;
  debug_i('Symbol.for(utils)');  

  return config;
};

/**
 * Initiates the config module, freezing the values.
 * @param {object} options 
 */
utils.use = (options) => {
  // TODO: Make a way to lock/freeze config
  if (_isConfigFrozen) {
    debug_i.error('module is already initiated!')
  }

  let config = utils.get(options);

  // Because the module is potentially 'redefined' when use is called, we'll differentiate between when the module is initializing the first time and when it has already initialized.
  if (module.loaded) {
    require.cache[module.filename] = config;
  }
  else {
    module.exports = config;
  }

  return config;
};

utils.moduleRoot = () => {
  return MODULE_ROOT;
}

// *** End of utils definitions ***
Object.freeze(utils);
// *** End of utils definitions ***



// *** Exports ***
if (!process.env.CONFIG_PREVENT_DEFAULT) {
  utils.use();
}
else {
  debug_i('Symbol.for(utils)');
  module.exports[Symbol.for('utils')] = utils;
}