Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .opencode/opencode.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
"$schema": "https://opencode.ai/config.json",
"provider": {},
"permission": {},
"references": {
// TODO: flip back to `references` once a release containing the v1 `reference` migration ships.
// The release pipeline runs the latest published opencode against this file, which only knows `reference`.
"reference": {
"effect": {
"repository": "github.com/Effect-TS/effect-smol",
"description": "Use for Effect v4 and effect-smol implementation details",
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/v1/config/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ export const Info = Schema.Struct({
references: Schema.optional(ConfigReference.Info).annotate({
description: "Named git or local directory references",
}),
reference: Schema.optional(ConfigReference.Info).annotate({
description: "@deprecated Use 'references' field instead. Named git or local directory references",
}),
watcher: Schema.optional(Schema.Struct({ ignore: Schema.optional(Schema.mutable(Schema.Array(Schema.String))) })),
snapshot: Schema.optional(Schema.Boolean).annotate({
description:
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/v1/config/migrate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const keys = new Set([
"logLevel",
"server",
"command",
"reference",
"snapshot",
"plugin",
"autoshare",
Expand Down Expand Up @@ -62,7 +63,7 @@ export function migrate(info: typeof ConfigV1.Info.Type) {
skills: info.skills && [...(info.skills.paths ?? []), ...(info.skills.urls ?? [])],
commands: info.command,
instructions: info.instructions,
references: info.references,
references: info.references ?? info.reference,
plugins: info.plugin?.map((plugin) =>
typeof plugin === "string" ? plugin : { package: plugin[0], options: plugin[1] },
),
Expand Down
38 changes: 38 additions & 0 deletions packages/core/test/config/config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ describe("Config", () => {
Effect.sync(() => {
expect(ConfigMigrateV1.isV1({ snapshot: false })).toBe(true)
expect(ConfigMigrateV1.isV1({ snapshot: false, agents: {} })).toBe(true)
expect(ConfigMigrateV1.isV1({ reference: {} })).toBe(true)
expect(ConfigMigrateV1.isV1({ shell: "/bin/zsh", model: "anthropic/claude" })).toBe(false)
expect(ConfigMigrateV1.isV1({ references: {} })).toBe(false)
}),
)

Expand Down Expand Up @@ -431,6 +433,42 @@ describe("Config", () => {
),
)

it.live("migrates the deprecated reference key into references", () =>
Effect.acquireRelease(
Effect.promise(() => tmpdir()),
(tmp) => Effect.promise(() => tmp[Symbol.asyncDispose]()),
).pipe(
Effect.flatMap((tmp) =>
Effect.gen(function* () {
yield* Effect.promise(() =>
fs.writeFile(
path.join(tmp.path, "opencode.json"),
JSON.stringify({
reference: {
local: { path: "../library" },
sdk: { repository: "github.com/example/sdk", branch: "main" },
shorthand: "github.com/example/docs",
},
}),
),
)

return yield* Effect.gen(function* () {
const config = yield* Config.Service
const documents = (yield* config.entries()).filter((entry) => entry.type === "document")

expect(documents).toHaveLength(1)
expect(documents[0]?.info.references).toEqual({
local: { path: "../library" },
sdk: { repository: "github.com/example/sdk", branch: "main" },
shorthand: "github.com/example/docs",
})
}).pipe(Effect.provide(testLayer(tmp.path)))
}),
),
),
)

it.live("migrates v1 configuration when a v1-only key is present", () =>
Effect.acquireRelease(
Effect.promise(() => tmpdir()),
Expand Down
20 changes: 20 additions & 0 deletions packages/opencode/test/config/config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,26 @@ it.instance("migrates mode field to agent field", () =>
}),
)

it.instance("accepts the deprecated reference field", () =>
Effect.gen(function* () {
const test = yield* TestInstance
yield* writeConfigEffect(test.directory, {
$schema: "https://opencode.ai/config.json",
reference: {
local: { path: "../library" },
sdk: { repository: "github.com/example/sdk", branch: "main" },
shorthand: "github.com/example/docs",
},
})
const config = yield* Config.use.get()
expect(config.reference).toEqual({
local: { path: "../library" },
sdk: { repository: "github.com/example/sdk", branch: "main" },
shorthand: "github.com/example/docs",
})
}),
)

it.instance("loads config from .opencode directory", () =>
Effect.gen(function* () {
const test = yield* TestInstance
Expand Down
3 changes: 3 additions & 0 deletions packages/sdk/js/src/v2/gen/types.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1931,6 +1931,9 @@ export type Config = {
references?: {
[key: string]: string | ConfigV2ReferenceGit | ConfigV2ReferenceLocal
}
reference?: {
[key: string]: string | ConfigV2ReferenceGit | ConfigV2ReferenceLocal
}
watcher?: {
ignore?: Array<string>
}
Expand Down
Loading