test: add some validation for JSON doc output #61413
Open
+153
−2
Conversation
This file contains hidden or 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
cjihrig
approved these changes
Jan 17, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #61413 +/- ##
==========================================
- Coverage 88.53% 88.53% -0.01%
==========================================
Files 704 704
Lines 208876 208876
Branches 40330 40334 +4
==========================================
- Hits 184937 184929 -8
- Misses 15922 15928 +6
- Partials 8017 8019 +2 🚀 New features to boost your workflow:
|
ovflowd
approved these changes
Jan 17, 2026
| if (dirent.name !== 'index.md') { | ||
| assert.ok(json.introduced_in || Object.values(json).at(-1)?.[0].introduced_in); | ||
| } | ||
| assert.deepStrictEqual(Object.keys(json), ['type', 'source', ...({ |
Member
There was a problem hiding this comment.
Will this change over time as more api files are added? Should we document that somewhere?
atlowChemi
approved these changes
Jan 17, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
We don't have any validation for the JSON output of the docs, errors can easily slip up there. Those tests become more important to gain confidence to switch a different system to generate those.
It's also a way to enforce consistency as demonstrated by the Markdown change in this PR.