Skip to content

Commit 812668a

Browse files
kitlangtonkitlangton
authored
Generate TUI schema from Effect Schema (#26945)
1 parent a5c35bf commit 812668a

5 files changed

Lines changed: 124 additions & 9 deletions

File tree

‎packages/opencode/script/schema.ts‎

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
import { z } from "zod"
44
import { Config } from "@/config/config"
55
import { zodObject } from "@opencode-ai/core/effect-zod"
6-
import { TuiConfig } from "../src/cli/cmd/tui/config/tui"
6+
import { TuiJsonSchema } from "../src/cli/cmd/tui/config/tui-json-schema"
7+
import { Schema } from "effect"
8+
9+
type JsonSchema = Record<string, unknown>
710

811
function generate(schema: z.ZodType) {
912
const result = z.toJSONSchema(schema, {
@@ -34,7 +37,7 @@ function generate(schema: z.ZodType) {
3437
schema.examples = [schema.default]
3538
}
3639

37-
schema.description = [schema.description || "", `default: \`${String(schema.default)}\``]
40+
schema.description = [schema.description || "", `default: \`${formatDefault(schema.default)}\``]
3841
.filter(Boolean)
3942
.join("\n\n")
4043
.trim()
@@ -52,6 +55,55 @@ function generate(schema: z.ZodType) {
5255
return result
5356
}
5457

58+
function formatDefault(value: unknown) {
59+
if (typeof value !== "object" || value === null) return String(value)
60+
return JSON.stringify(value)
61+
}
62+
63+
function generateEffect(schema: Schema.Top) {
64+
const document = Schema.toJsonSchemaDocument(schema)
65+
const normalized = normalize({
66+
$schema: "https://json-schema.org/draft/2020-12/schema",
67+
...document.schema,
68+
$defs: document.definitions,
69+
})
70+
if (!isRecord(normalized)) throw new Error("schema generator produced a non-object schema")
71+
normalized.allowComments = true
72+
normalized.allowTrailingCommas = true
73+
return normalized
74+
}
75+
76+
function normalize(value: unknown): unknown {
77+
if (Array.isArray(value)) return value.map(normalize)
78+
if (!isRecord(value)) return value
79+
80+
const schema = Object.fromEntries(Object.entries(value).map(([key, item]) => [key, normalize(item)]))
81+
82+
if (Array.isArray(schema.anyOf)) {
83+
const anyOf = schema.anyOf.filter((item) => !isRecord(item) || item.type !== "null")
84+
if (anyOf.length !== schema.anyOf.length) {
85+
const { anyOf: _, ...rest } = schema
86+
if (anyOf.length === 1 && isRecord(anyOf[0])) return normalize({ ...anyOf[0], ...rest })
87+
return { ...rest, anyOf }
88+
}
89+
}
90+
91+
if (Array.isArray(schema.allOf) && schema.allOf.length === 1 && isRecord(schema.allOf[0])) {
92+
const { allOf: _, ...rest } = schema
93+
return normalize({ ...schema.allOf[0], ...rest })
94+
}
95+
96+
if (schema.type === "integer" && schema.maximum === undefined) {
97+
return { ...schema, maximum: Number.MAX_SAFE_INTEGER }
98+
}
99+
100+
return schema
101+
}
102+
103+
function isRecord(value: unknown): value is JsonSchema {
104+
return typeof value === "object" && value !== null && !Array.isArray(value)
105+
}
106+
55107
const configFile = process.argv[2]
56108
const tuiFile = process.argv[3]
57109

@@ -60,5 +112,5 @@ await Bun.write(configFile, JSON.stringify(generate(zodObject(Config.Info).stric
60112

61113
if (tuiFile) {
62114
console.log(tuiFile)
63-
await Bun.write(tuiFile, JSON.stringify(generate(TuiConfig.JsonSchemaInfo), null, 2))
115+
await Bun.write(tuiFile, JSON.stringify(generateEffect(TuiJsonSchema.Info), null, 2))
64116
}

‎packages/opencode/src/cli/cmd/tui/config/keybind.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ export * as TuiKeybind from "./keybind"
22

33
import type { KeyEvent, Renderable } from "@opentui/core"
44
import type { Binding } from "@opentui/keymap"
5-
import type { BindingCommandMap, BindingConfig, BindingDefaults, BindingValue } from "@opentui/keymap/extras"
5+
import type { BindingCommandMap, BindingConfig, BindingDefaults } from "@opentui/keymap/extras"
66
import z from "zod"
77

88
const KeyStroke = z
@@ -38,7 +38,7 @@ export const LeaderDefault = "ctrl+x"
3838

3939
const keybind = (value: Definition["default"], description: string): Definition => ({ default: value, description })
4040

41-
const Definitions = {
41+
export const Definitions = {
4242
leader: keybind(LeaderDefault, "Leader key for keybind combinations"),
4343

4444
app_exit: keybind("ctrl+c,ctrl+d,<leader>q", "Exit the application"),

‎packages/opencode/src/cli/cmd/tui/config/tui-json-schema.ts‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
import { ConfigPlugin } from "@/config/plugin"
2+
import { Schema } from "effect"
3+
import { TuiKeybind } from "./keybind"
4+
5+
const KeymapLeaderTimeout = Schema.Int.check(Schema.isGreaterThan(0)).annotate({
6+
description: "Leader key timeout in milliseconds",
7+
})
8+
9+
const KeyStroke = Schema.Struct({
10+
name: Schema.String,
11+
ctrl: Schema.optional(Schema.Boolean),
12+
shift: Schema.optional(Schema.Boolean),
13+
meta: Schema.optional(Schema.Boolean),
14+
super: Schema.optional(Schema.Boolean),
15+
hyper: Schema.optional(Schema.Boolean),
16+
})
17+
18+
const BindingObject = Schema.StructWithRest(
19+
Schema.Struct({
20+
key: Schema.Union([Schema.String, KeyStroke]),
21+
event: Schema.optional(Schema.Literals(["press", "release"])),
22+
preventDefault: Schema.optional(Schema.Boolean),
23+
fallthrough: Schema.optional(Schema.Boolean),
24+
}),
25+
[Schema.Record(Schema.String, Schema.Unknown)],
26+
)
27+
28+
const BindingItem = Schema.Union([Schema.String, KeyStroke, BindingObject])
29+
const BindingValue = Schema.Union([
30+
Schema.Literal(false),
31+
Schema.Literal("none"),
32+
BindingItem,
33+
Schema.Array(BindingItem),
34+
])
35+
36+
const KeybindOverrides = Schema.Struct(
37+
Object.fromEntries(
38+
Object.entries(TuiKeybind.Definitions).map(([name, item]) => [
39+
name,
40+
Schema.optional(BindingValue).annotate({ description: item.description }),
41+
]),
42+
),
43+
).annotate({ description: "TUI keybinding overrides" })
44+
45+
export const Info = Schema.Struct({
46+
$schema: Schema.optional(Schema.String),
47+
theme: Schema.optional(Schema.String),
48+
keybinds: Schema.optional(KeybindOverrides),
49+
plugin: Schema.optional(Schema.Array(ConfigPlugin.Spec)),
50+
plugin_enabled: Schema.optional(Schema.Record(Schema.String, Schema.Boolean)),
51+
leader_timeout: Schema.optional(KeymapLeaderTimeout),
52+
scroll_speed: Schema.optional(Schema.Number.check(Schema.isGreaterThanOrEqualTo(0.001))).annotate({
53+
description: "TUI scroll speed",
54+
}),
55+
scroll_acceleration: Schema.optional(
56+
Schema.Struct({
57+
enabled: Schema.Boolean.annotate({ description: "Enable scroll acceleration" }),
58+
}),
59+
).annotate({ description: "Scroll acceleration settings" }),
60+
diff_style: Schema.optional(Schema.Literals(["auto", "stacked"])).annotate({
61+
description: "Control diff rendering style: 'auto' adapts to terminal width, 'stacked' always shows single column",
62+
}),
63+
mouse: Schema.optional(Schema.Boolean).annotate({ description: "Enable or disable mouse capture (default: true)" }),
64+
})
65+
66+
export * as TuiJsonSchema from "./tui-json-schema"

‎packages/opencode/src/cli/cmd/tui/config/tui-schema.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,3 @@ export const TuiInfo = z
3131
})
3232
.extend(TuiOptions.shape)
3333
.strict()
34-
35-
export const TuiJsonSchemaInfo = TuiInfo

‎packages/opencode/src/cli/cmd/tui/config/tui.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { ConfigParse } from "@/config/parse"
88
import { InvalidError } from "@/config/error"
99
import * as ConfigPaths from "@/config/paths"
1010
import { migrateTuiConfig } from "./tui-migrate"
11-
import { KeymapLeaderTimeoutDefault, TuiInfo, TuiJsonSchemaInfo } from "./tui-schema"
11+
import { KeymapLeaderTimeoutDefault, TuiInfo } from "./tui-schema"
1212
import { Flag } from "@opencode-ai/core/flag/flag"
1313
import { isRecord } from "@/util/record"
1414
import { Global } from "@opencode-ai/core/global"
@@ -26,7 +26,6 @@ import { Npm } from "@opencode-ai/core/npm"
2626
const log = Log.create({ service: "tui.config" })
2727

2828
export const Info = TuiInfo
29-
export const JsonSchemaInfo = TuiJsonSchemaInfo
3029
export type Info = z.output<typeof Info>
3130

3231
type Acc = {

0 commit comments

Comments
 (0)