base-config-process/lib/fields/asyncHelpers.js

Commonly used config mappings for the base-config plugin. Also pre-processes the given object with base-config-schema before calling `.process()`

'use strict';

var debug = require('../debug');

/**
 * _(Requires [templates][], otherwise ignored)_
 *
 * Register helpers to use in templates. Value can be a string or
 * array of module names, glob patterns, or file paths, or an object
 * where each key is a filepath, glob or module name, and the value
 * is an options object to pass to resolved helpers.
 *
 * _(Modules must be locally installed and listed in `dependencies` or
 * `devDependencies`)_.
 *
 * ```json
 * // module names
 * {
 *   "verb": {
 *     "helpers": {
 *       "helper-foo": {},
 *       "helper-bar": {}
 *     }
 *   }
 * }
 *
 * // register a glob of helpers
 * {
 *   "verb": {
 *     "helpers": ["foo/*.js"]
 *   }
 * }
 * ```
 * @name helpers
 * @api public
 */

module.exports = function(app) {
  return function(helpers, key, config, next) {
    if (typeof app.asyncHelper !== 'function') {
      next(new Error('expected app.asyncHelper to be a function'));
      return;
    }

    debug.field(key, helpers);

    for (var prop in helpers) {
      debug('loading async helper "%s"', prop);
      this.asyncHelper(prop, helpers[prop].fn);
    }
    next();
  };
};