Skip to content

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

Merged
merged 2 commits into from
Jul 21, 2025
Merged

chore: Rewrite test utils doc generator #77

merged 2 commits into from
Jul 21, 2025

Conversation

just-boris
Copy link
Member

@just-boris just-boris commented Jul 16, 2025

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.

Copy link

codecov bot commented Jul 16, 2025

Codecov Report

Attention: Patch coverage is 95.83333% with 5 lines in your changes missing coverage. Please review.

Project coverage is 91.96%. Comparing base (44c8c9c) to head (534398c).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/test-utils-new/extractor.ts 94.59% 4 Missing ⚠️
src/test-utils-new/index.ts 97.72% 1 Missing ⚠️
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.
📢 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.

@@ -0,0 +1,3 @@
ignore:
# deprecated code
- 'src/test-utils/**'
Copy link
Member Author

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

Comment on lines -92 to +80
expect(results.length).toBe(2);
expect(results.length).toBe(1);
Copy link
Member Author

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', () => {
Copy link
Member Author

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

@just-boris just-boris marked this pull request as ready for review July 17, 2025 22:33
@just-boris just-boris requested a review from a team as a code owner July 17, 2025 22:33
@just-boris just-boris requested review from jperals and removed request for a team July 17, 2025 22:33
@@ -121,11 +109,12 @@ describe('Generate documentation', () => {
parameters: [
{
name: 'order',
typeName: '"first" | "last"',
Copy link
Member Author

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

@just-boris just-boris requested a review from jperals July 18, 2025 12:09
@just-boris just-boris requested a review from jperals July 18, 2025 18:01
@just-boris just-boris added this pull request to the merge queue Jul 21, 2025
Merged via the queue into main with commit aadfc84 Jul 21, 2025
35 checks passed
@just-boris just-boris deleted the test-utils-new branch July 21, 2025 09:44
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.

2 participants