dgeni-packages/ngdoc/processors/moduleDocs.js

A collection of dgeni packages for generating documentation from source code

/**
 * @dgProcessor moduleDocsProcessor
 * @description
 * Compute the various fields for modules
 */
module.exports = function moduleDocsProcessor(log, aliasMap, moduleMap, createDocMessage) {
  return {
    $runAfter: ['ids-computed', 'memberDocsProcessor'],
    $runBefore: ['computing-paths'],
    $process(docs) {
      // Compute some extra fields for docs in the API area
      docs.forEach(doc => {

        if ( doc.docType === 'module' ) {

          moduleMap.set(doc.id, doc);

          // Create a place to store references to the module's components
          doc.components = [];

          // Compute the package name and filename for the module
          const match = /^ng(.*)/.exec(doc.name);
          if ( match ) {
            if ( !doc.packageName ) {
              let packageName = match[1].toLowerCase();
              if ( packageName ) { packageName = '-' + packageName; }
              doc.packageName = 'angular' + packageName;
            }
            doc.packageFile = doc.packageName + '.js';
          }
        }
      });


      // Attach each doc to its module
      docs.forEach(doc => {
        if ( doc.docType !== 'module' && doc.module ) {
          let matchingModules = aliasMap.getDocs(doc.module);

          if ( matchingModules.length > 1 ) {
            // try matching with the 'module:' specifier
            matchingModules = aliasMap.getDocs('module:' + doc.module);
          }

          if ( matchingModules.length === 1 ) {
            const module = matchingModules[0];
            if (module.docType === 'module') {
              module.components.push(doc);
            } else {
              throw new Error(createDocMessage('"' + module.name + '" is not a module. It is documented as "' + module.docType + '". Either the module is incorrectly typed or the module reference is invalid', doc));
            }
            doc.moduleDoc = module;
          } else if ( matchingModules.length > 1 ) {
            let error = createDocMessage('Ambiguous module reference: "' + doc.module + '"', doc);
            error += '\nMatching modules:\n';
            matchingModules.forEach(mod => error += '- ' + mod.id + '\n');
            throw new Error(error);
          }
        }
      });

    }
  };
};