fix(types): gate public JSDoc helpers (SD-2833)#3126
Merged
caio-pizzol merged 2 commits intomainfrom May 4, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
|
🎉 This PR is included in @superdoc-dev/mcp v0.3.0-next.41 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in vscode-ext v2.3.0-next.85 |
Contributor
|
🎉 This PR is included in @superdoc-dev/react v1.2.0-next.83 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc v1.30.0-next.42 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc-cli v0.8.0-next.59 The release is available on GitHub release |
Contributor
|
🎉 This PR is included in superdoc-sdk v1.8.0-next.44 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
check:jsdocso gated files are repo-relative and validated against a derived public export graph forsuperdoc,superdoc/super-editor, andsuperdoc/uimarkInsertion,markDeletion,addMarkStep) to the checked JSDoc gatetrackChangesHelpersthroughsuperdoc/super-editor, covering omitted optional IDs and the minimaladdMarkStepcall shape under bundler/node16/nodenext withskipLibCheck:false// @ts-checkwithout changing their consumer call shapesNotes
This is the first shippable SD-2833 slice, not the full public-JSDoc drain. The checker now discovers
118public JSDoc files and reports114still ungated, which gives us an explicit backlog while keeping this PR focused on the helper declarations that caused the SD-2892 review issue.One important boundary:
@ts-checkcatches JSDoc/source inconsistencies such as omitted destructured fields, but it does not reliably catch a runtime-optional field declared as required or an unused nested option declared in JSDoc. The new consumer fixture is the regression gate for that class because it compiles real public calls from the packed package.@types/uuidis added topackages/super-editordev dependencies because the newly checked helper files importuuidand TypeScript needs its declarations while runningcheckJs.Verification
pnpm --filter superdoc check:jsdocpnpm --filter superdoc run build:esnode tests/consumer-typecheck/typecheck-matrix.mjs->47 passed, 0 failed, 0 warningspnpm run type-checkgit diff --check