dgeni-alive/src/packages/links-ext/inline-tag-defs/link.js

Live doc generator on top of Dgeni

var encoder = new require('node-html-encoder').Encoder();

var INLINE_LINK = /(\S+)(?:\s+([\s\S]+))?/;

/**
 * @dgService linkInlineTagDef
 * @description
 * Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors
 * @kind function
 * @param  {Object} url   The url to match
 * @param  {Function} docs error message
 * @return {String}  The html link information
 *
 * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc
 */
module.exports = function linkInlineTagDef(getLinkInfo, createDocMessage, log) {
  return {
    name: 'link',
    description: 'Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors',
    handler: function(doc, tagName, tagDescription) {

      // Parse out the uri and title
      return tagDescription.replace(INLINE_LINK, function(match, uri, title) {

        var linkInfo = getLinkInfo(uri, title, doc);

        if ( !linkInfo.valid ) {
          log.warn(createDocMessage(linkInfo.error, doc));
        }

        var link = '<a href="' + linkInfo.url + '"';
        if (linkInfo.external) {
          link += ' _target="blank"';
        }
        link += '>' + encoder.htmlEncode(linkInfo.title) + '</a>';

        return  link;
      });
    }
  };
};