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

Fix parsing of standalong jsdoc tags #764

Merged
merged 1 commit into from
May 13, 2024
Merged

Conversation

bitgopatmcl
Copy link
Contributor

@bitgopatmcl bitgopatmcl commented May 13, 2024

There is a bug with the jsdoc comment parsing when the comment contains a tag with no summary or description:

/**
 * @tag
 */

Without this change, the @tag gets ignored.

@bitgopatmcl bitgopatmcl marked this pull request as ready for review May 13, 2024 14:16
@bitgopatmcl bitgopatmcl requested a review from a team as a code owner May 13, 2024 14:16
@louib-bitgo louib-bitgo merged commit 1edac54 into master May 13, 2024
9 checks passed
@louib-bitgo louib-bitgo deleted the fix-standalone-tags branch May 13, 2024 14:41
Copy link

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

tags['example'] = JSON.parse(tags['example']);
} catch (e) {
writingExample = true;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought: This ad-hoc parsing is starting to get extremely hairy! Thank goodness for our test suite.

I wonder if an approach using something structured, like parser combinators, might offer any benefits?

Copy link

github-actions bot commented Jun 4, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Jun 4, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Jun 4, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Aug 5, 2024

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants