use filter-where, remove deps, remove getStats

Author: 75lb

es5/jsdoc-parse.js

@@ -1,17 +1,11 @@
 '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;
 
 function parse(jsdocExplainOutput, options) {
-  options = new ParseOptions(options);
+  options = options || {};
   var data = transform(jsdocExplainOutput);
 
   data = data.filter(function (doclet) {
@@ -27,52 +21,5 @@ 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']);
-  }
-
   return data;
-}
-
-function getStats(jsdocExplainOutput) {
-  var data = parse(jsdocExplainOutput);
-  var stats = {
-    identifiers: {}
-  };
-  var kinds = ['module', 'class', 'constructor', 'mixin', 'member', 'namespace', 'constant', 'function', 'event', 'typedef', 'external'];
-  kinds.forEach(function (kind) {
-    stats.identifiers[kind] = a(data).where({ kind: kind }).pluck('longname').val();
-  });
-  return stats;
-}
-
-function sort(array, sortBy) {
-  var customOrder = {
-    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, customOrder);
-  }
-}
-
-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

@@ -3,6 +3,8 @@
 var o = require('object-tools');
 var a = require('array-tools');
 var testValue = require('test-value');
+var where = require('filter-where');
+var arrayify = require('array-back');
 
 module.exports = transform;
 
@@ -34,8 +36,10 @@ function transform(data) {
     return doclet;
   });
 
