Skip to content

Commit d51c340

Browse files
ci: add TypeDoc validation to check:all with treatWarningsAsErrors
- 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>
1 parent e93e14b commit d51c340

4 files changed

Lines changed: 4 additions & 3 deletions

File tree

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"prepack:all": "pnpm -r prepack",
3232
"lint:all": "pnpm -r lint",
3333
"lint:fix:all": "pnpm -r lint:fix",
34-
"check:all": "pnpm -r typecheck && pnpm -r lint",
34+
"check:all": "pnpm -r typecheck && pnpm -r lint && pnpm run docs:check",
3535
"test:all": "pnpm -r test",
3636
"test:conformance:client": "pnpm --filter @modelcontextprotocol/test-conformance run test:conformance:client",
3737
"test:conformance:client:all": "pnpm --filter @modelcontextprotocol/test-conformance run test:conformance:client:all",

packages/client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"prepack": "npm run build",
5656
"lint": "eslint src/ && prettier --ignore-path ../../.prettierignore --check .",
5757
"lint:fix": "eslint src/ --fix && prettier --ignore-path ../../.prettierignore --write .",
58-
"check": "npm run typecheck && npm run lint && pnpm exec -- typedoc --emit none",
58+
"check": "npm run typecheck && npm run lint",
5959
"test": "vitest run",
6060
"test:watch": "vitest",
6161
"start": "npm run server",

packages/server/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"prepack": "npm run build",
5656
"lint": "eslint src/ && prettier --ignore-path ../../.prettierignore --check .",
5757
"lint:fix": "eslint src/ --fix && prettier --ignore-path ../../.prettierignore --write .",
58-
"check": "npm run typecheck && npm run lint && pnpm exec -- typedoc --emit none",
58+
"check": "npm run typecheck && npm run lint",
5959
"test": "vitest run",
6060
"test:watch": "vitest",
6161
"start": "npm run server",

typedoc.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,6 @@ export default {
3838
headings: {
3939
readme: false
4040
},
41+
treatWarningsAsErrors: true,
4142
out: 'tmp/docs/',
4243
};

0 commit comments

Comments
 (0)