Chrome DevTools for coding agents
chore: enforce explicit-module-boundary-types across codebase (#3285)
Nikolay Vitkovece9bca57795
diff --git a/eslint.config.js b/eslint.config.jsindex f74af1af..7c1342bc 100644--- a/eslint.config.js+++ b/eslint.config.js@@ -519,6 +519,7 @@ export default defineConfig([allowIIFEs: true,},],+ '@typescript-eslint/explicit-module-boundary-types': 'error','@local/no-direct-third-party-imports': 'error','no-restricted-imports': ['error',diff --git a/src/BrowserManager.ts b/src/BrowserManager.tsindex f537b654..4a248e0c 100644--- a/src/BrowserManager.ts+++ b/src/BrowserManager.ts@@ -95,7 +95,7 @@ export class BrowserManager {static rootSandboxLaunchError(error: Error,args: readonly string[],- uid = process.getuid?.(),+ uid: number | undefined = process.getuid?.(),): Error | undefined {if (uid !== 0) {return undefined;diff --git a/src/McpPage.ts b/src/McpPage.tsindex cabd02d6..71e8660b 100644--- a/src/McpPage.ts+++ b/src/McpPage.ts@@ -164,7 +164,7 @@ export class McpPage implements ContextPage {// SnapshottextSnapshot: TextSnapshot | null = null;- uniqueBackendNodeIdToMcpId = new Map<string, string>();+ uniqueBackendNodeIdToMcpId: Map<string, string> = new Map<string, string>();extraHandles: ElementHandle[] = [];// Emulationdiff --git a/src/config/ConfigLocator.ts b/src/config/ConfigLocator.tsindex fd78b14f..08a19fc6 100644--- a/src/config/ConfigLocator.ts+++ b/src/config/ConfigLocator.ts@@ -40,7 +40,7 @@ function isFile(filePath: string): boolean {* `CHROME_DEVTOOLS_MCP_NO_CONFIG_DISCOVERY` env variable is set.*/export class ConfigLocator {- getSearchPaths(env = process.env): string[] {+ getSearchPaths(env: NodeJS.ProcessEnv = process.env): string[] {const searchPaths: string[] = [];const pluginData = env['PLUGIN_DATA'];if (pluginData) {@@ -51,9 +51,9 @@ export class ConfigLocator {}getGlobalConfigPath(- env = process.env,- platform = process.platform,- homedir = os.homedir(),+ env: NodeJS.ProcessEnv = process.env,+ platform: NodeJS.Platform = process.platform,+ homedir: string = os.homedir(),): string {if (platform === 'win32') {const localAppData = env['LOCALAPPDATA'];@@ -70,7 +70,10 @@ export class ConfigLocator {return path.join(homedir, '.config', 'cd4a', 'config.json');}- locate(env = process.env, checkIsFile = isFile): string | undefined {+ locate(+ env: NodeJS.ProcessEnv = process.env,+ checkIsFile: (filePath: string) => boolean = isFile,+ ): string | undefined {if (env[NO_CONFIG_DISCOVERY_ENV]) {return undefined;}diff --git a/src/config/ConfigParser.ts b/src/config/ConfigParser.tsindex d6d75c74..2579077c 100644--- a/src/config/ConfigParser.ts+++ b/src/config/ConfigParser.ts@@ -36,8 +36,8 @@ export class ConfigParser {constructor(private version: string,- private argv = process.argv,- private env = process.env,+ private argv: string[] = process.argv,+ private env: NodeJS.ProcessEnv = process.env,private exitProcess = true,configLocator?: ConfigLocator,) {diff --git a/src/config/browser-options.ts b/src/config/browser-options.tsindex 97658ddf..6822fb80 100644--- a/src/config/browser-options.ts+++ b/src/config/browser-options.ts@@ -18,7 +18,7 @@ export const browserOptions = {description:'Connect to a running, debuggable Chrome instance (e.g. `http://127.0.0.1:9222`). For more details see: https://github.com/ChromeDevTools/chrome-devtools-mcp/blob/main/docs/advanced-usage.md#connecting-to-a-running-chrome-instance.',alias: 'u',- coerce: (url: string | undefined) => {+ coerce: (url: string | undefined): string | undefined => {if (!url) {return;}@@ -35,7 +35,7 @@ export const browserOptions = {description:'WebSocket endpoint to connect to a running Chrome instance (e.g., ws://127.0.0.1:9222/devtools/browser/<id>). Alternative to --browserUrl.',alias: 'w',- coerce: (url: string | undefined) => {+ coerce: (url: string | undefined): string | undefined => {if (!url) {return;}@@ -59,7 +59,7 @@ export const browserOptions = {type: 'string',description:'Custom headers for WebSocket connection in JSON format (e.g., \'{"Authorization":"Bearer token"}\'). Only works with --wsEndpoint.',- coerce: (val: unknown) => {+ coerce: (val: unknown): Record<string, string> | undefined => {if (!val) {return;}diff --git a/src/config/mcp-options.ts b/src/config/mcp-options.tsindex 0eb4e4e0..ed6fbfbe 100644--- a/src/config/mcp-options.ts+++ b/src/config/mcp-options.ts@@ -128,7 +128,7 @@ export const mcpOptions = {describe:'Frames per second to use for screencast recording. Lower values reduce file size and encoding load.',reloadable: true,- coerce: (value: number | undefined) => {+ coerce: (value: number | undefined): number | undefined => {if (value === undefined) {return;}@@ -178,7 +178,7 @@ export const mcpOptions = {type: 'number',default: DEFAULT_MAX_NAVIGATION_SAVED,describe: `Number of navigations (including the current one) for which network requests and console messages are retained per page. Must be between 1 and ${MAX_NAVIGATION_SAVED_LIMIT}. For earlier navigations, request URLs, status codes, and request and response headers are retained, which is sufficient to trace redirect hops, but response bodies are generally no longer available.`,- coerce: (value: number | undefined) => {+ coerce: (value: number | undefined): number | undefined => {if (value === undefined) {return;}@@ -255,7 +255,7 @@ export const mcpOptions = {config: {type: 'string',describe: 'Path to JSON configuration file.',- coerce: (configPath: string | undefined) => {+ coerce: (configPath: string | undefined): string | undefined => {if (!configPath) {return;}diff --git a/src/config/tool-options.ts b/src/config/tool-options.tsindex c78c7956..8ddc907b 100644--- a/src/config/tool-options.ts+++ b/src/config/tool-options.ts@@ -27,7 +27,7 @@ export const toolOptions = {description:'Override the default compression quality (0-100) used by take_screenshot for JPEG and WebP when the caller does not specify one. Lower values mean smaller files. Ignored for PNG. Unset preserves the Puppeteer default.',reloadable: true,- coerce: (value: number | undefined) => {+ coerce: (value: number | undefined): number | undefined => {if (value === undefined) {return;}@@ -44,7 +44,7 @@ export const toolOptions = {description:'Maximum width in pixels for screenshots. If the captured image is wider, it is downscaled (preserving aspect ratio) before being returned. Reduces context size in AI conversations. Unset means no resize.',reloadable: true,- coerce: (value: number | undefined) => {+ coerce: (value: number | undefined): number | undefined => {if (value === undefined) {return;}@@ -61,7 +61,7 @@ export const toolOptions = {description:'Maximum height in pixels for screenshots. If the captured image is taller, it is downscaled (preserving aspect ratio) before being returned. Can be combined with --screenshot-max-width; the smaller scale factor wins. Unset means no resize.',reloadable: true,- coerce: (value: number | undefined) => {+ coerce: (value: number | undefined): number | undefined => {if (value === undefined) {return;}diff --git a/src/daemon/client.ts b/src/daemon/client.tsindex 58b5e62e..3164b849 100644--- a/src/daemon/client.ts+++ b/src/daemon/client.ts@@ -159,7 +159,7 @@ const SEND_COMMAND_TIMEOUT = 60_000; // msexport async function sendCommand(command: DaemonMessage,sessionId: string,- timeout = SEND_COMMAND_TIMEOUT,+ timeout: number = SEND_COMMAND_TIMEOUT,): Promise<DaemonResponse> {// Before connecting and sending, verify the daemon is still alive.if (!isDaemonRunning(sessionId)) {diff --git a/src/daemon/utils.ts b/src/daemon/utils.tsindex 70d74852..7a8b7ab6 100644--- a/src/daemon/utils.ts+++ b/src/daemon/utils.ts@@ -13,7 +13,10 @@ import process from 'node:process';import type {YargsOptions} from '../third_party/index.js';import {logger} from '../utils/logger.js';-export const DAEMON_SCRIPT_PATH = path.join(import.meta.dirname, 'daemon.js');+export const DAEMON_SCRIPT_PATH: string = path.join(+ import.meta.dirname,+ 'daemon.js',+);const APP_NAME = 'chrome-devtools-mcp';export const DAEMON_CLIENT_NAME = 'chrome-devtools-cli-daemon';@@ -66,7 +69,7 @@ export function getRuntimeHome(sessionId: string): string {return path.join(os.tmpdir(), appName);}-export const IS_WINDOWS = os.platform() === 'win32';+export const IS_WINDOWS: boolean = os.platform() === 'win32';export function getPidFilePath(sessionId: string): string {assertValidSessionId(sessionId);diff --git a/src/devtools/issueDescriptions.ts b/src/devtools/issueDescriptions.tsindex ea6df721..86a27f6d 100644--- a/src/devtools/issueDescriptions.ts+++ b/src/devtools/issueDescriptions.ts@@ -53,7 +53,10 @@ export function getIssueDescription(fileName: string): string | null {return issueDescriptions[fileName] ?? null;}-export const ISSUE_UTILS = {+export const ISSUE_UTILS: {+ loadIssueDescriptions: () => Promise<void>;+ getIssueDescription: (fileName: string) => string | null;+} = {loadIssueDescriptions,getIssueDescription,};diff --git a/src/telemetry/transformation.ts b/src/telemetry/transformation.tsindex 98f0bd9d..d385daf9 100644--- a/src/telemetry/transformation.ts+++ b/src/telemetry/transformation.ts@@ -42,7 +42,7 @@ export function sanitizeClientName(clientName: string): string {return REDACTED_CLIENT_NAME;}-export const PARAM_BLOCKLIST = new Set(['uid', 'reqid', 'msgid']);+export const PARAM_BLOCKLIST: Set<string> = new Set(['uid', 'reqid', 'msgid']);const SUPPORTED_ZOD_TYPES = ['ZodString',diff --git a/src/tools/categories.ts b/src/tools/categories.tsindex e7c7ffcb..2c28a8e7 100644--- a/src/tools/categories.ts+++ b/src/tools/categories.ts@@ -18,7 +18,7 @@ export enum ToolCategory {PWA = 'pwa',}-export const labels = {+export const labels: Record<ToolCategory, string> = {[ToolCategory.INPUT]: 'Input automation',[ToolCategory.NAVIGATION]: 'Navigation automation',[ToolCategory.EMULATION]: 'Emulation',diff --git a/src/utils/id.ts b/src/utils/id.tsindex 9e14b231..2fc2f8a6 100644--- a/src/utils/id.ts+++ b/src/utils/id.ts@@ -4,9 +4,9 @@* SPDX-License-Identifier: Apache-2.0*/-export function createIdGenerator() {+export function createIdGenerator(): () => number {let i = 1;- return () => {+ return (): number => {if (i === Number.MAX_SAFE_INTEGER) {i = 0;}@@ -14,7 +14,7 @@ export function createIdGenerator() {};}-export const stableIdSymbol = Symbol('stableIdSymbol');+export const stableIdSymbol: unique symbol = Symbol('stableIdSymbol');export type WithSymbolId<T> = T & {[stableIdSymbol]?: number;diff --git a/tests/mocks.ts b/tests/mocks.tsindex 2bcf70df..74f10b38 100644--- a/tests/mocks.ts+++ b/tests/mocks.ts@@ -152,13 +152,27 @@ export type MockCSSFunctionRule =* Puppeteer objects (Page, CDPSession, Browser) so tests can trigger events* synchronously without a real browser.*/-export function mockListener() {+export function mockListener(): {+ on: (+ eventName: string | symbol | number,+ listener: (data: unknown) => void,+ ) => void;+ off: (+ eventName: string | symbol | number,+ listener?: (data: unknown) => void,+ ) => void;+ emit: (eventName: string | symbol | number, data?: unknown) => void;+ listenerCount: (eventName: string | symbol | number) => number;+} {const listeners: Record<string | symbol | number,Array<(data: unknown) => void>> = {};return {- on(eventName: string | symbol | number, listener: (data: unknown) => void) {+ on(+ eventName: string | symbol | number,+ listener: (data: unknown) => void,+ ): void {const arr = listeners[eventName];if (arr) {arr.push(listener);@@ -169,7 +183,7 @@ export function mockListener() {off(eventName: string | symbol | number,listener?: (data: unknown) => void,- ) {+ ): void {const arr = listeners[eventName];if (!arr) {return;@@ -180,12 +194,12 @@ export function mockListener() {}listeners[eventName] = arr.filter(entry => entry !== listener);},- emit(eventName: string | symbol | number, data?: unknown) {+ emit(eventName: string | symbol | number, data?: unknown): void {for (const listener of listeners[eventName] ?? []) {listener(data);}},- listenerCount(eventName: string | symbol | number) {+ listenerCount(eventName: string | symbol | number): number {return listeners[eventName]?.length ?? 0;},};diff --git a/tests/server.ts b/tests/server.tsindex f73c5615..9e340214 100644--- a/tests/server.ts+++ b/tests/server.ts@@ -17,7 +17,7 @@ export class TestServer {#port: number;#server: Server;- static randomPort() {+ static randomPort(): number {/*** Some ports are restricted by Chromium and will fail to connect* to prevent we start after the@@ -41,14 +41,14 @@ export class TestServer {return `http://127.0.0.1:${this.#port}`;}- getRoute(path: string) {+ getRoute(path: string): string {if (!this.#routes[path]) {throw new Error(`Route ${path} was not setup.`);}return `${this.baseUrl}${path}`;}- addHtmlRoute(path: string, htmlContent: string) {+ addHtmlRoute(path: string, htmlContent: string): void {if (this.#routes[path]) {throw new Error(`Route ${path} was already setup.`);}@@ -62,7 +62,7 @@ export class TestServer {addRoute(path: string,handler: (req: IncomingMessage, res: ServerResponse) => void,- ) {+ ): void {if (this.#routes[path]) {throw new Error(`Route ${path} was already setup.`);}@@ -83,7 +83,7 @@ export class TestServer {}}- restore() {+ restore(): void {this.#routes = {};}@@ -129,7 +129,7 @@ export class TestServer {}}-export function serverHooks() {+export function serverHooks(): TestServer {const server = new TestServer(TestServer.randomPort());before(async () => {await server.start();diff --git a/tests/utils.ts b/tests/utils.tsindex a2c4746a..46131076 100644--- a/tests/utils.ts+++ b/tests/utils.ts@@ -47,7 +47,10 @@ import {stripUndefined,} from './mocks.js';-export function assertNoServiceWorkerReported(targets: Target[], id: string) {+export function assertNoServiceWorkerReported(+ targets: Target[],+ id: string,+): void {const target = targets.find(target => {return target.url().includes(id) && target.type() === 'service_worker';});@@ -73,7 +76,7 @@ export function getImageContent(content: CallToolResult['content'][number]): {throw new Error(`Expected image content but got ${content.type}`);}-export function extractExtensionId(response: McpResponse) {+export function extractExtensionId(response: McpResponse): string {const responseLine = response.responseLines[0];assert.ok(responseLine, 'Response should not be empty');const match = responseLine.match(/Extension installed\. Id: (.+)/);@@ -95,7 +98,7 @@ export async function withBrowser(blockedUrlPattern?: string[];allowedUrlPattern?: string[];} = {},-) {+): Promise<void> {let attempt = 1;while (attempt <= 3) {const launchOptions: LaunchOptions = {@@ -215,7 +218,7 @@ export async function withMcpContext(navigationTimeout?: number;} = {},args: Partial<ParsedArguments> = {},-) {+): Promise<void> {await withBrowser(async browser => {TextSnapshot.resetCounter();McpContext.resetPageIdsForTesting();@@ -390,7 +393,7 @@ export function stabilizeStructuredContent(content: unknown): string {return JSON.stringify(stabilize(content), null, 2);}-export function stabilizeResponseOutput(text: unknown) {+export function stabilizeResponseOutput(text: unknown): string {if (typeof text !== 'string') {throw new Error('Input must be string');}@@ -467,7 +470,9 @@ export function getMockBrowser(options?: {} as Browser;}-export const CLI_PATH = path.resolve('build/src/bin/chrome-devtools.js');+export const CLI_PATH: string = path.resolve(+ 'build/src/bin/chrome-devtools.js',+);export async function runCli(args: string[],@@ -499,7 +504,9 @@ export async function runCli(});}-export async function assertDaemonIsNotRunning(sessionId?: string) {+export async function assertDaemonIsNotRunning(+ sessionId?: string,+): Promise<void> {const result = await runCli(['status'], sessionId);assert.strictEqual(result.stdout,@@ -511,7 +518,7 @@ export async function assertDaemonIsNotRunning(sessionId?: string) {* Stops the daemon in-process. Use it for test cleanup: it does not spawn* a CLI process, which takes about a second per call.*/-export async function stopDaemonForCleanup(sessionId: string) {+export async function stopDaemonForCleanup(sessionId: string): Promise<void> {await stopDaemon(sessionId);assert.ok(!isDaemonRunning(sessionId), 'daemon is still running');}@@ -528,7 +535,7 @@ export function createCliSession(t: TestContext): string {return sessionId;}-export async function assertDaemonIsRunning(sessionId?: string) {+export async function assertDaemonIsRunning(sessionId?: string): Promise<void> {const result = await runCli(['status'], sessionId);assert.ok(result.stdout.startsWith('chrome-devtools-mcp daemon is running.\n'),@@ -539,7 +546,7 @@ export async function assertDaemonIsRunning(sessionId?: string) {export async function waitExecutionFor(func: () => Promise<void>,timeout: number,-) {+): Promise<void> {const start = Date.now();while (Date.now() - start < 10000) {try {@@ -555,12 +562,15 @@ export async function waitExecutionFor(export function createTempDir(prefix = 'chrome-devtools-test-',- baseDir = os.tmpdir(),-) {+ baseDir: string = os.tmpdir(),+): {+ path: string;+ [Symbol.dispose]: () => void;+} {const dirPath = fs.mkdtempSync(path.join(baseDir, prefix));return {path: dirPath,- [Symbol.dispose]() {+ [Symbol.dispose](): void {try {fs.rmSync(dirPath, {recursive: true, force: true});} catch {@@ -573,8 +583,11 @@ export function createTempDir(export function createTempFile(content: string,fileName: string,- baseDir = os.tmpdir(),-) {+ baseDir: string = os.tmpdir(),+): {+ path: string;+ [Symbol.dispose]: () => void;+} {const dirPath = fs.mkdtempSync(path.join(baseDir, 'chrome-devtools-test-file-'),);@@ -582,7 +595,7 @@ export function createTempFile(fs.writeFileSync(filePath, content);return {path: filePath,- [Symbol.dispose]() {+ [Symbol.dispose](): void {try {fs.rmSync(dirPath, {recursive: true, force: true});} catch {diff --git a/tsconfig.json b/tsconfig.jsonindex 07ff683e..323329b9 100644--- a/tsconfig.json+++ b/tsconfig.json@@ -1,5 +1,6 @@{"compilerOptions": {+ "module": "esnext","target": "es2023","lib": ["ES2023",@@ -23,6 +24,7 @@"incremental": true,"sourceMap": true,"allowJs": true,+ "preserveConstEnums": true,"useUnknownInCatchVariables": false},"include": [