http-server-md/lib/config/index.js

A configurable HTTP server that serves markdown files rendered to HTML with markdown-it

const Bluebird = require('bluebird')
const { cosmiconfig } = require('cosmiconfig')
const validateConfig = require('./validate')
const normalizeConfig = require('./normalize')
const loadTemplate = require('./load_template')
const DEFAULT_CONFIG = require('./default')
const mergeConfig = require('./merge')

const APP_NAME = 'httpmd'
const EXPLORER = cosmiconfig(APP_NAME)

/**
 * Resolve the runtime configuration, loading the first user config file found.
 * Searches directories up the path for any of the following files:
 *
 * - `.httpmdrc`
 * - `.httpmdrc.js`
 * - `.httpmdrc.json`
 * - `.httpmdrc.yaml`
 * - `.httpmdrc.yml`
 *
 * Any discovered user config file is merged with the default
 * {@link Sermit~DefaultConfig} object.
 *
 * @todo consider including `basePath` in search
 * @param {object} params - params.
 * @param {string} [params.basePath=cwd] - path to start searching in.
 * @param {string} [params.configPath] - path to pre-loaded user config file,
 *   required if `config` is provided.
 * @param {object} [params.config] - user config file if already found, search
 *   is skipped if provided.
 * @returns {Promise} p - resolves with the final {@link Config} object.
 *
 * @example
 * const config = await getConfig({ basePath: basePath })
 * const { state } = config
 * const { md, configPath, template } = state
 *
 * if (configPath) {
 *   l.star('read config from %s', colors.bgGreen.black(configPath))
 * }
 *
 * if (_isEmpty(command) || command === 'serve' || command === 'render') {
 *   l.star('using template %s', colors.cyan(template.name))
 *
 *   md.pluginNames.forEach((name) => {
 *     l.star('using md plugin %s', colors.yellow(name))
 *   })
 * }
 */
const getConfig = async ({ basePath, configPath, config: userConfig }) => {
  let finalConfig = DEFAULT_CONFIG

  try {
    const res = await (userConfig
      ? Bluebird.resolve({ config: userConfig, filepath: configPath })
      : EXPLORER.search(process.cwd()))

    finalConfig = await mergeConfig([res.config, res.filepath, basePath])
  } catch (err) {
    // eslint-disable-next-line no-console
    console.error(`Failed to resolve config: ${err.message}`)
  }

  return loadTemplate(validateConfig(normalizeConfig(finalConfig)))
}

module.exports = getConfig