Skip to content

Commit f34ec09

Browse files
author
Filip Kalný
committed
fix(config): refine custom config directory precedence
1 parent 76f20ea commit f34ec09

14 files changed

Lines changed: 239 additions & 57 deletions

File tree

‎packages/core/src/config.ts‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -169,10 +169,17 @@ export const layer = Layer.effect(
169169
]
170170
})
171171

172-
const globalDirectories = Array.from(new Set([global.config, ...global.extraConfigDirs])).map((directory) =>
173-
AbsolutePath.make(directory),
172+
const extraConfigDirs = Array.from(
173+
new Map(
174+
global.extraConfigDirs
175+
.filter((directory) => path.resolve(directory) !== path.resolve(global.config))
176+
.map((directory) => [path.resolve(directory), directory]),
177+
).values(),
178+
)
179+
const extraConfigDirSet = new Set(extraConfigDirs.map((directory) => path.resolve(directory)))
180+
const locationIsGlobal = [global.config, ...extraConfigDirs].some(
181+
(directory) => path.resolve(location.directory) === path.resolve(directory),
174182
)
175-
const locationIsGlobal = path.resolve(location.directory) === path.resolve(global.config)
176183
// Read configuration once when this location opens. Later calls reuse these
177184
// values until the location is reopened.
178185
const discovered = locationIsGlobal
@@ -186,6 +193,7 @@ export const layer = Layer.effect(
186193
.pipe(Effect.orDie)
187194
const projectDirectories = discovered
188195
.filter((item) => path.basename(item) === ".opencode")
196+
.filter((item) => !extraConfigDirSet.has(path.resolve(item)))
189197
.toReversed()
190198
.map((directory) => AbsolutePath.make(directory))
191199
// A config closer to the opened directory should win over one higher up.
@@ -195,11 +203,15 @@ export const layer = Layer.effect(
195203
Effect.orDie,
196204
Effect.map((configs) => configs.filter((config): config is Document => config !== undefined)),
197205
)
198-
const globalSupplementary = yield* Effect.forEach(globalDirectories, loadDirectory).pipe(Effect.orDie)
206+
const globalSupplementary = yield* loadDirectory(AbsolutePath.make(global.config)).pipe(Effect.orDie)
199207
const projectSupplementary = yield* Effect.forEach(projectDirectories, loadDirectory).pipe(Effect.orDie)
208+
const extraSupplementary = yield* Effect.forEach(
209+
extraConfigDirs.map((directory) => AbsolutePath.make(directory)),
210+
loadDirectory,
211+
).pipe(Effect.orDie)
200212
// Apply general settings first and more specific settings last:
201-
// global config, extra config dirs, project files, then `.opencode` files.
202-
const configs = [...globalSupplementary.flat(), ...direct, ...projectSupplementary.flat()]
213+
// global config, project files, `.opencode` files, then env-provided config directories.
214+
const configs = [...globalSupplementary, ...direct, ...projectSupplementary.flat(), ...extraSupplementary.flat()]
203215
// Rules use the opposite order so a user-global rule can override a
204216
// repository rule. Statement order inside each file stays unchanged.
205217
yield* policy.load(

‎packages/core/src/flag/flag.ts‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,17 @@ function enabledByExperimental(key: string) {
1414
}
1515

1616
function splitPathList(value: string | undefined) {
17-
return value?.split(path.delimiter).filter(Boolean) ?? []
17+
return (
18+
value
19+
?.split(path.delimiter)
20+
.map((item) => item.trim())
21+
.filter((item) => item.length > 0) ?? []
22+
)
23+
}
24+
25+
export function configDirectories() {
26+
const directory = process.env["OPENCODE_CONFIG_DIR"]?.trim()
27+
return [...splitPathList(process.env["OPENCODE_CONFIG_DIRS"]), ...(directory ? [directory] : [])]
1828
}
1929

2030
export const Flag = {
@@ -66,7 +76,8 @@ export const Flag = {
6676
return process.env["OPENCODE_TUI_CONFIG"]
6777
},
6878
get OPENCODE_CONFIG_DIR() {
69-
return process.env["OPENCODE_CONFIG_DIR"]
79+
const directory = process.env["OPENCODE_CONFIG_DIR"]?.trim()
80+
return directory || undefined
7081
},
7182
get OPENCODE_CONFIG_DIRS() {
7283
return splitPathList(process.env["OPENCODE_CONFIG_DIRS"])

‎packages/core/src/global.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { xdgData, xdgCache, xdgConfig, xdgState } from "xdg-basedir"
44
import os from "os"
55
import { Context, Effect, Layer } from "effect"
66
import { Flock } from "./util/flock"
7-
import { Flag } from "./flag/flag"
7+
import { configDirectories } from "./flag/flag"
88
import { LayerNode } from "./effect/layer-node"
99

1010
const app = "opencode"
@@ -64,7 +64,7 @@ export function make(input: Partial<Interface> = {}): Interface {
6464
data: Path.data,
6565
cache: Path.cache,
6666
config: Path.config,
67-
extraConfigDirs: [...(Flag.OPENCODE_CONFIG_DIR ? [Flag.OPENCODE_CONFIG_DIR] : []), ...Flag.OPENCODE_CONFIG_DIRS],
67+
extraConfigDirs: configDirectories(),
6868
state: Path.state,
6969
tmp: Path.tmp,
7070
bin: Path.bin,

‎packages/core/src/instruction-context.ts‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,19 @@ export const layer = Layer.effectDiscard(
5252
})
5353
).map(FSUtil.resolve),
5454
)
55-
const paths = Array.dedupe([FSUtil.resolve(join(global.config, "AGENTS.md")), ...discovered])
55+
const globalInstructionPaths = yield* Effect.forEach(
56+
[global.config, ...global.extraConfigDirs].toReversed(),
57+
(directory) =>
58+
Effect.gen(function* () {
59+
const filepath = FSUtil.resolve(join(directory, "AGENTS.md"))
60+
return (yield* fs.existsSafe(filepath)) ? filepath : undefined
61+
}),
62+
{ concurrency: "unbounded" },
63+
)
64+
const paths = Array.dedupe([
65+
...globalInstructionPaths.filter((path): path is string => path !== undefined).slice(0, 1),
66+
...discovered,
67+
])
5668
const files = yield* Effect.forEach(
5769
paths,
5870
(path) =>

‎packages/core/test/config/config.test.ts‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ describe("Config", () => {
772772
),
773773
)
774774

775-
it.live("loads extra config directories after global config and before project config", () =>
775+
it.live("loads custom config directories after project config with singular last", () =>
776776
Effect.acquireRelease(
777777
Effect.promise(() => tmpdir()),
778778
(tmp) => Effect.promise(() => tmp[Symbol.asyncDispose]()),
@@ -781,12 +781,14 @@ describe("Config", () => {
781781
const global = path.join(tmp.path, "global")
782782
const firstExtra = path.join(tmp.path, "extra-a")
783783
const secondExtra = path.join(tmp.path, "extra-b")
784+
const singularExtra = path.join(tmp.path, "extra-singular")
784785
const root = path.join(tmp.path, "repo")
785786
return Effect.gen(function* () {
786787
yield* Effect.promise(async () => {
787788
await fs.mkdir(global, { recursive: true })
788789
await fs.mkdir(firstExtra, { recursive: true })
789790
await fs.mkdir(secondExtra, { recursive: true })
791+
await fs.mkdir(singularExtra, { recursive: true })
790792
await fs.mkdir(path.join(root, ".opencode"), { recursive: true })
791793
await Promise.all([
792794
fs.writeFile(
@@ -801,6 +803,10 @@ describe("Config", () => {
801803
path.join(secondExtra, "opencode.json"),
802804
JSON.stringify({ $schema: "extra-b", model: "extra-b/model" }),
803805
),
806+
fs.writeFile(
807+
path.join(singularExtra, "opencode.json"),
808+
JSON.stringify({ $schema: "extra-singular", model: "extra-singular/model" }),
809+
),
804810
fs.writeFile(
805811
path.join(root, "opencode.json"),
806812
JSON.stringify({ $schema: "project", model: "project/model" }),
@@ -819,19 +825,21 @@ describe("Config", () => {
819825

820826
expect(entries.filter((entry) => entry.type === "directory").map((entry) => entry.path)).toEqual([
821827
AbsolutePath.make(global),
828+
AbsolutePath.make(path.join(root, ".opencode")),
822829
AbsolutePath.make(firstExtra),
823830
AbsolutePath.make(secondExtra),
824-
AbsolutePath.make(path.join(root, ".opencode")),
831+
AbsolutePath.make(singularExtra),
825832
])
826833
expect(documents.map((document) => document.info.$schema)).toEqual([
827834
"global",
828-
"extra-a",
829-
"extra-b",
830835
"project",
831836
"project-dot",
837+
"extra-a",
838+
"extra-b",
839+
"extra-singular",
832840
])
833-
expect(Config.latest(entries, "model")).toBe("project-dot/model")
834-
}).pipe(Effect.provide(testLayer(root, global, root, undefined, [firstExtra, secondExtra])))
841+
expect(Config.latest(entries, "model")).toBe("extra-singular/model")
842+
}).pipe(Effect.provide(testLayer(root, global, root, undefined, [firstExtra, secondExtra, singularExtra])))
835843
})
836844
}),
837845
),

‎packages/core/test/global.test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ describe("global paths", () => {
1717
test("config directory env vars add extra config directories", () => {
1818
const previousDir = process.env.OPENCODE_CONFIG_DIR
1919
const previousDirs = process.env.OPENCODE_CONFIG_DIRS
20-
process.env.OPENCODE_CONFIG_DIR = "/tmp/opencode-extra-config"
21-
process.env.OPENCODE_CONFIG_DIRS = ["/tmp/opencode-extra-a", "/tmp/opencode-extra-b"].join(path.delimiter)
20+
process.env.OPENCODE_CONFIG_DIR = " /tmp/opencode-extra-config "
21+
process.env.OPENCODE_CONFIG_DIRS = [" /tmp/opencode-extra-a ", "", "/tmp/opencode-extra-b"].join(path.delimiter)
2222
try {
2323
const global = Global.make()
2424

2525
expect(global.config).toBe(Global.Path.config)
2626
expect(global.extraConfigDirs).toEqual([
27-
"/tmp/opencode-extra-config",
2827
"/tmp/opencode-extra-a",
2928
"/tmp/opencode-extra-b",
29+
"/tmp/opencode-extra-config",
3030
])
3131
} finally {
3232
if (previousDir === undefined) delete process.env.OPENCODE_CONFIG_DIR

‎packages/core/test/instruction-context.test.ts‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,46 @@ describe("InstructionContext", () => {
9696
),
9797
)
9898

99+
it.live("uses highest-priority extra config directory AGENTS.md", () =>
100+
Effect.acquireRelease(
101+
Effect.promise(() => tmpdir()),
102+
(tmp) => Effect.promise(() => tmp[Symbol.asyncDispose]()),
103+
).pipe(
104+
Effect.flatMap((tmp) =>
105+
Effect.gen(function* () {
106+
const global = path.join(tmp.path, "global")
107+
const base = path.join(tmp.path, "base")
108+
const team = path.join(tmp.path, "team")
109+
yield* Effect.promise(async () => {
110+
await fs.mkdir(global, { recursive: true })
111+
await fs.mkdir(base, { recursive: true })
112+
await fs.mkdir(team, { recursive: true })
113+
await fs.writeFile(path.join(global, "AGENTS.md"), "global")
114+
await fs.writeFile(path.join(base, "AGENTS.md"), "base")
115+
await fs.writeFile(path.join(team, "AGENTS.md"), "team")
116+
})
117+
118+
const context = yield* SystemContextRegistry.Service.pipe(
119+
Effect.flatMap((service) => service.load()),
120+
Effect.provide(InstructionContext.layer.pipe(Layer.provideMerge(SystemContextRegistry.layer))),
121+
Effect.provide(FSUtil.defaultLayer),
122+
Effect.provide(Global.layerWith({ config: global, extraConfigDirs: [base, team] })),
123+
Effect.provide(
124+
Layer.succeed(
125+
Location.Service,
126+
Location.Service.of(location({ directory: AbsolutePath.make(tmp.path) })),
127+
),
128+
),
129+
)
130+
131+
expect((yield* SystemContext.initialize(context)).baseline).toBe(
132+
`Instructions from: ${path.join(team, "AGENTS.md")}\nteam`,
133+
)
134+
}),
135+
),
136+
),
137+
)
138+
99139
it.live("keeps an empty AGENTS.md as available context", () =>
100140
Effect.acquireRelease(
101141
Effect.promise(() => tmpdir()),

‎packages/opencode/src/config/config.ts‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -419,19 +419,17 @@ export const layer = Layer.effect(
419419

420420
const directories = yield* ConfigPaths.directories(ctx.directory, ctx.worktree)
421421

422-
const extraConfigDirs = new Set([
423-
...(Flag.OPENCODE_CONFIG_DIR ? [Flag.OPENCODE_CONFIG_DIR] : []),
424-
...Flag.OPENCODE_CONFIG_DIRS,
425-
])
422+
const extraConfigDirs = ConfigPaths.customDirectories()
423+
const extraConfigDirSet = new Set(extraConfigDirs)
426424

427-
if (extraConfigDirs.size) {
428-
yield* Effect.logDebug("loading config from extra config dirs", { paths: [...extraConfigDirs] })
425+
if (extraConfigDirs.length) {
426+
yield* Effect.logDebug("loading config from extra config dirs", { paths: extraConfigDirs })
429427
}
430428

431429
const deps: Fiber.Fiber<void>[] = []
432430

433431
for (const dir of directories) {
434-
if (dir.endsWith(".opencode") || extraConfigDirs.has(dir)) {
432+
if (dir.endsWith(".opencode") || extraConfigDirSet.has(dir)) {
435433
for (const file of ["opencode.json", "opencode.jsonc"]) {
436434
const source = path.join(dir, file)
437435
yield* Effect.logDebug(`loading config from ${source}`)

‎packages/opencode/src/config/paths.ts‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export * as ConfigPaths from "./paths"
22

33
import path from "path"
4-
import { Flag } from "@opencode-ai/core/flag/flag"
4+
import { Flag, configDirectories } from "@opencode-ai/core/flag/flag"
55
import { Global } from "@opencode-ai/core/global"
66
import { unique } from "remeda"
77
import * as Effect from "effect/Effect"
@@ -22,11 +22,9 @@ export const files = Effect.fn("ConfigPaths.projectFiles")(function* (
2222

2323
export const directories = Effect.fn("ConfigPaths.directories")(function* (directory: string, worktree?: string) {
2424
const afs = yield* FSUtil.Service
25-
const extraConfigDirs = [
26-
...(Flag.OPENCODE_CONFIG_DIR ? [Flag.OPENCODE_CONFIG_DIR] : []),
27-
...Flag.OPENCODE_CONFIG_DIRS,
28-
]
29-
return unique([
25+
const custom = customDirectories()
26+
const customSet = new Set(custom.map((dir) => path.resolve(dir)))
27+
const base = [
3028
Global.Path.config,
3129
...(!Flag.OPENCODE_DISABLE_PROJECT_CONFIG
3230
? yield* afs.up({
@@ -40,10 +38,18 @@ export const directories = Effect.fn("ConfigPaths.directories")(function* (direc
4038
start: Global.Path.home,
4139
stop: Global.Path.home,
4240
})),
43-
...extraConfigDirs,
44-
])
41+
].filter((dir) => !customSet.has(path.resolve(dir)))
42+
return unique([...base, ...custom])
4543
})
4644

4745
export function fileInDirectory(dir: string, name: string) {
4846
return [path.join(dir, `${name}.json`), path.join(dir, `${name}.jsonc`)]
4947
}
48+
49+
export function customDirectories() {
50+
return unique(configDirectories())
51+
}
52+
53+
export function isConfigDirectory(dir: string) {
54+
return dir.endsWith(".opencode") || customDirectories().some((custom) => path.resolve(custom) === path.resolve(dir))
55+
}

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -198,11 +198,7 @@ const loadState = Effect.fn("TuiConfig.loadState")(function* (ctx: { directory:
198198
// 4. `.opencode` directories (and extra config dirs) discovered while
199199
// walking up the tree. Also returned below so callers can install plugin
200200
// dependencies from each location.
201-
const extraConfigDirs = new Set([
202-
...(Flag.OPENCODE_CONFIG_DIR ? [Flag.OPENCODE_CONFIG_DIR] : []),
203-
...Flag.OPENCODE_CONFIG_DIRS,
204-
])
205-
const dirs = unique(directories).filter((dir) => dir.endsWith(".opencode") || extraConfigDirs.has(dir))
201+
const dirs = unique(directories).filter(ConfigPaths.isConfigDirectory)
206202

207203
for (const dir of dirs) {
208204
for (const file of ConfigPaths.fileInDirectory(dir, "tui")) {

0 commit comments

Comments
 (0)