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

support for including original comments in d.ts file? #56

Closed
johnnotron opened this issue Dec 19, 2018 · 3 comments
Closed

support for including original comments in d.ts file? #56

johnnotron opened this issue Dec 19, 2018 · 3 comments

Comments

@johnnotron
Copy link

I'm not seeing original jsdoc comments included generated d.ts files, would this be hard to implement?

Thanks
Rich

@englercj
Copy link
Owner

From the v2 changelog:

JSDoc comments are not currently included in the output (public TS compiler API needed)

I haven't seen how I can make the TS compiler output comments yet. If you know which compiler APIs to use, please let me know. The API is fairly new and completely undocumented, so I haven't found everything yet.

@johnnotron
Copy link
Author

Thanks. I haven't gone looking too deep but tested this project which does manage to include the comments, but the defs generated are not as good.

Appears to use dts-dom to create the definitions instead of typescript package, don't know if that would be of use?

@englercj
Copy link
Owner

v1 of this project used dts-dom. v2 uses the typescript compiler directly.

I need to find an API in the typescript compiler that allows me to build comment nodes in the AST.

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