opencode/packages/schema/script/config-schema.ts

import { Schema } from "effect"
import { Config } from "../src/config.js"

interface JsonSchema {
  readonly [key: string]: unknown
  readonly properties?: Readonly<Record<string, JsonSchema>>
}

// V1 and V2 read the same opencode.json, and V2 normalizes V1 fields at load time, so the published schema accepts
// both. The V2 shape is generated from Config.Info; V1 is frozen in config-v1.json, the last schema the V1 runtime
// published. Fields only V1 understands are marked deprecated.
export async function generate() {
  const legacy: { $defs: Record<string, JsonSchema> } = await Bun.file(
    new URL("./config-v1.json", import.meta.url),
  ).json()
  const { root: current, definitions } = document(Config.Info)
  const { Config: previous, ...legacyDefinitions } = legacy.$defs
  const shared = Object.keys(legacyDefinitions).filter((key) => key in definitions)
  if (shared.length) throw new Error(`V1 and V2 schema definitions share names: ${shared.join(", ")}`)

  return {
    $schema: "https://json-schema.org/draft/2020-12/schema",
    $id: "https://opencode.ai/config.json",
    type: "object",
    properties: merge(describe(current.properties ?? {}), previous.properties ?? {}),
    additionalProperties: false,
    $defs: { ...legacyDefinitions, ...definitions },
    allowComments: true,
    allowTrailingCommas: true,
  }
}

// Optional fields annotate their decoded side, which the encoded JSON Schema omits, so copy top-level descriptions
// from the type-side document.
function describe(properties: Readonly<Record<string, JsonSchema>>) {
  const type = document(Schema.toType(Config.Info)).root
  return Object.fromEntries(
    Object.entries(properties).map(([key, schema]) => [
      key,
      { ...schema, description: type.properties?.[key]?.description ?? schema.description },
    ]),
  )
}

// Classes generate a root reference to their definition; plain structs generate the object inline.
function document(schema: Schema.Top) {
  const result = Schema.toJsonSchemaDocument(schema, { onExcessProperty: "error" })
  const all = result.definitions as Record<string, JsonSchema>
  if (typeof result.schema.$ref !== "string") return { root: result.schema as JsonSchema, definitions: all }
  const { [result.schema.$ref.replace("#/$defs/", "")]: root, ...definitions } = all
  return { root, definitions }
}

function merge(current: Readonly<Record<string, JsonSchema>>, previous: Readonly<Record<string, JsonSchema>>) {
  return Object.fromEntries([
    ...Object.entries(current).map(([key, schema]) => [key, previous[key] ? combine(schema, previous[key]) : schema]),
    ...Object.entries(previous)
      .filter(([key]) => !current[key])
      .map(([key, schema]) => [key, { ...schema, deprecated: true }]),
  ])
}

// Shared keys keep the V2 shape. Shared objects also accept their V1 properties, and keys whose type changed accept
// either shape.
function combine(current: JsonSchema, previous: JsonSchema): JsonSchema {
  const description = current.description ?? previous.description
  if (current.type === "object" && previous.type === "object")
    return {
      ...current,
      description,
      properties: merge(current.properties ?? {}, previous.properties ?? {}),
      additionalProperties:
        typeof current.additionalProperties === "object" || typeof previous.additionalProperties !== "object"
          ? current.additionalProperties
          : { ...previous.additionalProperties, deprecated: true },
    }
  if (current.type !== undefined && previous.type !== undefined && current.type !== previous.type)
    return { description, anyOf: [current, { ...previous, deprecated: true }] }
  return { ...current, description }
}

if (import.meta.main) {
  const target = process.argv[2]
  if (!target) throw new Error("A schema output path is required")
  await Bun.write(target, JSON.stringify(await generate(), null, 2) + "\n")
}