-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add support for a title, docstrings-tags and expose private methods #10
Open
pietervdvn
wants to merge
14
commits into
danr:master
Choose a base branch
from
pietervdvn:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
…rivate methods in doctests to make them testable
pietervdvn
commented
Mar 17, 2022
@@ -30,7 +31,6 @@ export interface Comment { | |||
|
|||
export function Comments(s: string): Comment[] { | |||
const out: Comment[] = [] | |||
function add_comment(c: string, context: string | null) {} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seemed like this function is not used, so I removed
pietervdvn
commented
Mar 17, 2022
src/internal.ts
Outdated
docstring.split(/\n\n+/m).forEach(s => { | ||
if (is_doctest(s)) { | ||
out.push(extractScript(s)) | ||
const script = extractScript(s) | ||
let name = undefined |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
detect a name, if any
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hi Danr,
I'm quite fond of doctesting, but found a few missing features that would improve my life. So, I gave it a go to improve doctest-ts.
The first issue is that, when testing a private method, the generated doctest would not compile as this private method is not visible in the describe block (at least not in mocha/jest). The function
exposePrivates
will rewrite a piece of code and replace everyprivate
-keyword with apublic
-keyword and convert this into a script, which is then used in the.doctest.ts
-testfile.A second issue was that, as soon as a tag is used in a docstring, doctest-ts would ignore tests:
The test here would be ignored. This is fixed by also checking
node.jsDocs.tags
in theComments
-function (L56 - L61)At last, a small quality-of-life improvement: when the first line of a valid docstring is a comment, this is treated as the name of the test, e.g.
will result in
I've also taken the freedom to update the version number and would be very happy with a quick deploy on NPM. However, if you are unwilling to maintain this library, I will deploy a new version myself.
Kind regards,
Pieter