Merge branch 'jsdoc-api'

Author: 75lb

.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 node_js:
-- 'node'
-- '4.2'
+- '5'
+- '4'
 - '0.12'
 - '0.10'
 - 'iojs'

bin/cli.js

@@ -17,25 +17,17 @@ try {
 }
 
 if (options.help) {
-  console.log(usage)
+  console.error(usage)
   process.exit(0)
 }
 
-var parseStream
-if (options.src && options.src.length) {
-  parseStream = parse(options)
-  parseStream
-    .on('error', function (err) {
-      stop(err.stack, 1)
-    })
-    .pipe(process.stdout)
-} else {
-  parseStream = parse(options)
-  parseStream.on('error', function (err) {
+var parseStream = parse(options)
+  .on('error', function (err) {
     stop(err.stack, 1)
   })
-  process.stdin.pipe(parseStream).pipe(process.stdout)
-}
+parseStream.pipe(process.stdout)
+
+if (!options.src) process.stdin.pipe(parseStream)
 
 function stop (msg, code) {
   console.error(ansi.format(msg, 'red'))

es5/jsdoc-parse.js

@@ -1,163 +1,63 @@
 'use strict';
 
+var _createClass = (function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; })();
+
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-var cp = require('child_process');
+function _typeof(obj) { return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj; }
+
 var path = require('path');
-var util = require('util');
 var a = require('array-tools');
-var o = require('object-tools');
-var fs = require('fs');
 var fileSet = require('file-set');
 var Transform = require('stream').Transform;
 var cliOptions = require('./cli-options');
-var getTempPath = require('temp-path');
-var walkBack = require('walk-back');
-
-function tempPath() {
-  return getTempPath() + 'jsdoc-parse.js';
-}
+var jsdoc = require('jsdoc-api');
+var transform = require('./transform');
+var collectJson = require('collect-json');
+var assert = require('assert');
+var connect = require('stream-connect');
 
 module.exports = jsdocParse;
 jsdocParse.cliOptions = cliOptions.definitions;
 
-var ParseOptions = function ParseOptions() {
-  _classCallCheck(this, ParseOptions);
-
-  this.src = null;
-
-  this.private = false;
-
-  this.stats;
-
-  this.html = false;
-
-  this.conf = null;
-
-  this['sort-by'] = ['scope', 'category', 'kind', 'order'];
-};
-
 function jsdocParse(options) {
-  options = o.extend(new ParseOptions(), options);
-  var src = options.src;
-
-  if (src) {
-    var inputFiles = fileSet(src);
-    src = inputFiles.files;
-
-    var output = new OutputTransform(options);
-
-    if (!src.length) {
-      var msg = util.format('[jsdoc-parse] please specify valid input files. ');
-      if (inputFiles.notExisting) {
-        msg += 'These files do not exist: ' + inputFiles.notExisting.join(', ');
-      }
-
+  options = new ParseOptions(options);
+  try {
+    options.validate();
+  } catch (err) {
+    var _ret = (function () {
+      var output = new Transform();
       process.nextTick(function () {
-        output.emit('error', new Error(msg));
-      });
-    } else {
-      getJsdocOutput(src, options, function (err, data) {
-        if (err) {
-          output.emit('error', err);
-        } else {
-          output.end(data);
-        }
-      });
-    }
-    return output;
-  } else {
-    var inputStream = new Transform();
-    var inputFilePath = tempPath();
-
-    var buf = new Buffer(0);
-    inputStream._transform = function (chunk, enc, done) {
-      if (chunk) buf = Buffer.concat([buf, chunk]);
-      done();
-    };
-    inputStream._flush = function (done) {
-      var self = this;
-      fs.writeFileSync(inputFilePath, buf);
-      getJsdocOutput([inputFilePath], options, function (err, data) {
-        if (err) {
-          done(err);
-        } else {
-          try {
-            data = applyOptions(data, options);
-            self.push(data);
-            self.push(null);
-            done();
-          } catch (err) {
-            done(err);
-          }
-        }
-        fs.unlinkSync(inputFilePath);
+        output.emit('error', err);
       });
-    };
-    return inputStream;
+      return {
+        v: output
+      };
+    })();
+
+    if ((typeof _ret === 'undefined' ? 'undefined' : _typeof(_ret)) === "object") return _ret.v;
   }
-}
 
-function OutputTransform(options) {
-  Transform.call(this);
-  this.json = new Buffer(0);
-  this._transform = function (chunk, enc, done) {
-    if (chunk) this.json = Buffer.concat([this.json, chunk]);
-    done();
-  };
-  this._flush = function () {
-    try {
-      this.json = applyOptions(this.json, options);
-    } catch (err) {
-      err.message += ' [Problem parsing the JSON data output by jsdoc, input data: ' + this.json.toString().substr(0, 100) + ']';
-      return this.emit('error', err);
-    }
-    this.push(this.json);
-    this.push(null);
-  };
-}
-util.inherits(OutputTransform, Transform);
+  var jsdocOptions = {};
+  if (options.html) jsdocOptions.configure = path.resolve(__dirname, 'html-conf.json');
+  jsdocOptions.files = options.files;
 
-function getJsdocOutput(src, options, done) {
-  var jsdocTemplatePath = __dirname;
-  var jsdocPath = walkBack(path.join(__dirname, '..'), path.join('node_modules', 'jsdoc-75lb', 'jsdoc.js'));
+  var explainStream = jsdoc.createExplainStream(jsdocOptions).once('error', emitError);
 
-  if (!fs.existsSync(jsdocPath)) {
-    throw Error('jsdoc-parse: cannot find jsdoc: ' + jsdocPath);
-  }
-  var args = [jsdocPath, '--pedantic', '-t', jsdocTemplatePath];
-  if (options.html) {
-    args = args.concat(['-c', path.resolve(__dirname, 'default-conf.json')]);
-  } else if (options.conf) {
-    args = args.concat(['-c', path.resolve(options.conf)]);
+  var transformedStream = transform().once('error', emitError);
+
+  var outputStream = collectJson(function (data) {
+    return applyOptions(data, options);
+  }).once('error', emitError);
+
+  function emitError(err) {
+    outputStream.emit('error', err);
   }
-  args = args.concat(src);
-
-  var outputFilePath = tempPath();
-  var outputFile = fs.openSync(outputFilePath, 'w');
-  var outputStderrPath = tempPath();
-  var outputStderr = fs.openSync(outputStderrPath, 'w');
-  var handle = cp.spawn('node', args, { stdio: [process.stdin, outputFile, outputStderr] });
-  handle.on('error', done);
-  handle.on('close', function (code) {
-    var stderr = fs.readFileSync(outputStderrPath, 'utf8');
-    var stdout = fs.readFileSync(outputFilePath, 'utf8');
-    if (/no input files/.test(stdout)) code = 1;
-
-    if (code) {
-      fs.unlinkSync(outputFilePath);
-      fs.unlinkSync(outputStderrPath);
-      done(new Error(stderr || stdout));
-    } else {
-      fs.unlinkSync(outputFilePath);
-      fs.unlinkSync(outputStderrPath);
-      done(null, stdout);
-    }
-  });
+
+  return connect(explainStream, connect(transformedStream, outputStream));
 }
 
 function applyOptions(data, options) {
-  data = JSON.parse(data.toString());
   if (options.stats) {
     return JSON.stringify(getStats(data), null, '  ') + '\n';
   } else {
@@ -198,4 +98,40 @@ function sort(array, sortBy) {
   } else {
     return a.sortBy(array, sortBy, order);
   }
-}
+}
+
+var ParseOptions = (function () {
+  function ParseOptions(options) {
+    _classCallCheck(this, ParseOptions);
+
+    this.src = null;
+
+    this.private = false;
+
+    this.stats;
+
+    this.html = false;
+
+    this.conf = null;
+
+    this['sort-by'] = ['scope', 'category', 'kind', 'order'];
+
+    Object.assign(this, options);
+    if (this.src) {
+      this.fileSet = fileSet(this.src);
+      this.files = this.fileSet.files;
+    }
+  }
+
+  _createClass(ParseOptions, [{
+    key: 'validate',
+    value: function validate() {
+      if (this.src) {
+        assert.ok(this.fileSet.files.length, 'Please specify valid input files.');
+        assert.ok(!(this.fileSet.notExisting && this.fileSet.notExisting.length), 'These files do not exist: ' + this.fileSet.notExisting.join(', '));
+      }
+    }
+  }]);
+
+  return ParseOptions;
+})();

es5/transform.js

@@ -3,36 +3,66 @@
 var o = require('object-tools');
 var a = require('array-tools');
 var testValue = require('test-value');
+var collectJson = require('collect-json');
 
-var data;
-exports.createConstructor = createConstructor;
-exports.insertConstructors = insertConstructors;
-exports.fixConstructorMemberLongnames = fixConstructorMemberLongnames;
-exports.setIsExportedFlag = setIsExportedFlag;
-exports.setCodename = setCodename;
-exports.setID = setID;
-exports.updateIDReferences = updateIDReferences;
-
-exports.setData = function (d) {
-  data = d;return this;
-};
-exports.getData = function () {
-  return data;
-};
-exports.removeQuotes = removeQuotes;
-exports.wantedProperties = wantedProperties;
-exports.removeUnwanted = removeUnwanted;
-exports.cleanProperties = cleanProperties;
-exports.buildTodoList = buildTodoList;
-exports.extractTypicalName = extractTypicalName;
-exports.extractCategory = extractCategory;
-exports.extractChainable = extractChainable;
-exports.extractCustomTags = extractCustomTags;
-exports.setTypedefScope = setTypedefScope;
-exports.sortIdentifier = sortIdentifier;
-exports.renameThisProperty = renameThisProperty;
-exports.removeMemberofFromModule = removeMemberofFromModule;
-exports.update = update;
+module.exports = transform;
+
+function transform() {
+  return collectJson(function (data) {
+    data = fixConstructorMemberLongnames(data);
+
+    var json = data.filter(function (i) {
+      return !i.undocumented && !/package|file/.test(i.kind);
+    });
+
+    json = json.map(setIsExportedFlag);
+    json = json.map(setCodename);
+    json = insertConstructors(json);
+
+    json = json.map(function (identifier) {
+      identifier = setID(identifier);
+
+      identifier = removeQuotes(identifier);
+      identifier = cleanProperties(identifier);
+      identifier = buildTodoList(identifier);
+      identifier = extractTypicalName(identifier);
+      identifier = extractCategory(identifier);
+      identifier = extractChainable(identifier);
+      identifier = extractCustomTags(identifier);
+      identifier = setTypedefScope(identifier);
+      identifier = renameThisProperty(identifier);
+      identifier = removeMemberofFromModule(identifier);
+      return identifier;
+    });
+
+    var exported = a.where(json, { isExported: true });
+    var newIDs = a.pluck(exported, 'id');
+
+    newIDs.forEach(function (newID) {
+      update(json, { isExported: undefined, '!kind': 'module' }, function (identifier) {
+        return updateIDReferences(identifier, newID);
+      });
+    });
+
+    json = json.filter(function (identifier) {
+      var parent = a.findWhere(json, { id: identifier.memberof });
+      if (parent && parent.isEnum) {
+        return false;
+      } else {
+        return true;
+      }
+    });
+
+    json = json.map(removeUnwanted);
+    json = json.map(sortIdentifier);
+
+    json.forEach(function (identifier, index) {
+      identifier.order = index;
+    });
+
+    return JSON.stringify(json, null, '  ');
+  });
+}
 
 function setID(identifier) {
   if (identifier.longname) {

index.js

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