Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve error handling #132

Closed
doug-wade opened this issue Oct 20, 2015 · 2 comments
Closed

Improve error handling #132

doug-wade opened this issue Oct 20, 2015 · 2 comments

Comments

@doug-wade
Copy link

I'm trying to use gulp-esdoc to generate my docs, but I've been having some difficulty. While trying to debug it, I've been getting some rather cryptic errors from ESDoc.generate() -- an AssertionError that undefined == true -- which don't help me much. What I'd like to see is "source is not defined. Please provide a source in your config" or something.

Here's the actual stack trace:

» gulp docs
[21:52:46] Using gulpfile ~/workplace/yodel/gulpfile.js
[21:52:46] Starting 'docs'...
[21:52:46] Finished 'docs' after 6.57 ms

assert.js:89
  throw new assert.AssertionError({
  ^
AssertionError: undefined == true
  at Function.generate (/home/doug/workplace/yodel/node_modules/gulp-esdoc/node_modules/esdoc/out/src/ESDoc.js:92:31)
  at DestroyableTransform.flush [as _flush] (/home/doug/workplace/yodel/node_modules/gulp-esdoc/index.js:31:11)
  at DestroyableTransform.<anonymous> (/home/doug/workplace/yodel/node_modules/gulp-esdoc/node_modules/through2/node_modules/readable-stream/lib/_stream_transform.js:123:12)
  at DestroyableTransform.g (events.js:260:16)
  at emitNone (events.js:67:13)
  at DestroyableTransform.emit (events.js:166:7)
  at prefinish (/home/doug/workplace/yodel/node_modules/gulp-esdoc/node_modules/through2/node_modules/readable-stream/lib/_stream_writable.js:492:12)
  at finishMaybe (/home/doug/workplace/yodel/node_modules/gulp-esdoc/node_modules/through2/node_modules/readable-stream/lib/_stream_writable.js:500:7)
  at endWritable (/home/doug/workplace/yodel/node_modules/gulp-esdoc/node_modules/through2/node_modules/readable-stream/lib/_stream_writable.js:512:3)
  at DestroyableTransform.Writable.end (/home/doug/workplace/yodel/node_modules/gulp-esdoc/node_modules/through2/node_modules/readable-stream/lib/_stream_writable.js:477:5)
  at DestroyableTransform.onend (/home/doug/workplace/yodel/node_modules/gulp/node_modules/vinyl-fs/node_modules/through2/node_modules/readable-stream/lib/_stream_readable.js:523:10)
  at DestroyableTransform.g (events.js:260:16)
  at emitNone (events.js:72:20)
  at DestroyableTransform.emit (events.js:166:7)
  at /home/doug/workplace/yodel/node_modules/gulp/node_modules/vinyl-fs/node_modules/through2/node_modules/readable-stream/lib/_stream_readable.js:965:16
  at doNTCallback0 (node.js:407:9)
  at process._tickCallback (node.js:336:13)
@h13i32maru
Copy link
Member

@prekolna Thanks for this suggestion. I consider this.

@h13i32maru
Copy link
Member

Please check the latest ESDoc. If is problem, please write new issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants