chore(api-builder): add a service to disambiguate docs by module

Author: petebacondarwin

tools/api-builder/links-package/index.js

@@ -10,11 +10,16 @@ module.exports = new Package('links', [])
 .factory(require('dgeni-packages/links/services/getDocFromAlias'))
 .factory(require('./services/getLinkInfo'))
 .factory(require('./services/parseArgString'))
+.factory(require('./services/moduleScopeLinkDisambiguator'))
 .factory(require('./services/getApiFragmentFileName'))
 
 .config(function(inlineTagProcessor, linkInlineTagDef, linkDevGuideInlineTagDef, exampleInlineTagDef, exampleTabsInlineTagDef) {
   inlineTagProcessor.inlineTagDefinitions.push(linkInlineTagDef);
   inlineTagProcessor.inlineTagDefinitions.push(linkDevGuideInlineTagDef);
   inlineTagProcessor.inlineTagDefinitions.push(exampleInlineTagDef);
   inlineTagProcessor.inlineTagDefinitions.push(exampleTabsInlineTagDef);
+})
+
+.config(function(getLinkInfo, moduleScopeLinkDisambiguator) {
+  getLinkInfo.disambiguators.push(moduleScopeLinkDisambiguator);
 });

tools/api-builder/links-package/services/moduleScopeLinkDisambiguator.js

@@ -0,0 +1,15 @@
+var _ = require('lodash');
+
+module.exports = function moduleScopeLinkDisambiguator() {
+  return function(url, title, currentDoc, docs) {
+    if (docs.length > 1) {
+      // filter out target docs that are not in the same module as the source doc
+      var filteredDocs = _.filter(docs, function(doc) {
+        return doc.moduleDoc === currentDoc.moduleDoc;
+      });
+      // if all target docs are in a different module then just return the full collection of ambiguous docs
+      return filteredDocs.length > 0 ? filteredDocs : docs;
+    }
+    return docs;
+  };
+};