improved error reporting

on jsdoc fail, jsdoc-parse now builds an error using the jsdoc stderr output

Author: 75lb

bin/cli.js

@@ -3,6 +3,7 @@
 var parse = require('../')
 var commandLineArgs = require('command-line-args')
 var cliOptions = require('../lib/cli-options')
+var ansi = require('ansi-escape-sequences')
 
 var cli = commandLineArgs(parse.cliOptions.concat([
   { name: 'help', alias: 'h', type: Boolean, description: 'Display this usage.' }
@@ -12,9 +13,7 @@ try {
   var usage = cli.getUsage(cliOptions.usage)
   var options = cli.parse()
 } catch (err) {
-  console.log(err.message)
-  console.log(usage)
-  process.exit(1)
+  stop(err.message, 1)
 }
 
 if (options.help) {
@@ -25,10 +24,20 @@ if (options.help) {
 if (options.src && options.src.length) {
   var parseStream = parse(options)
   parseStream
-    .on('error', console.error)
+    .on('error', function (err) {
+      stop(err.message, 1)
+    })
     .pipe(process.stdout)
 } else {
   var parseStream = parse(options)
-  parseStream.on('error', console.error)
+  parseStream.on('error', function (err) {
+    stop(err.message, 1)
+  })
   process.stdin.pipe(parseStream).pipe(process.stdout)
 }
+
+function stop (msg, code) {
+  console.error(ansi.format(msg, 'red'))
+  console.error(usage)
+  process.exit(code)
+}

lib/jsdoc-parse.js

@@ -1,14 +1,15 @@
 'use strict'
-var cp = require('child_process')
-var path = require('path')
-var util = require('util')
-var a = require('array-tools')
-var o = require('object-tools')
-var fs = require('fs')
-var mfs = require('more-fs')
-var fileSet = require('file-set')
-var Transform = require('stream').Transform
-var cliOptions = require('./cli-options')
+const cp = require('child_process')
+const path = require('path')
+const util = require('util')
+const a = require('array-tools')
+const o = require('object-tools')
+const fs = require('fs')
+const mfs = require('more-fs')
+const fileSet = require('file-set')
+const Transform = require('stream').Transform
+const cliOptions = require('./cli-options')
+const os = require('os')
 
 /**
 Exports a single function to parse jsdoc data.
@@ -186,15 +187,24 @@ function getJsdocOutput (src, options, done) {
   }
   args = args.concat(src)
 
-  var outputFilePath = mfs.getTempFilePath() + '.json'
+  var outputFilePath = os.tmpdir() + '/jsdoc-stdout.json'
   var outputFile = fs.openSync(outputFilePath, 'w')
-  var handle = cp.spawn('node', args, { stdio: [ process.stdin, outputFile, process.stderr ]})
+  var outputStderrPath = os.tmpdir() + '/jsdoc-stderr.json'
+  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 () {
-    fs.readFile(outputFilePath, function (err, data) {
-      done(err, data)
+  handle.on('close', function (code) {
+    if (code) {
+      const output = fs.readFileSync(outputStderrPath, 'utf8')
       fs.unlinkSync(outputFilePath)
-    })
+      fs.unlinkSync(outputStderrPath)
+      done(new Error(output))
+    } else {
+      const output = fs.readFileSync(outputFilePath, 'utf8')
+      fs.unlinkSync(outputFilePath)
+      fs.unlinkSync(outputStderrPath)
+      done(null, output)
+    }
   })
 }
 

package.json

@@ -24,6 +24,7 @@
     "docs": "jsdoc2md -t jsdoc2md/README.hbs -p list lib/jsdoc-parse.js > README.md; echo"
   },
   "dependencies": {
+    "ansi-escape-sequences": "^2.2.1",
     "array-tools": "^2",
     "command-line-args": "^2.1.1",
     "file-set": "~0.2.1",