Numerous changes - Githubissues

jackcannon commented 1 year ago

This pull request makes 4 changes:

Fix bug when running in bun (see https://github.com/oven-sh/bun/issues/4217)
Add support for function expressions, including arrow functions
Add support for 'optional' params, wrapping the param name with square brackets where applicable, as per the docs
Remove obsolete params from JSDoc (i.e. params that may no longer exist for the function)

Please let me know if you would prefer seperate PRs (if there's reasonable likelihood they'll be merged)

This fork (with these changes) can be used with the @jackcannon/ts-to-jsdoc public npm module

kungfooman commented 1 year ago

Nice work, I wish we had some Playground to quickly test PR's like this one...

futurGH commented 1 year ago

These look great, thanks a lot! It might be a few days before I can get to taking a closer look and merging, but everything does check out at first glance. (PS: that Bun/Node difference is really interesting, thanks for taking notice of that!)

futurGH commented 1 year ago

Looks good to merge, I would just appreciate if you could split up your changes into individual PRs — just to keep things neat!

jackcannon commented 1 year ago

Great! Will close this and open some smaller PRs

futurGH / ts-to-jsdoc

Numerous changes #22