Skip to content

Conversation

@just-boris
Copy link
Member

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 single options argument

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@codecov
Copy link

codecov bot commented Apr 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.61%. Comparing base (671bd2c) to head (3e86ab1).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@just-boris just-boris force-pushed the components-without-typedoc branch from fc5b443 to 9d63ab1 Compare April 10, 2025 09:55
@just-boris just-boris marked this pull request as ready for review April 10, 2025 10:11
@just-boris just-boris requested a review from a team as a code owner April 10, 2025 10:11
@just-boris just-boris requested review from avinashbot and removed request for a team April 10, 2025 10:11
@just-boris just-boris changed the title fix documentComponents functions signature chore: fix documentComponents functions signature Apr 10, 2025
}

interface DocumenterOptions {
tsconfigPath: string;
Copy link
Member

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?

Copy link
Member Author

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

@just-boris just-boris requested a review from avinashbot April 11, 2025 14:51
avinashbot
avinashbot previously approved these changes Apr 11, 2025
@just-boris just-boris added this pull request to the merge queue Apr 14, 2025
Merged via the queue into main with commit 98b1a89 Apr 14, 2025
35 checks passed
@just-boris just-boris deleted the components-without-typedoc branch April 14, 2025 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants