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.

Sign up for GitHub

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

Jump to bottom

feat(test runner): collect and run doctests in jsdoc/typedoc @example directive #12370

Open
jbergstroem opened this issue Jul 5, 2024 · 0 comments
Open

feat(test runner): collect and run doctests in jsdoc/typedoc @example directive #12370

jbergstroem opened this issue Jul 5, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@jbergstroem
Copy link
Contributor

What is the problem this feature would solve?

Having bun test collect tests inside of typedoc or jsdoc @example directives would be very convenient.

What is the feature you are proposing to solve the problem?

Extract all @example directives as part of test collection and run them against the functions.

What alternatives have you considered?

Using a third party library like doctest.js from supabase
@jbergstroem jbergstroem added the enhancement New feature or request label Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jbergstroem