ci: add TypeDoc validation to check:all with treatWarningsAsErrors#1522
Merged
jonathanhefner merged 2 commits intomodelcontextprotocol:mainfrom Feb 13, 2026
Merged
ci: add TypeDoc validation to check:all with treatWarningsAsErrors#1522jonathanhefner merged 2 commits intomodelcontextprotocol:mainfrom
check:all with treatWarningsAsErrors#1522jonathanhefner merged 2 commits intomodelcontextprotocol:mainfrom
Conversation
|
@modelcontextprotocol/client
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
felixweinberger
previously approved these changes
Feb 11, 2026
jonathanhefner
force-pushed
the
ci-docs
branch
from
1b4db1f to
d51c340
Compare
- Remove stale `@param resultSchema` from `callToolStream` (parameter doesn't exist) - Export `ClientAuthMethod` type (used as return type of public `selectClientAuthMethod`) - Use `@hidden` instead of `@internal` on `RegisteredTool.executor` and `RegisteredPrompt.handler` to suppress TypeDoc warnings for unexported types Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add `treatWarningsAsErrors: true` to `typedoc.config.mjs` so TypeDoc exits non-zero on any warning (stale `@param`, broken `@link`, etc.) - Append `pnpm run docs:check` to the root `check:all` script so CI validates documentation alongside typecheck and lint - Remove per-package `typedoc --emit none` from client and server `check` scripts — the root holistic run is the authoritative check and uses the correct `entryPointStrategy: "packages"` config Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
jonathanhefner
force-pushed
the
ci-docs
branch
from
d51c340 to
aaafd30
Compare
felixweinberger
approved these changes
Feb 13, 2026
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
2 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.
This PR fixes a handful of TypeDoc warnings:
@param resultSchemafromcallToolStream(parameter doesn't exist)ClientAuthMethodtype (used as return type of publicselectClientAuthMethod)@hiddeninstead of@internalonRegisteredTool.executorandRegisteredPrompt.handlerto suppress TypeDoc warnings for unexported typesAnd then adds a check to CI to prevent them in the future:
treatWarningsAsErrors: truetotypedoc.config.mjsso TypeDoc exits non-zero on any warning (stale@param, broken@link, etc.)pnpm run docs:checkto the rootcheck:allscript so CI validates documentation alongside typecheck and linttypedoc --emit nonefrom client and servercheckscripts — the root holistic run is the authoritative check and uses the correctentryPointStrategy: "packages"config