Add group globals by helper

helpers/helpers.js

@@ -17,6 +17,7 @@ exports.tableHeadHtml = tableHeadHtml
 exports.tableRow = tableRow
 exports.deprecated = deprecated
 exports.groupBy = groupBy
+exports.groupGlobalsBy = groupGlobalsBy
 exports._groupBy = _groupBy
 exports._addGroup = _addGroup
 exports.add = add
@@ -40,16 +41,18 @@ function escape (input) {
 }
 
 /**
-replaces {@link} tags with markdown links in the suppied input text
+replaces {@link}, {@linkplain}, and {@linkcode} tags with markdown links in the supplied input text
 */
 function inlineLinks (text, options) {
   if (text) {
-    const links = ddata.parseLink(text)
+    const dmdOptions = options.data.root.options
+    const links = ddata.parseLink(text, dmdOptions)
     links.forEach(function (link) {
+      const captionFmt = link.format === 'code' ? '`' : ''
       const linked = ddata._link(link.url, options)
       if (link.caption === link.url) link.caption = linked.name
       if (linked.url) link.url = linked.url
-      text = text.replace(link.original, '[' + link.caption + '](' + link.url + ')')
+      text = text.replace(link.original, '[' + captionFmt + link.caption + captionFmt + '](' + link.url + ')')
     })
   }
   return text
@@ -170,6 +173,11 @@ function groupBy (groupByFields, options) {
   return handlebars.helpers.each(_groupChildren.call(this, groupByFields, options), options)
 }
 
+function groupGlobalsBy (groupByFields, options) {
+  groupByFields = arrayify(groupByFields)
+  return handlebars.helpers.each(_groupBy(ddata._globals(options), groupByFields), options)
+}
+
 function _addGroup (identifiers, groupByFields) {
   return identifiers.map(function (identifier) {
     identifier._group = groupByFields.map(function (field) {

package.json

@@ -22,7 +22,7 @@
     "partials"
   ],
   "scripts": {
-    "test": "test-runner test/*.js test/ddata/*.js"
+    "test": "test-runner test/*.js test/ddata/*.js test/helpers/*.js"
   },
   "dependencies": {
     "array-back": "^6.2.2",
@@ -40,6 +40,7 @@
   },
   "devDependencies": {
     "dmd-plugin-example": "^0.1.0",
+    "mock-require": "^3.0.3",
     "test-runner": "^0.10.1"
   },
   "standard": {

test/helpers/group-globals-by.js

@@ -0,0 +1,48 @@
+const Tom = require('test-runner').Tom
+console.error('mocking...')
+const mock = require('mock-require')
+mock('handlebars', {
+  helpers: {
+    each: function (arg) { return arg }
+  }
+})
+
+const helpers = mock.reRequire('../../helpers/helpers')
+const DmdOptions = require('../../lib/dmd-options')
+const assert = require('assert').strict
+
+const tom = module.exports = new Tom('groupGlobalsBy')
+
+function makeOptions (data) {
+  return { 
+    data: { root: data },
+    hash: {},
+    inverse: function() {},
+    fn: function() {}
+  }
+}
+
+tom.test('sorts globals according to sort fields', function () {
+  const options = makeOptions([
+    { id: '1', category: 'foo', scope: 'global' },
+    { id: '2', category: 'foo', scope: 'global' },
+    { id: '3', category: 'bar', scope: 'global' },
+    { id: '4', category: 'bar', scope: 'global' },
+    { id: '5', scope: 'global' },
+    { id: 'not global' }
+  ])
+  const dmdOptions = new DmdOptions(options)
+  const groupByFields = dmdOptions['group-by']
+  const result = helpers.groupGlobalsBy(groupByFields, options)
+  assert.deepEqual(result, [
+    { _title: 'foo', level: 0 },
+    { id: '1', category: 'foo', scope: 'global', level: 1 },
+    { id: '2', category: 'foo', scope: 'global', level: 1 },
+    { _title: 'bar', level: 0 },
+    { id: '3', category: 'bar', scope: 'global', level: 1 },
+    { id: '4', category: 'bar', scope: 'global', level: 1 },
+    { id: '5', level: 0, scope: 'global' }
+  ])
+})
+
+mock.stopAll()