undocumented es6 classes no longer included in output.. fixes #19

Author: 75lb

README.md

@@ -225,7 +225,7 @@ var parse = require("jsdoc-parse")
             * [.stats](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+stats) : <code>boolean</code>
             * [.html](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+html) : <code>boolean</code>
             * [.conf](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+conf) : <code>boolean</code>
-            * [.sort-by](#module_jsdoc-parse--jsdocParse..ParseOptions+sort-by) : <code>array</code>
+            * [.sort-by](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+sort-by) : <code>array</code>
 
 <a name="exp_module_jsdoc-parse--jsdocParse"></a>
 ### jsdocParse([options]) ⇒ <code>[TransformStream](http://nodejs.org/api/stream.html#stream_class_stream_transform)</code> ⏏
@@ -251,7 +251,7 @@ All options for jsdoc-parse, including defaults
     * [.stats](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+stats) : <code>boolean</code>
     * [.html](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+html) : <code>boolean</code>
     * [.conf](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+conf) : <code>boolean</code>
-    * [.sort-by](#module_jsdoc-parse--jsdocParse..ParseOptions+sort-by) : <code>array</code>
+    * [.sort-by](#module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+sort-by) : <code>array</code>
 
 <a name="module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+src"></a>
 ##### parseOptions.src : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
@@ -292,11 +292,12 @@ Path to a jsdoc configuration file, passed directly to `jsdoc -c`.
 
 **Kind**: instance property of <code>[ParseOptions](#module_jsdoc-parse--jsdocParse..ParseOptions)</code>  
 **Default**: <code></code>  
-<a name="module_jsdoc-parse--jsdocParse..ParseOptions+sort-by"></a>
+<a name="module_jsdoc-parse--jsdocParse..ParseOptions.ParseOptions+sort-by"></a>
 ##### parseOptions.sort-by : <code>array</code>
 Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to remove the default sort order.
 
 **Kind**: instance property of <code>[ParseOptions](#module_jsdoc-parse--jsdocParse..ParseOptions)</code>  
+**Default**: <code>[&quot;scope&quot;,&quot;category&quot;,&quot;kind&quot;,&quot;order&quot;]</code>  
 
 * * *
 

es5/publish.js

@@ -4,12 +4,11 @@ var a = require('array-tools');
 var transform = require('./transform');
 
 exports.publish = function (data) {
-  var json = data().get().filter(function (i) {
-    if (i.kind === 'class') {
-      return true;
-    } else {
-      return !i.undocumented && !/package|file/.test(i.kind);
-    }
+  data = data().get();
+  data = transform.fixConstructorMemberLongnames(data);
+
+  var json = data.filter(function (i) {
+    return !i.undocumented && !/package|file/.test(i.kind);
   });
 
   json = json.map(transform.setIsExportedFlag);

es5/transform.js

@@ -7,6 +7,7 @@ var testValue = require('test-value');
 var data;
 exports.createConstructor = createConstructor;
 exports.insertConstructors = insertConstructors;
+exports.fixConstructorMemberLongnames = fixConstructorMemberLongnames;
 exports.setIsExportedFlag = setIsExportedFlag;
 exports.setCodename = setCodename;
 exports.setID = setID;
@@ -94,27 +95,10 @@ function createConstructor(class_) {
 
 function insertConstructors(data) {
   var replacements = [];
-  var toDelete = [];
 
   data.forEach(function (identifier, index) {
-    if (isES5Class(identifier)) {
+    if (identifier.kind === 'class') {
       replacements.push({ index: index, items: createConstructor(identifier) });
-    } else if (isES6Class(identifier)) {
-      var es6constructor = getEs6Constructor(data, identifier);
-      if (es6constructor) {
-        if (!(es6constructor.description || es6constructor.params && es6constructor.params.length)) {
-          toDelete.push(es6constructor);
-        }
-        es6constructor.kind = 'constructor';
-        es6constructor.memberof = identifier.longname;
-        var constructorChildren = a.where(data, { memberof: es6constructor.longname });
-        constructorChildren.forEach(function (i) {
-          i.memberof = identifier.longname;
-        });
-        identifier.description = identifier.classdesc;
-        delete identifier.classdesc;
-        delete identifier.params;
-      }
     }
   });
 
@@ -123,15 +107,13 @@ function insertConstructors(data) {
     data.splice.apply(data, spliceArgs);
   });
 
-  toDelete.forEach(function (d) {
-    data.splice(data.indexOf(d), 1);
-  });
-
   return data;
 }
 
-function getEs6Constructor(data, identifier) {
-  return a.findWhere(data, isES6Constructor);
+function getEs6Constructor(data, parent) {
+  return a.findWhere(data, function (i) {
+    return isES6Constructor(i) && i.memberof === parent.longname;
+  });
 }
 function isES5Class(identifier) {
   return testValue(identifier, {
@@ -178,10 +160,11 @@ function updateIDReferences(identifier, newID) {
 }
 
 function removeQuotes(identifier) {
-  if (identifier.name) identifier.name = identifier.name.replace(/"/g, '');
-  if (identifier.memberof) identifier.memberof = identifier.memberof.replace(/"/g, '');
-  if (identifier.longname) identifier.longname = identifier.longname.replace(/"/g, '');
-  if (identifier.id) identifier.id = identifier.id.replace(/"/g, '');
+  var re = /["']/g;
+  if (identifier.name) identifier.name = identifier.name.replace(re, '');
+  if (identifier.memberof) identifier.memberof = identifier.memberof.replace(re, '');
+  if (identifier.longname) identifier.longname = identifier.longname.replace(re, '');
+  if (identifier.id) identifier.id = identifier.id.replace(re, '');
   return identifier;
 }
 
@@ -329,4 +312,19 @@ function removeMemberofFromModule(identifier) {
     delete identifier.scope;
   }
   return identifier;
+}
+
+function fixConstructorMemberLongnames(data) {
+  data.forEach(function (i) {
+    if (isES6Class(i)) {
+      var es6constructor = getEs6Constructor(data, i);
+      if (es6constructor) {
+        var constructorChildren = a.where(data, { memberof: es6constructor.longname });
+        constructorChildren.forEach(function (child) {
+          child.memberof = i.longname;
+        });
+      }
+    }
+  });
+  return data;
 }

lib/jsdoc-parse.js

@@ -75,7 +75,6 @@ class ParseOptions {
 
     /**
      * Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to remove the default sort order.
-     * @member module:jsdoc-parse~ParseOptions#sort-by
      * @type {array}
      * @default
      */

lib/publish.js

@@ -8,12 +8,11 @@ This is a jsdoc plugin. It transforms jsdoc format data to the preferred jsdoc-p
 @param {object} opts - An object with options information.
 */
 exports.publish = function (data) {
-  let json = data().get().filter(i => {
-    if (i.kind === 'class') {
-      return true
-    } else {
-      return !i.undocumented && !/package|file/.test(i.kind)
-    }
+  data = data().get()
+  data = transform.fixConstructorMemberLongnames(data)
+
+  let json = data.filter(i => {
+    return !i.undocumented && !/package|file/.test(i.kind)
   })
 
   json = json.map(transform.setIsExportedFlag)

lib/transform.js

@@ -6,6 +6,7 @@ const testValue = require('test-value')
 var data
 exports.createConstructor = createConstructor
 exports.insertConstructors = insertConstructors
+exports.fixConstructorMemberLongnames = fixConstructorMemberLongnames
 exports.setIsExportedFlag = setIsExportedFlag
 exports.setCodename = setCodename
 exports.setID = setID
@@ -107,27 +108,10 @@ function createConstructor (class_) {
 /* split each class found into two new items, then re-insert them over the original class */
 function insertConstructors (data) {
   var replacements = []
-  var toDelete = []
 
   data.forEach(function (identifier, index) {
-    if (isES5Class(identifier)) {
+    if (identifier.kind === 'class') {
       replacements.push({ index: index, items: createConstructor(identifier) })
-    } else if (isES6Class(identifier)) {
-      const es6constructor = getEs6Constructor(data, identifier)
-      if (es6constructor) {
-        if (!(es6constructor.description || (es6constructor.params && es6constructor.params.length))) {
-          toDelete.push(es6constructor)
-        }
-        es6constructor.kind = 'constructor'
-        es6constructor.memberof = identifier.longname
-        const constructorChildren = a.where(data, { memberof: es6constructor.longname })
-        constructorChildren.forEach(i => {
-          i.memberof = identifier.longname
-        })
-        identifier.description = identifier.classdesc
-        delete identifier.classdesc
-        delete identifier.params
-      }
     }
   })
 
@@ -136,16 +120,14 @@ function insertConstructors (data) {
     data.splice.apply(data, spliceArgs)
   })
 
-  toDelete.forEach(d => {
-    data.splice(data.indexOf(d), 1)
-  })
-
   return data
 }
 
 /* unfortunately the jsdoc data structure differs between es5 and es6 classes, hence the need for these four functions */
-function getEs6Constructor (data, identifier) {
-  return a.findWhere(data, isES6Constructor)
+function getEs6Constructor (data, parent) {
+  return a.findWhere(data, i => {
+    return isES6Constructor(i) && i.memberof === parent.longname
+  })
 }
 function isES5Class (identifier) {
   return testValue(identifier, {
@@ -353,3 +335,18 @@ function removeMemberofFromModule (identifier) {
   }
   return identifier
 }
+
+function fixConstructorMemberLongnames (data) {
+  data.forEach(i => {
+    if (isES6Class(i)) {
+      const es6constructor = getEs6Constructor(data, i)
+      if (es6constructor) {
+        const constructorChildren = a.where(data, { memberof: es6constructor.longname })
+        constructorChildren.forEach(child => {
+          child.memberof = i.longname
+        })
+      }
+    }
+  })
+  return data
+}