Automatically generate roo-code.d.ts (including type generation via zod-to-ts) (#2024)

Author: cte

.changeset/sweet-bugs-glow.md

@@ -0,0 +1,5 @@
+---
+"roo-cline": patch
+---
+
+Automatically generate .d.ts from zod schemas

.husky/pre-commit

@@ -12,4 +12,12 @@ else
   npx_cmd="npx"
 fi
 
-"$npx_cmd" lint-staged
+npm run generate-types
+
+if [ -n "$(git diff --name-only src/exports/roo-code.d.ts)" ]; then
+  echo "Error: There are unstaged changes to roo-code.d.ts after running 'npm run generate-types'."
+  echo "Please review and stage the changes before committing."
+  exit 1
+fi
+
+"$npx_cmd" lint-staged

e2e/src/suite/utils.ts

@@ -9,7 +9,7 @@ type WaitForOptions = {
 
 export const waitFor = (
 	condition: (() => Promise<boolean>) | (() => boolean),
-	{ timeout = 30_000, interval = 250 }: WaitForOptions = {},
+	{ timeout = 60_000, interval = 250 }: WaitForOptions = {},
 ) => {
 	let timeoutId: NodeJS.Timeout | undefined = undefined
 

package.json

@@ -351,7 +351,8 @@
 		"clean:webview": "cd webview-ui && npm run clean",
 		"clean:e2e": "cd e2e && npm run clean",
 		"clean:benchmark": "cd benchmark && npm run clean",
-		"update-contributors": "node scripts/update-contributors.js"
+		"update-contributors": "node scripts/update-contributors.js",
+		"generate-types": "tsx scripts/generate-types.mts"
 	},
 	"dependencies": {
 		"@anthropic-ai/bedrock-sdk": "^0.10.2",

scripts/generate-types.mts

@@ -0,0 +1,26 @@
+import fs from "fs/promises"
+
+import { zodToTs, createTypeAlias, printNode } from "zod-to-ts"
+import { $ } from "execa"
+
+import { typeDefinitions } from "../src/schemas"
+
+async function main() {
+	const types: string[] = [
+		"// This file is automatically generated by running `npm run generate-types`\n// Do not edit it directly.",
+	]
+
+	for (const { schema, identifier } of typeDefinitions) {
+		types.push(printNode(createTypeAlias(zodToTs(schema, identifier).node, identifier)))
+		types.push(`export type { ${identifier} }`)
+	}
+
+	await fs.writeFile("src/exports/types.ts", types.join("\n\n"))
+
+	await $`npx tsup src/exports/interface.ts --dts-only -d out`
+	await fs.copyFile('out/interface.d.ts', 'src/exports/roo-code.d.ts')
+
+	await $`npx prettier --write src/exports/types.ts src/exports/roo-code.d.ts`
+}
+
+main()

src/core/Cline.ts

@@ -11,9 +11,8 @@ import pWaitFor from "p-wait-for"
 import getFolderSize from "get-folder-size"
 import { serializeError } from "serialize-error"
 import * as vscode from "vscode"
-import { isPathOutsideWorkspace } from "../utils/pathUtils"
 
-import { TokenUsage } from "../exports/roo-code"
+import { TokenUsage } from "../schemas"
 import { ApiHandler, buildApiHandler } from "../api"
 import { ApiStream } from "../api/transform/stream"
 import { DIFF_VIEW_URI_SCHEME, DiffViewProvider } from "../integrations/editor/DiffViewProvider"
@@ -65,6 +64,7 @@ import { defaultModeSlug, getModeBySlug, getFullModeDetails } from "../shared/mo
 import { EXPERIMENT_IDS, experiments as Experiments, ExperimentId } from "../shared/experiments"
 import { calculateApiCostAnthropic } from "../utils/cost"
 import { fileExistsAtPath } from "../utils/fs"
+import { isPathOutsideWorkspace } from "../utils/pathUtils"
 import { arePathsEqual, getReadablePath } from "../utils/path"
 import { parseMentions } from "./mentions"
 import { RooIgnoreController } from "./ignore/RooIgnoreController"

src/core/__tests__/mode-validator.test.ts

@@ -1,6 +1,7 @@
-import { Mode, isToolAllowedForMode, getModeConfig, modes } from "../../shared/modes"
-import { validateToolUse } from "../mode-validator"
+import { isToolAllowedForMode, getModeConfig, modes, ModeConfig } from "../../shared/modes"
 import { TOOL_GROUPS } from "../../shared/tool-groups"
+import { validateToolUse } from "../mode-validator"
+
 const [codeMode, architectMode, askMode] = modes.map((mode) => mode.slug)
 
 describe("mode-validator", () => {
@@ -49,7 +50,7 @@ describe("mode-validator", () => {
 
 		describe("custom modes", () => {
 			it("allows tools from custom mode configuration", () => {
-				const customModes = [
+				const customModes: ModeConfig[] = [
 					{
 						slug: "custom-mode",
 						name: "Custom Mode",
@@ -65,7 +66,7 @@ describe("mode-validator", () => {
 			})
 
 			it("allows custom mode to override built-in mode", () => {
-				const customModes = [
+				const customModes: ModeConfig[] = [
 					{
 						slug: codeMode,
 						name: "Custom Code Mode",
@@ -80,7 +81,7 @@ describe("mode-validator", () => {
 			})
 
 			it("respects tool requirements in custom modes", () => {
-				const customModes = [
+				const customModes: ModeConfig[] = [
 					{
 						slug: "custom-mode",
 						name: "Custom Mode",

src/core/config/ContextProxy.ts

@@ -1,25 +1,27 @@
 import * as vscode from "vscode"
 
-import { logger } from "../../utils/logging"
-import type {
-	ProviderSettings,
-	RooCodeSettings,
-	RooCodeSettingsKey,
-	GlobalStateKey,
-	GlobalState,
-	SecretStateKey,
-	SecretState,
-	GlobalSettings,
-} from "../../exports/roo-code"
 import {
 	PROVIDER_SETTINGS_KEYS,
-	GLOBAL_STATE_KEYS,
+	ProviderSettings,
+	providerSettingsSchema,
+	GlobalSettings,
+	globalSettingsSchema,
+	RooCodeSettings,
 	SECRET_STATE_KEYS,
+	SecretState,
 	isSecretStateKey,
-	isPassThroughStateKey,
-	globalSettingsSchema,
-	providerSettingsSchema,
-} from "../../shared/globalState"
+	GLOBAL_STATE_KEYS,
+	GlobalState,
+} from "../../schemas"
+import { logger } from "../../utils/logging"
+
+type GlobalStateKey = keyof GlobalState
+type SecretStateKey = keyof SecretState
+type RooCodeSettingsKey = keyof RooCodeSettings
+
+const PASS_THROUGH_STATE_KEYS = ["taskHistory"]
+
+export const isPassThroughStateKey = (key: string) => PASS_THROUGH_STATE_KEYS.includes(key)
 
 const globalSettingsExportSchema = globalSettingsSchema.omit({
 	taskHistory: true,

src/core/config/ProviderSettingsManager.ts

@@ -1,9 +1,8 @@
 import { ExtensionContext } from "vscode"
 import { z } from "zod"
 
-import { providerSettingsSchema } from "../../shared/globalState"
+import { providerSettingsSchema, ApiConfigMeta } from "../../schemas"
 import { Mode } from "../../shared/modes"
-import { ApiConfigMeta } from "../../shared/ExtensionMessage"
 
 const providerSettingsWithIdSchema = providerSettingsSchema.extend({ id: z.string().optional() })
 

src/core/config/__tests__/ContextProxy.test.ts

@@ -1,12 +1,9 @@
 // npx jest src/core/config/__tests__/ContextProxy.test.ts
 
-import fs from "fs/promises"
-
 import * as vscode from "vscode"
 import { ContextProxy } from "../ContextProxy"
 
-import { logger } from "../../../utils/logging"
-import { GLOBAL_STATE_KEYS, SECRET_STATE_KEYS } from "../../../shared/globalState"
+import { GLOBAL_STATE_KEYS, SECRET_STATE_KEYS } from "../../../schemas"
 
 jest.mock("vscode", () => ({
 	Uri: {