search

futurGH / ts-to-jsdoc

Transpile TypeScript code to fully compatible JavaScript + JSDoc comments.
MIT License
181 stars 17 forks source link

add namespace generation #49

Closed smacpherson64 closed 3 months ago

smacpherson64 commented 3 months ago

Aims to add namespace jsdoc generation to ts-to-jsdoc

Resolves https://github.com/futurGH/ts-to-jsdoc/issues/48

futurGH commented 3 months ago

On a quick initial look, this largely looks good — my only note would be that since a namespace can exist at the value level if it exports any variables or functions, it'd make sense for generateNamespaceDocumentation to prepend the JSDoc to the transpiled namespace if one exists.

smacpherson64 commented 3 months ago

Understood, great point will think through how to approach.

smacpherson64 commented 3 months ago

Hey @futurGH,

I updated the functionality, and tests, to handle value and type only namespaces. I am not sure how to fix the spacing issue with the JSDoc on the value version yet. I will try to investigate more when I am able.

futurGH commented 3 months ago

Sorry for the wait! Hoping to get around to reviewing this soon.

smacpherson64 commented 3 months ago

Hey @futurGH, No worries. Please do not feel pressure on my account. Your time is important. Thanks for the update!

futurGH commented 3 months ago

Everything looks great, thanks for the contribution!

smacpherson64 commented 3 months ago

Thanks for being open to the idea and for the feedback!