feat(neotest): Expose doctests on Neotest summary window #247
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current neotest integration reports any 'test' runnable as a valid position, except for 'doctests'. This commit introduces logic necessary to also expose 'doctests' as part of the summary, so it can be visualized and trigger. It tries to approach it with the minimal changes, so exported labels follows the same name convention as test runnables, without indication they are doctests on the summary window. This can be changed if necessary. In order for neotest to consider these items part of the tree, we must also return a 'pos' with `pos.type = 'file'`, otherwhise those test items would not have a parent, and it prevents being displayed. This is done by reporting a 'file' always, but I'm not sure what is the reason behind returning only if `#namespaces > 0`.
bltavares
force-pushed
the
feat-doc-test-export-summary
branch
from
937a1d9 to
1c6b0a5
Compare
mrcjkb
previously approved these changes
Feb 20, 2024
Owner
mrcjkb
left a comment
mrcjkb
left a comment
There was a problem hiding this comment.
This is great! Thanks once again 😄
The if #namespaces > 0 check should have actually been if #namespaces <= 1, in case there are multiple test modules in a file (which would be ambiguous).
But I'll say YAGNI for now - nobody has run complained about it so far.
mrcjkb
reviewed
Feb 20, 2024
This was referenced Nov 10, 2024
This was referenced Nov 3, 2025
This was referenced Nov 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current neotest integration reports any 'test' runnable as a valid position, except for 'doctests'.
This commit introduces logic necessary to also expose 'doctests' as part of the summary, so it can be visualized and trigger.
It tries to approach it with the minimal changes, so exported labels follows the same name convention as test runnables, without indication they are doctests on the summary window. This can be changed if necessary.
In order for neotest to consider these items part of the tree, we must also return a 'pos' with
pos.type = 'file', otherwhise those test items would not have a parent, and it prevents being displayed. This is done by reporting a 'file' always, but I'm not sure what is the reason behind returning only if#namespaces > 0.Review Checklist
If applicable: