search

ember-learn / ember-cli-addon-docs

Easy, beautiful docs for your OSS Ember addons
https://ember-learn.github.io/ember-cli-addon-docs
MIT License
176 stars 143 forks source link

Provide support for a compatible TypeScript doc generator #246

Open alexdiliberto opened 6 years ago

alexdiliberto commented 6 years ago

Feature Request

Currently supported doc generators include YUIDoc and ESDoc

A future TypeScript doc generator option could include either TSDoc or TypeDoc

buschtoens commented 6 years ago

Thanks for opening this issue. On the long run investing effort into tsdoc is probably more valuable.

ef4 commented 5 years ago

I just converted a huge chunk of ember-animated to TypeScript only to discover this issue. 😭

RobbieTheWagner commented 5 years ago

Has anyone tried to support TypeScript here?

ef4 commented 5 years ago

Apparently the YUIDoc parser is sloppy enough to not care about the difference between JS and TS. This seems to be working fine:

https://github.com/ember-learn/ember-cli-addon-docs-yuidoc/compare/master...ef4:ts

pzuraq commented 5 years ago

The one good thing about a comment only parser 😄 it works in any language. We can also customize it to make it less terrible (as I have done) though probably should just rewrite it at some point.

RobbieTheWagner commented 5 years ago

@ef4 @pzuraq what do you guys suggest for TS? Should we recommend YUIDoc or should we try to implement something with TSDoc?

ef4 commented 5 years ago

I agree with the comments above that tsdoc looks like a good bet. I started trying to integrate it just now, but decided I don't have time to do it, especially since the YUIDoc solution was so small.