@keg-hub/parse-config/src/yml/yml.js

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

const yaml = require('js-yaml')
const { throwError } = require('../error')
const writeYamlFile = require('write-yaml-file')
const { convertValue } = require('../utils/expand')
const { limbo, noOpObj, noPropArr, isObj, isStr } = require('@keg-hub/jsutils')
const {
  getContent,
  getContentSync,
  loadTemplate,
  mergeFiles,
  removeFile,
  resolveArgs,
} = require('../utils')

/**
 * Recursively loops through the passed in content object
 * Checks each key/value pair looking for a string value
 * When found, calls convertValue to run bash expansion on it
 *
 * @param {Object} content - Parsed yaml file values
 *
 * @returns {Object} Parsed yaml file values including bash expansion where needed
 */
const recurseExpand = content => {
  return Object.entries(content).reduce((acc, [ key, value ]) => {
    acc[key] = isObj(value)
      ? recurseExpand(value)
      : isStr(value)
        ? convertValue(content, value)
        : value

    return acc
  }, {})
}

/**
 * Loads a YML file from a path and parses it synchronously
 * @function
 * @param {Object|string} args - Arguments that describe what file to load
 * @param {Object} args.data - Data to file the file with, if it's a template
 * @param {string} args.format - Type that should be returned ( string || Object )
 * @param {boolean} args.fill - Should the content be treated as a template
 * @param {RegEx} args.pattern - Pattern to match against template values
 * @param {string} args.location - Path to the ENV file
 * @param {boolean} [args.error=true] - Should errors be thrown
 *
 * @returns {Object|string} - Parse YML file
 */
const loadYmlSync = args => {
  const { location, error } = resolveArgs(args)
  // Load the yaml file content
  const content = getContentSync(location, error, `Yml`)
  const loaded = loadTemplate(args, content, yaml.safeLoad)

  return recurseExpand(loaded)
}

/**
 * Loads a YML file from a path and parses it
 * @function
 * @param {Object|string} args - Arguments that describe what file to load
 * @param {Object} args.data - Data to file the file with, if it's a template
 * @param {string} args.format - Type that should be returned ( string || Object )
 * @param {boolean} args.fill - Should the content be treated as a template
 * @param {RegEx} args.pattern - Pattern to match against template values
 * @param {string} args.location - Path to the ENV file
 * @param {RegEx} args.pattern - Pattern to match against template values
 * @param {boolean} [args.error=true] - Should errors be thrown
 *
 * @returns {Object|string} - Parse YML file
 */
const loadYml = async args => {
  const { location, error } = resolveArgs(args)
  // Load the yaml file content
  const content = await getContent(location, error, `Yml`)
  const loaded = loadTemplate(args, content, yaml.safeLoad)

  return recurseExpand(loaded)
}

/**
 * Writes a javascript object to a YML file at the passed in path
 * Checks if the file exists first, then confirms overwrite
 * @function
 * @throws
 * @param {string} location - Location to write the YML file to
 * @param {Object|Array} data - Data to write to the YML file
 * @param {boolean} preConfirm - Bypass ask to overwrite existing file
 *
 * @returns {boolean} - If the YML file could be written
 */
const writeYml = async (location, data = noOpObj, error) => {
  const [err] = await limbo(writeYamlFile(location, data))
  return err && error ? throwError(err.stack) : true
}

/**
 * Loads multiple yml files from an array of passed in files paths
 * Then merges them all together
 * @function
 * @param {Array} args.files - Array of yml files paths to load
 * @param {string} args.data - Data to file the Yml file with, if it's a template
 * @param {RegEx} args.pattern - Pattern to match against template values
 * @param {boolean} args.error - If an error should be thrown when yml file does not exist
 *
 * @returns {Object} - Merged files as an Object
 */
const mergeYml = async args => {
  return await mergeFiles({
    data: noOpObj,
    files: noPropArr,
    ...args,
    loader: loadYml,
  })
}

/**
 * Removes a yml file from the local file system
 * @function
 * @param {Array} location - Path to the yml file
 *
 * @returns {boolean} - If the file could be removed
 */
const removeYml = async location => {
  return await removeFile(location, 'Yml')
}

module.exports = {
  loadYml,
  loadYmlSync,
  mergeYml,
  removeYml,
  writeYml,
  yml: {
    load: loadYml,
    loadSync: loadYmlSync,
    merge: mergeYml,
    remove: removeYml,
    write: writeYml,
  },
}