dgeni-packages/base/processors/computeIds.js

A collection of dgeni packages for generating documentation from source code

const templateFn = require('lodash.template');

/**
 * @dgProcessor computeIdsProcessor
 * @description
 * Compute the id property of each doc based on the tags and other meta-data from a set of templates
 */
module.exports = function computeIdsProcessor(log, aliasMap, createDocMessage) {

  function initializeMaps(idTemplates) {
    const getIdMap = new Map();
    const getAliasesMap = new Map();

    idTemplates.forEach(template => {
      if ( template.docTypes ) {
        template.docTypes.forEach(docType => {

          if ( template.getId ) {
            getIdMap.set(docType, template.getId);
          } else if ( template.idTemplate ) {
             getIdMap.set(docType, templateFn(template.idTemplate));
          }

          if ( template.getAliases ) {
            getAliasesMap.set(docType, template.getAliases);
          }

        });
      }
    });

    return {getIdMap, getAliasesMap};
  }

  return {
    $runAfter: ['computing-ids'],
    $runBefore: ['ids-computed'],
    $validate: {
      idTemplates: { presence: true }
    },
    idTemplates: [],
    $process(docs) {
      const {getIdMap, getAliasesMap} = initializeMaps(this.idTemplates);

      docs.forEach(doc => {
        try {
          if ( !doc.id ) {
            const getId = getIdMap.get(doc.docType);
            if ( !getId ) {
              log.warn(createDocMessage('No idTemplate or getId(doc) method provided', doc));
            } else {
              doc.id = getId(doc);
            }
          }

          if ( !doc.aliases ) {
            const getAliases = getAliasesMap.get(doc.docType);
            if ( !getAliases ) {
              log.warn(createDocMessage('No getAlias(doc) method provided', doc));
            } else {
              doc.aliases = getAliases(doc);
            }
          }

          aliasMap.addDoc(doc);

        } catch(err) {
          throw new Error(createDocMessage('Failed to compute ids/aliases for doc', doc, err));
        }

        log.debug('computed id for:', '"' + doc.id + '" (' + doc.docType + ')');

      });
    }
  };
};