Skip to content

Commit 55857a8

Browse files
ci: add TypeDoc validation to check:all with treatWarningsAsErrors (#1522)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 553d6d4 commit 55857a8

File tree

7 files changed

+7
-7
lines changed

7 files changed

+7
-7
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"prepack:all": "pnpm -r prepack",
3333
"lint:all": "pnpm sync:snippets --check && pnpm -r lint",
3434
"lint:fix:all": "pnpm sync:snippets && pnpm -r lint:fix",
35-
"check:all": "pnpm -r typecheck && pnpm -r lint",
35+
"check:all": "pnpm -r typecheck && pnpm -r lint && pnpm run docs:check",
3636
"test:all": "pnpm -r test",
3737
"test:conformance:client": "pnpm --filter @modelcontextprotocol/test-conformance run test:conformance:client",
3838
"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/client/src/client/auth.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ export class UnauthorizedError extends Error {
193193
}
194194
}
195195

196-
type ClientAuthMethod = 'client_secret_basic' | 'client_secret_post' | 'none';
196+
export type ClientAuthMethod = 'client_secret_basic' | 'client_secret_post' | 'none';
197197

198198
function isClientAuthMethod(method: string): method is ClientAuthMethod {
199199
return ['client_secret_basic', 'client_secret_post', 'none'].includes(method);

packages/client/src/experimental/tasks/client.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ export class ExperimentalClientTasks {
8282
* ```
8383
*
8484
* @param params - Tool call parameters (name and arguments)
85-
* @param resultSchema - Zod schema for validating the result (defaults to {@linkcode CallToolResultSchema})
8685
* @param options - Optional request options (timeout, signal, task creation params, etc.)
8786
* @returns AsyncGenerator that yields {@linkcode ResponseMessage} objects
8887
*

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",

packages/server/src/server/mcp.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1008,7 +1008,7 @@ export type RegisteredTool = {
10081008
execution?: ToolExecution;
10091009
_meta?: Record<string, unknown>;
10101010
handler: AnyToolHandler<AnySchema | undefined>;
1011-
/** @internal */
1011+
/** @hidden */
10121012
executor: ToolExecutor;
10131013
enabled: boolean;
10141014
enable(): void;
@@ -1147,7 +1147,7 @@ export type RegisteredPrompt = {
11471147
title?: string;
11481148
description?: string;
11491149
argsSchema?: AnySchema;
1150-
/** @internal */
1150+
/** @hidden */
11511151
handler: PromptHandler;
11521152
enabled: boolean;
11531153
enable(): void;

typedoc.config.mjs

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

0 commit comments

Comments
 (0)