-
Notifications
You must be signed in to change notification settings - Fork 3
chore: Rewrite test utils doc generator #77
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
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #77 +/- ##
==========================================
+ Coverage 91.67% 91.96% +0.29%
==========================================
Files 16 15 -1
Lines 913 909 -4
Branches 273 265 -8
==========================================
- Hits 837 836 -1
+ Misses 76 73 -3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
e6a402c
to
1f3b8c2
Compare
b4ad997
to
bcdcc14
Compare
bcdcc14
to
534398c
Compare
@@ -0,0 +1,3 @@ | |||
ignore: | |||
# deprecated code | |||
- 'src/test-utils/**' |
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.
The old code is still there for compatibility, but the tests already use the new implementation.
Ignoring the old code from the coverage, because it will be removed soon anyway
expect(results.length).toBe(2); | ||
expect(results.length).toBe(1); |
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.
Private wrappers (like this one) are not documented anymore
}); | ||
}); | ||
|
||
test('glob works', () => { |
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.
Not needed anymore, because the new version is based on exports from the main file
@@ -121,11 +109,12 @@ describe('Generate documentation', () => { | |||
parameters: [ | |||
{ | |||
name: 'order', | |||
typeName: '"first" | "last"', |
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.
Look, the new version can detect types which the previous one could not
Issue #, if available:
Description of changes:
Moving away from typedoc
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.