-
Notifications
You must be signed in to change notification settings - Fork 4
chore: fix documentComponents functions signature #61
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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #61 +/- ##
==========================================
+ Coverage 90.55% 90.61% +0.05%
==========================================
Files 16 16
Lines 519 522 +3
Branches 146 150 +4
==========================================
+ Hits 470 473 +3
+ Misses 49 47 -2
- Partials 0 2 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
fc5b443 to
9d63ab1
Compare
| } | ||
|
|
||
| interface DocumenterOptions { | ||
| tsconfigPath: string; |
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.
Won't adding required properties here be backwards incompatible when calling this function from the components package? Unless you're planning on merging a matching components PR at the same time, it would probably be safer to make a new interface for this?
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.
Downstream packages do not use typescript so the build passes regardless.
And I am planning to migrate to the new signature once it is released and then remove the legacy one here
9d63ab1 to
3e86ab1
Compare
Issue #, if available:
Description of changes:
It is now 4 arguments, with holes in between,
documentComponents(tsconfig, glob, undefined, options). Time to switch from multi-arguments to a singleoptionsargumentBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.