documentation/lib/sort.js

'use strict';

var remark = require('remark');
var inlineTokenizer = require('./inline_tokenizer');

function parseMarkdown(string) {
  return remark.use(inlineTokenizer).parse(string);
}

/**
 * Sort two documentation objects, given an optional order object. Returns
 * a numeric sorting value that is compatible with stream-sort.
 *
 * @param {Array<Object>} comments all comments
 * @param {Object} options options from documentation.yml
 * @return {number} sorting value
 * @private
 */
module.exports = function sortDocs(comments, options) {
  if (!options || !options.toc) {
    return comments.sort(function (a, b) {
      return a.context.sortKey.localeCompare(b.context.sortKey);
    });
  }
  var indexes = options.toc.reduce(function (memo, val, i) {
    if (typeof val === 'object' && val.name) {
      val.kind = 'note';
      memo[val.name] = i;
    } else {
      memo[val] = i;
    }
    return memo;
  }, {});
  var fixed = options.toc.filter(function (val) {
    return typeof val === 'object' && val.name;
  }).map(function (val) {
    if (val.description) {
      val.description = parseMarkdown(val.description);
    }
    return val;
  });
  var unfixed = [];
  comments.forEach(function (comment) {
    if (!comment.memberof && indexes[comment.name] !== undefined) {
      fixed.push(comment);
    } else {
      unfixed.push(comment);
    }
  });
  fixed.sort(function (a, b) {
    if (indexes[a.name] !== undefined && indexes[b.name] !== undefined) {
      return indexes[a.name] - indexes[b.name];
    }
  });
  unfixed.sort(function (a, b) {
    return a.context.sortKey.localeCompare(b.context.sortKey);
  });
  return fixed.concat(unfixed);
};