remove group-by

Author: 75lb

es5/jsdoc-parse.js

@@ -9,7 +9,6 @@ var t = require('typical');
 
 exports.parse = parse;
 exports.getStats = getStats;
-exports.groupBy = groupBy;
 
 function parse(jsdocExplainOutput, options) {
   options = new ParseOptions(options);
@@ -34,10 +33,6 @@ function parse(jsdocExplainOutput, options) {
     data = sort(data, ['scope', 'category', 'kind', 'order']);
   }
 
-  if (options['group-by']) {
-    data = groupBy(data, options['group-by']);
-  }
-
   return data;
 }
 
@@ -66,67 +61,6 @@ function sort(array, sortBy) {
   }
 }
 
-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);
 }

lib/jsdoc-parse.js

@@ -13,15 +13,13 @@ const t = require('typical')
 
 exports.parse = parse
 exports.getStats = getStats
-exports.groupBy = groupBy
 
 /**
  * @param {object[]} - jsdoc output
  * @param [options] {object}
  * @param [options.private] {boolean} - Include identifier documentation marked as `@private` in the output
  * @param [options.html] {boolean} - Enable experimental parsing of .html files.
  * @param [options.sort-by=[ 'scope', 'category', 'kind', 'order' ]] {string[]} - Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to remove the default sort order.
- * @param [options.group-by] {string[]}
  */
 function parse (jsdocExplainOutput, options) {
   options = new ParseOptions(options)
@@ -44,10 +42,6 @@ function parse (jsdocExplainOutput, options) {
     data = sort(data, [ 'scope', 'category', 'kind', 'order' ])
   }
 
-  if (options['group-by']) {
-    data = groupBy(data, options['group-by'])
-  }
-
   return data
 }
 
@@ -86,74 +80,6 @@ function sort (array, sortBy) {
   }
 }
 
-function _addGroup (doclets, groupByFields) {
-  return doclets.map(doclet => {
-    doclet._group = groupByFields
-      .map(field => t.isDefined(doclet[field]) ? doclet[field] : null)
-    return doclet
-  })
-}
-
-/**
- * takes the children of this, groups them, inserts group headings..
- */
-function groupBy (doclets, groupByFields) {
-  var commonSequence = require('common-sequence')
-
-  /* don't modify the input array */
-  groupByFields = groupByFields.slice(0)
-
-  /* remove groupByFields that don't have any values */
-  // console.error(groupByFields)
-  groupByFields
-    .forEach(group => {
-      const docletGroupValues = doclets
-        .filter(doclet => doclet.kind !== 'constructor')
-        .map(d => d[group])
-      let groupValues = a.unique(docletGroupValues)
-      if (groupValues.length <= 1) groupByFields = a.without(groupByFields, group)
-    })
-  // console.error(groupByFields)
-  doclets = _addGroup(doclets, groupByFields)
-
-  var inserts = []
-  var prevGroup = []
-  doclets.forEach((doclet, index) => {
-    if (!deepEqual(doclet._group, prevGroup)) {
-      var common = commonSequence(doclet._group, prevGroup)
-      doclet._group.forEach((group, i) => {
-        if (group !== common[i] && group !== null) {
-          inserts.push({
-            index: index,
-            group: group
-          })
-        }
-      })
-    }
-    prevGroup = doclet._group
-    delete doclet._group
-  })
-
-  /* insert group records */
-  inserts.reverse().forEach((insert, i) => {
-    // console.error(i, insert)
-    doclets.splice(insert.index, 0, { id: insert.group, kind: 'group', parentId: null })
-  })
-
-  /* update parentIds for group members */
-  let currentGroup = null
-  doclets.forEach((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)
 }