es5

Author: 75lb

es5/jsdoc-parse.js

@@ -1,14 +1,18 @@
 'use strict';
 
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
 var sortArray = require('sort-array');
 var transform = require('./transform');
 var a = require('array-tools');
+var t = require('typical');
 
 exports.parse = parse;
 exports.getStats = getStats;
+exports.groupBy = groupBy;
 
 function parse(jsdocExplainOutput, options) {
-  options = options || {};
+  options = new ParseOptions(options);
   var data = transform(jsdocExplainOutput);
 
   data = data.filter(function (doclet) {
@@ -26,6 +30,12 @@ function parse(jsdocExplainOutput, options) {
 
   if (options['sort-by'] && !a(options['sort-by']).contains('none')) {
     data = sort(data, options['sort-by']);
+  } else if (!options['sort-by']) {
+    data = sort(data, ['scope', 'category', 'kind', 'order']);
+  }
+
+  if (options['group-by']) {
+    data = groupBy(data, options['group-by']);
   }
 
   return data;
@@ -44,14 +54,91 @@ function getStats(jsdocExplainOutput) {
 }
 
 function sort(array, sortBy) {
-  var order = {
-    kind: ['class', 'constructor', 'mixin', 'member', 'namespace', 'constant', 'function', 'event', 'typedef', 'external'],
+  var customSortOrders = {
+    kind: ['class', 'constructor', 'mixin', 'member', 'namespace', 'enum', 'constant', 'function', 'event', 'typedef', 'external'],
     scope: ['global', 'instance', 'static', 'inner']
   };
 
   if (!sortBy) {
     return array;
   } else {
-    return sortArray(array, sortBy, order);
+    return sortArray(array, sortBy, customSortOrders);
   }
-}
+}
+
+function _addGroup(doclets, groupByFields) {
+  return doclets.map(function (doclet) {
+    doclet._group = groupByFields.map(function (field) {
+      return t.isDefined(doclet[field]) ? doclet[field] : null;
+    });
+    return doclet;
+  });
+}
+
+function groupBy(doclets, groupByFields) {
+  var commonSequence = require('common-sequence');
+
+  groupByFields = groupByFields.slice(0);
+
+  groupByFields.forEach(function (group) {
+    var docletGroupValues = doclets.filter(function (doclet) {
+      return doclet.kind !== 'constructor';
+    }).map(function (d) {
+      return d[group];
+    });
+    var groupValues = a.unique(docletGroupValues);
+    if (groupValues.length <= 1) groupByFields = a.without(groupByFields, group);
+  });
+
+  doclets = _addGroup(doclets, groupByFields);
+
+  var inserts = [];
+  var prevGroup = [];
+  doclets.forEach(function (doclet, index) {
+    if (!deepEqual(doclet._group, prevGroup)) {
+      var common = commonSequence(doclet._group, prevGroup);
+      doclet._group.forEach(function (group, i) {
+        if (group !== common[i] && group !== null) {
+          inserts.push({
+            index: index,
+            group: group
+          });
+        }
+      });
+    }
+    prevGroup = doclet._group;
+    delete doclet._group;
+  });
+
+  inserts.reverse().forEach(function (insert, i) {
+    doclets.splice(insert.index, 0, { id: insert.group, kind: 'group', parentId: null });
+  });
+
+  var currentGroup = null;
+  doclets.forEach(function (d, index) {
+    d.parentId = currentGroup;
+    if (index === 0) {
+      currentGroup = d.id;
+    } else {
+      if (d.kind === 'group') currentGroup = d.id;
+    }
+  });
+
+  return doclets;
+}
+
+function deepEqual(a, b) {
+  return JSON.stringify(a) === JSON.stringify(b);
+}
+
+var ParseOptions = function ParseOptions(options) {
+  _classCallCheck(this, ParseOptions);
+
+  options = options || {};
+
+  this['group-by'] = null;
+
+  this['sort-by'] = ['scope', 'category', 'kind', 'order'];
+
+  Object.assign(this, options);
+};

es5/transform.js

@@ -7,7 +7,7 @@ var testValue = require('test-value');
 module.exports = transform;
 
 function transform(data) {
-  data = fixConstructorMemberLongnames(data);
+  data = fixES6ConstructorMemberLongnames(data);
 
   var json = data.filter(function (i) {
     return !i.undocumented && !/package|file/.test(i.kind);
@@ -19,7 +19,6 @@ function transform(data) {
 
   json = json.map(function (doclet) {
     doclet = setID(doclet);
-    doclet = setParentID(doclet);
 
     doclet = removeQuotes(doclet);
     doclet = cleanProperties(doclet);
@@ -45,6 +44,7 @@ function transform(data) {
   });
 
   json = removeEnumChildren(json);
+  json = json.map(setParentID);
   json = json.map(removeUnwanted);
   json = json.map(sortIdentifier);
 
@@ -102,14 +102,14 @@ function createConstructor(class_) {
   var replacements = [];
   class_ = o.clone(class_);
   var constructor = o.extract(class_, ['description', 'params', 'examples', 'returns', 'exceptions']);
-
   if (class_.classdesc) {
     class_.description = class_.classdesc;
     delete class_.classdesc;
   }
   replacements.push(class_);
 
   if (constructor.description || constructor.params && constructor.params.length) {
+    constructor.id = class_.id;
     constructor.longname = class_.longname;
     constructor.name = class_.codeName || class_.name;
     constructor.kind = 'constructor';
@@ -161,7 +161,7 @@ function isES6Constructor(doclet) {
 }
 
 function replaceID(id, oldID, newID) {
-  return id.replace(new RegExp('\b' + oldID + '\b'), newID);
+  return id.replace(new RegExp('' + oldID), newID);
 }
 
 function updateIDReferences(doclet, newID) {
@@ -344,7 +344,7 @@ function removeMemberofFromModule(doclet) {
   return doclet;
 }
 
-function fixConstructorMemberLongnames(data) {
+function fixES6ConstructorMemberLongnames(data) {
   data.forEach(function (i) {
     if (isES6Class(i)) {
       var es6constructor = getEs6Constructor(data, i);

test/group-by.js

@@ -3,13 +3,13 @@ var test = require('tape')
 var jsdocParse = require('../')
 
 test('groupBy', function (t) {
-  const fixture = require('./fixture/deep-class')
+  var fixture = require('./fixture/deep-class')
   console.log(jsdocParse.groupBy(fixture, [ 'scope', 'category' ]))
   t.end()
 })
 
 test.only('groupBy2', function (t) {
-  const fixture = require('./fixture/deep-class')
+  var fixture = require('./fixture/deep-class')
   console.log(jsdocParse.groupBy(fixture, [ 'scope' ]))
   t.end()
 })