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

Extra TS syntax support #50

Closed

Conversation

Daniel-Knights
Copy link
Contributor

@Daniel-Knights Daniel-Knights commented Aug 23, 2024

This PR adds support for:

  • Semi-colon separators in object types
  • Inline TS function types
  • Bracket notation
  • @default and @member tags

Other changes:

  • Reformat README, so that in/out examples are in the same sections
  • Add inherit option for stdout in the JSDoc spawn call for easier debugging when running tests
  • Basic Prettier config

Additional notes

The semi-colon and trailing comma replacements seem a bit risky, but the only instance I can think of where this could be an issue is in exact string types, e.g. @type {"a;b"} would become @type {"a,b"}. It's an edge case, but probably good enough reason not to include it. Added it anyway in case you see otherwise.

.prettierrc Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
@ahocevar
Copy link
Member

Thanks for the updated regular expression, which looks good now.

I apologize for having merged the other pull requests first, which causes nasty conflicts in this one. Would you be able to squash the commits and resolve the conflicts? Thanks a lot for your effort!

@ahocevar ahocevar mentioned this pull request Sep 14, 2024
@ahocevar
Copy link
Member

@Daniel-Knights I created #63 with your changes from here, but with the conflicts resolved. Thanks for your effort!

@ahocevar ahocevar closed this in #63 Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants