@keg-hub/parse-config/src/utils/appRoot.js

Utils to allow loading non-javascript files into a node environment

/** @module CLI */

const path = require('path')
const appPath = require('app-root-path').path
const packRoot = path.join(__dirname, '../../').slice(0, -1)

/**
 * Root directory of the application running cli-utils tasks
 * @string
 * @private
 */
let __APP_ROOT

/**
 * Sets the applications root directory
 * Helpful when app-root-path can not find the correct directory
 * @function
 * @public
 * @param {string} location - Path to the applications root directory
 *
 * @returns {void}
 */
const setAppRoot = location => {
  if(!__APP_ROOT && location !== appPath && location !== packRoot)
    __APP_ROOT = location
}

/**
 * Recursively finds the root parent module, and returns its directory path
 * @function
 * @private
 * @param {Object} parentModule - parent module of the caller
 *
 * @returns {string} Found root path of the root parent module
 */
const getRootParentModule = parentModule => {
  return parentModule.parent
    ? getRootParentModule(parentModule.parent)
    : path.dirname(parentModule.path)
}

/**
 * Gets the root apps path, even when the parse-config is sym-linked
 * @function
 * @private
 *
 * @returns {string} Found root path of the calling application
 */
const getAppRoot = () => {
  return __APP_ROOT
    ? __APP_ROOT
    : packRoot === appPath
      ? getRootParentModule(module.parent)
      : appPath
}

module.exports = {
  getAppRoot,
  setAppRoot,
}