filter and sort

Author: 75lb

es5/jsdoc-parse.js

@@ -1,48 +1,38 @@
 'use strict';
 
 var sortArray = require('sort-array');
-var fileSet = require('file-set');
-var Transform = require('stream').Transform;
 var transform = require('./transform');
-var collectJson = require('collect-json');
-var assert = require('assert');
-var connect = require('stream-connect');
-var fs = require('fs');
+var a = require('array-tools');
 
 exports.parse = parse;
 exports.getStats = getStats;
 
 function parse(jsdocExplainOutput, options) {
+  options = options || {};
   var data = transform(jsdocExplainOutput);
 
-  return data;
-}
-
-function applyOptions(data, options) {
-  if (options.stats) {
-    return JSON.stringify(getStats(data), null, '  ') + '\n';
-  } else {
-    data = data.filter(function (item) {
-      var parent = data.find(function (d) {
-        return d.id === item.memberof;
-      }) || {};
-      if (item.ignore || parent.ignore) {
-        return false;
-      } else if (!options.private && item.access === 'private' || parent.access === 'private') {
-        return false;
-      } else {
-        return true;
-      }
-    });
-
-    if (options['sort-by'] && !a(options['sort-by']).contains('none')) {
-      data = sort(data, options['sort-by']);
+  data = data.filter(function (doclet) {
+    var parent = data.find(function (d) {
+      return d.id === doclet.memberof;
+    }) || {};
+    if (doclet.ignore || parent.ignore) {
+      return false;
+    } else if (!options.private && (doclet.access === 'private' || parent.access === 'private')) {
+      return false;
+    } else {
+      return true;
     }
-    return JSON.stringify(data, null, '  ') + '\n';
+  });
+
+  if (options['sort-by'] && !a(options['sort-by']).contains('none')) {
+    data = sort(data, options['sort-by']);
   }
+
+  return data;
 }
 
-function getStats(data) {
+function getStats(jsdocExplainOutput) {
+  var data = parse(jsdocExplainOutput);
   var stats = {
     identifiers: {}
   };

es5/transform.js

@@ -309,7 +309,7 @@ function sort(object, sortFunction) {
 }
 
 function sortIdentifier(doclet) {
-  var fieldOrder = ['id', 'longname', 'name', 'scope', 'kind', 'isExported', 'classdesc', 'augments', 'inherits', 'inherited', 'implements', 'overrides', 'mixes', 'description', 'memberof', 'alias', 'params', 'fires', 'examples', 'returns', 'type', 'defaultvalue', 'readonly', 'thisvalue', 'isEnum', 'properties', 'optional', 'nullable', 'variable', 'author', 'deprecated', 'ignore', 'access', 'requires', 'version', 'since', 'licenses', 'license', 'typicalname', 'category', 'see', 'exceptions', 'codeName', 'todoList', 'customTags', 'chainable', 'meta', 'order'];
+  var fieldOrder = ['id', 'parentId', 'longname', 'name', 'scope', 'kind', 'isExported', 'classdesc', 'augments', 'inherits', 'inherited', 'implements', 'overrides', 'mixes', 'description', 'memberof', 'alias', 'params', 'fires', 'examples', 'returns', 'type', 'defaultvalue', 'readonly', 'thisvalue', 'isEnum', 'properties', 'optional', 'nullable', 'variable', 'author', 'deprecated', 'ignore', 'access', 'requires', 'version', 'since', 'licenses', 'license', 'typicalname', 'category', 'see', 'exceptions', 'codeName', 'todoList', 'customTags', 'chainable', 'meta', 'order'];
   return sort(doclet, function (a, b) {
     if (fieldOrder.indexOf(a) === -1 && fieldOrder.indexOf(b) > -1) {
       return 1;

lib/jsdoc-parse.js

@@ -21,38 +21,25 @@ exports.getStats = getStats
  * @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.
  */
 function parse (jsdocExplainOutput, options) {
-  const data = transform(jsdocExplainOutput)
-  // sort or filter out private
+  options = options || {}
+  let data = transform(jsdocExplainOutput)
 
-  return data
-}
-
-/**
- * @param {string} - input json string
- * @param {object} - jsdoc-parse options
- * @returns {string} - output json string to be streamed out
- * @private
- */
-function applyOptions (data, options) {
-  if (options.stats) {
-    return JSON.stringify(getStats(data), null, '  ') + '\n'
-  } else {
-    data = data.filter(function (item) {
-      var parent = data.find(d => d.id === item.memberof) || {}
-      if (item.ignore || parent.ignore) {
-        return false
-      } else if (!options.private && item.access === 'private' || parent.access === 'private') {
-        return false
-      } else {
-        return true
-      }
-    })
-
-    if (options['sort-by'] && !a(options['sort-by']).contains('none')) {
-      data = sort(data, options['sort-by'])
+  data = data.filter(function (doclet) {
+    var parent = data.find(d => d.id === doclet.memberof) || {}
+    if (doclet.ignore || parent.ignore) {
+      return false
+    } else if (!options.private && (doclet.access === 'private' || parent.access === 'private')) {
+      return false
+    } else {
+      return true
     }
-    return JSON.stringify(data, null, '  ') + '\n'
+  })
+
+  if (options['sort-by'] && !a(options['sort-by']).contains('none')) {
+    data = sort(data, options['sort-by'])
   }
+
+  return data
 }
 
 /**