-  var exported = a.where(json, { isExported: true });
-  var newIDs = a.pluck(exported, 'id');
+  var exported = json.filter(where({ isExported: true }));
+  var newIDs = exported.map(function (d) {
+    return d.id;
+  });
 
   newIDs.forEach(function (newID) {
     update(json, { isExported: undefined, '!kind': 'module' }, function (doclet) {
@@ -137,7 +141,7 @@ function insertConstructors(data) {
 }
 
 function getEs6Constructor(data, parent) {
-  return a.findWhere(data, function (i) {
+  return data.find(function (i) {
     return isES6Constructor(i) && i.memberof === parent.longname;
   });
 }
@@ -236,7 +240,7 @@ function wantedProperties(input) {
 function buildTodoList(doclet) {
   var todoList = [];
   if (doclet.todo) {
-    var todo = a.arrayify(doclet.todo);
+    var todo = arrayify(doclet.todo);
     todoList = todoList.concat(todo.map(function (task) {
       return { done: false, task: task };
     }));
@@ -349,7 +353,7 @@ function fixES6ConstructorMemberLongnames(data) {
     if (isES6Class(i)) {
       var es6constructor = getEs6Constructor(data, i);
       if (es6constructor) {
-        var constructorChildren = a.where(data, { memberof: es6constructor.longname });
+        var constructorChildren = data.filter(where({ memberof: es6constructor.longname }));
         constructorChildren.forEach(function (child) {
           return child.memberof = i.longname;
         });
@@ -369,7 +373,7 @@ function convertIsEnumFlagToKind(doclet) {
 
 function removeEnumChildren(json) {
   return json.filter(function (doclet) {
-    var parent = a.findWhere(json, { id: doclet.memberof });
+    var parent = json.find(where({ id: doclet.memberof }));
     if (parent && parent.kind === 'enum') {
       return false;
     } else {

index.js

@@ -1,9 +1,12 @@
 var detect = require('feature-detect-es6')
 
-if (detect.all('class', 'arrowFunction', 'let', 'const', 'newArrayFeatures')) {
+if (!detect.newArrayFeatures()) {
+  require('core-js/es6/array')
+}
+
+if (detect.all('class', 'arrowFunction', 'let', 'const')) {
   module.exports = require('./lib/jsdoc-parse')
 } else {
   require('core-js/es6/object')
-  require('core-js/es6/array')
   module.exports = require('./es5/jsdoc-parse')
 }

lib/jsdoc-parse.js

@@ -1,8 +1,5 @@
 'use strict'
-const sortArray = require('sort-array')
 const transform = require('./transform')
-const a = require('array-tools')
-const t = require('typical')
 
 /**
  *
@@ -12,17 +9,14 @@ const t = require('typical')
  */
 
 exports.parse = parse
-exports.getStats = getStats
 
 /**
  * @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.
  */
 function parse (jsdocExplainOutput, options) {
-  options = new ParseOptions(options)
+  options = options || {}
   let data = transform(jsdocExplainOutput)
 
   data = data.filter(function (doclet) {
@@ -36,65 +30,5 @@ 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' ])
-  }
-
   return data
 }
-
-/**
- * return some stats about the parsed data
- * @param {object} - jsdoc-parse data
- * @returns {object}
- * @private
- */
-function getStats (jsdocExplainOutput) {
-  const data = parse(jsdocExplainOutput)
-  var stats = {
-    identifiers: {}
-  }
-  var kinds = [
-    'module', 'class', 'constructor', 'mixin', 'member',
-    'namespace', 'constant', 'function', 'event', 'typedef', 'external'
-  ]
-  kinds.forEach(function (kind) {
-    stats.identifiers[kind] = a(data).where({ kind: kind }).pluck('longname').val()
-  })
-  return stats
-}
-
-function sort (array, sortBy) {
-  var customOrder = {
-    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, customOrder)
-  }
-}
-
-function deepEqual (a, b) {
-  return JSON.stringify(a) === JSON.stringify(b)
-}
-
-/**
- * Common jsdoc2md options
- */
-class ParseOptions {
-  constructor (options) {
-    options = options || {}
-
-    this['group-by'] = null
-
-    this['sort-by'] = [ 'scope', 'category', 'kind', 'order' ]
-
-    Object.assign(this, options)
-  }
-}

lib/transform.js

@@ -2,6 +2,8 @@
 const o = require('object-tools')
 const a = require('array-tools')
 const testValue = require('test-value')
+const where = require('filter-where')
+const arrayify = require('array-back')
 
 /**
  * @module transform
@@ -41,8 +43,8 @@ function transform (data) {
     return doclet
   })
 
-  var exported = a.where(json, { isExported: true })
-  var newIDs = a.pluck(exported, 'id')
+  const exported = json.filter(where({ isExported: true }))
+  const newIDs = exported.map(d => d.id)
 
   newIDs.forEach(function (newID) {
     update(json, { isExported: undefined, '!kind': 'module' }, function (doclet) {
@@ -164,9 +166,7 @@ function insertConstructors (data) {
 
 /* unfortunately the jsdoc data structure differs between es5 and es6 classes, hence the need for these four functions */
 function getEs6Constructor (data, parent) {
-  return a.findWhere(data, i => {
-    return isES6Constructor(i) && i.memberof === parent.longname
-  })
+  return data.find(i => isES6Constructor(i) && i.memberof === parent.longname)
 }
 function isES5Class (doclet) {
   return testValue(doclet, {
@@ -266,7 +266,7 @@ function wantedProperties (input) {
 function buildTodoList (doclet) {
   var todoList = []
   if (doclet.todo) {
-    var todo = a.arrayify(doclet.todo)
+    var todo = arrayify(doclet.todo)
     todoList = todoList.concat(todo.map(function (task) {
       return { done: false, task: task }
     }))
@@ -386,7 +386,7 @@ function fixES6ConstructorMemberLongnames (data) {
     if (isES6Class(i)) {
       const es6constructor = getEs6Constructor(data, i)
       if (es6constructor) {
-        const constructorChildren = a.where(data, { memberof: es6constructor.longname })
+        const constructorChildren = data.filter(where({ memberof: es6constructor.longname }))
         constructorChildren.forEach(child => child.memberof = i.longname)
       }
     }
@@ -405,7 +405,7 @@ function convertIsEnumFlagToKind (doclet) {
 /* remove properties which have enum parents.. depends on convertIsEnumFlagToKind */
 function removeEnumChildren (json) {
   return json.filter(function (doclet) {
-    var parent = a.findWhere(json, { id: doclet.memberof })
+    var parent = json.find(where({ id: doclet.memberof }))
     if (parent && parent.kind === 'enum') {
       return false
     } else {

package.json

@@ -18,18 +18,17 @@
   },
   "scripts": {
     "test": "tape test/*.js",
-    "docs": "jsdoc2md -t jsdoc2md/README.md -p list --skip-heading lib/jsdoc-parse.js > README.md; echo",
+    "docs": "jsdoc2md2 -t jsdoc2md/README.md -p list --skip-heading lib/jsdoc-parse.js > README.md; echo",
     "es5": "babel --presets babel-preset-es2015 --no-comments lib --out-dir es5"
   },
   "dependencies": {
+    "array-back": "^1.0.2",
     "array-tools": "^2",
-    "common-sequence": "^1.0.2",
     "core-js": "^2.1.0",
     "feature-detect-es6": "^1.2.0",
+    "filter-where": "^1.0.1",
     "object-tools": "^2",
-    "sort-array": "^1.0.0",
-    "test-value": "^1.0.1",
-    "typical": "^2.4.2"
+    "test-value": "^1.0.1"
   },
   "devDependencies": {
     "babel-preset-es2015": "^6.5.0",