NodeJS Support

[jannon]

Add support for JSDoc 3 to run on nodejs

[rafalwrzeszcz]

Something changed from since #41 ?

[jannon]

Heh, I guess I didn't make it that far down the closed issues list :) I guess I'm saying that I'm willing to create the javascript parser necessary for this.

[sindresorhus]

@rafalwrzeszcz Something has changed, we now have Esprima which preserves comments.

[hegemonic]

@sindresorhus We also need a new version of Esprima that can attach comments to code, rather than just sticking them in an array.

[sindresorhus]

@ariya What is the timeframe on the issue linked to above?

[ariya]

No timeline is given for that, unfortunately.

[hegemonic]

While we wait for Esprima, I've started to chip away at some of the other Node.js compatibility issues. See this pull request for an example.

I'm going to keep working on this occasionally. Hopefully others can pitch in as well!

[lazd]

I assume this also means we'll be able to npm install jsdoc3 -- can't wait!

[gjtorikian]

Regardless of commenting attaching, JSDuck (a Ruby project) currently uses Esprima. I'm going to try to poke around and see how to get it to work.

[gjtorikian]

As I said above, JSDuck uses Esprima, and still manages to associate comments with code segments. However, JSDuck is written in Ruby.

I went ahead and converted the Ruby code into Node.js for an API documentation project I am working on. This should render the question of porting JSDoc to Node moot, as it can be done. The methodology for listing and detecting and consuming tags can be found here: https://github.com/gjtorikian/panino-docs/blob/master/lib/panino/plugins/parsers/javascript/jsd/doc_parser.js#L90

A longer conversation of how this went about can be found on the JSDuck comment page requesting a port: senchalabs/jsduck#36 (comment)

I hope this helps someone!

[hegemonic]

@gjtorikian Thanks for the heads up, and nice work!

Unfortunately, because JSDuck and Panino are both GPLed, we can't use either project's code directly. But it's good to know this can be done...

[gjtorikian]

@hegemonic Actually, with the last update, I swapped it over to MIT: https://github.com/gjtorikian/panino-docs/blob/master/LICENSE

I just forgot to change the README.

It's my code, do whatever you want with it ;p