refactor: major codebase cleanup - BDD comments, file splitting, bug fixes (#1350)
* style(tests): normalize BDD comments from '// #given' to '// given'
- Replace 4,668 Python-style BDD comments across 107 test files
- Patterns changed: // #given -> // given, // #when -> // when, // #then -> // then
- Also handles no-space variants: //#given -> // given
* fix(rules-injector): prefer output.metadata.filePath over output.title
- Extract file path resolution to dedicated output-path.ts module
- Prefer metadata.filePath which contains actual file path
- Fall back to output.title only when metadata unavailable
- Fixes issue where rules weren't injected when tool output title was a label
* feat(slashcommand): add optional user_message parameter
- Add user_message optional parameter for command arguments
- Model can now call: command='publish' user_message='patch'
- Improves error messages with clearer format guidance
- Helps LLMs understand correct parameter usage
* feat(hooks): restore compaction-context-injector hook
- Restore hook deleted in cbbc7bd0 for session compaction context
- Injects 7 mandatory sections: User Requests, Final Goal, Work Completed,
Remaining Tasks, Active Working Context, MUST NOT Do, Agent Verification State
- Re-register in hooks/index.ts and main plugin entry
* refactor(background-agent): split manager.ts into focused modules
- Extract constants.ts for TTL values and internal types (52 lines)
- Extract state.ts for TaskStateManager class (204 lines)
- Extract spawner.ts for task creation logic (244 lines)
- Extract result-handler.ts for completion handling (265 lines)
- Reduce manager.ts from 1377 to 755 lines (45% reduction)
- Maintain backward compatible exports
* refactor(agents): split prometheus-prompt.ts into subdirectory
- Move 1196-line prometheus-prompt.ts to prometheus/ subdirectory
- Organize prompt sections into separate files for maintainability
- Update agents/index.ts exports
* refactor(delegate-task): split tools.ts into focused modules
- Extract categories.ts for category definitions and routing
- Extract executor.ts for task execution logic
- Extract helpers.ts for utility functions
- Extract prompt-builder.ts for prompt construction
- Reduce tools.ts complexity with cleaner separation of concerns
* refactor(builtin-skills): split skills.ts into individual skill files
- Move each skill to dedicated file in skills/ subdirectory
- Create barrel export for backward compatibility
- Improve maintainability with focused skill modules
* chore: update import paths and lockfile
- Update prometheus import path after refactor
- Update bun.lock
* fix(tests): complete BDD comment normalization
- Fix remaining #when/#then patterns missed by initial sed
- Affected: state.test.ts, events.test.ts
---------
Co-authored-by: justsisyphus <justsisyphus@users.noreply.github.com>
This commit is contained in:
@@ -37,78 +37,78 @@ describe("opencode-config-dir", () => {
|
||||
|
||||
describe("OPENCODE_CONFIG_DIR environment variable", () => {
|
||||
test("returns OPENCODE_CONFIG_DIR when env var is set", () => {
|
||||
// #given OPENCODE_CONFIG_DIR is set to a custom path
|
||||
// given OPENCODE_CONFIG_DIR is set to a custom path
|
||||
process.env.OPENCODE_CONFIG_DIR = "/custom/opencode/path"
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns the custom path
|
||||
// then returns the custom path
|
||||
expect(result).toBe("/custom/opencode/path")
|
||||
})
|
||||
|
||||
test("falls back to default when env var is not set", () => {
|
||||
// #given OPENCODE_CONFIG_DIR is not set, platform is Linux
|
||||
// given OPENCODE_CONFIG_DIR is not set, platform is Linux
|
||||
delete process.env.OPENCODE_CONFIG_DIR
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns default ~/.config/opencode
|
||||
// then returns default ~/.config/opencode
|
||||
expect(result).toBe(join(homedir(), ".config", "opencode"))
|
||||
})
|
||||
|
||||
test("falls back to default when env var is empty string", () => {
|
||||
// #given OPENCODE_CONFIG_DIR is set to empty string
|
||||
// given OPENCODE_CONFIG_DIR is set to empty string
|
||||
process.env.OPENCODE_CONFIG_DIR = ""
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns default ~/.config/opencode
|
||||
// then returns default ~/.config/opencode
|
||||
expect(result).toBe(join(homedir(), ".config", "opencode"))
|
||||
})
|
||||
|
||||
test("falls back to default when env var is whitespace only", () => {
|
||||
// #given OPENCODE_CONFIG_DIR is set to whitespace only
|
||||
// given OPENCODE_CONFIG_DIR is set to whitespace only
|
||||
process.env.OPENCODE_CONFIG_DIR = " "
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns default ~/.config/opencode
|
||||
// then returns default ~/.config/opencode
|
||||
expect(result).toBe(join(homedir(), ".config", "opencode"))
|
||||
})
|
||||
|
||||
test("resolves relative path to absolute path", () => {
|
||||
// #given OPENCODE_CONFIG_DIR is set to a relative path
|
||||
// given OPENCODE_CONFIG_DIR is set to a relative path
|
||||
process.env.OPENCODE_CONFIG_DIR = "./my-opencode-config"
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns resolved absolute path
|
||||
// then returns resolved absolute path
|
||||
expect(result).toBe(resolve("./my-opencode-config"))
|
||||
})
|
||||
|
||||
test("OPENCODE_CONFIG_DIR takes priority over XDG_CONFIG_HOME", () => {
|
||||
// #given both OPENCODE_CONFIG_DIR and XDG_CONFIG_HOME are set
|
||||
// given both OPENCODE_CONFIG_DIR and XDG_CONFIG_HOME are set
|
||||
process.env.OPENCODE_CONFIG_DIR = "/custom/opencode/path"
|
||||
process.env.XDG_CONFIG_HOME = "/xdg/config"
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then OPENCODE_CONFIG_DIR takes priority
|
||||
// then OPENCODE_CONFIG_DIR takes priority
|
||||
expect(result).toBe("/custom/opencode/path")
|
||||
})
|
||||
})
|
||||
@@ -141,116 +141,116 @@ describe("opencode-config-dir", () => {
|
||||
describe("getOpenCodeConfigDir", () => {
|
||||
describe("for opencode CLI binary", () => {
|
||||
test("returns ~/.config/opencode on Linux", () => {
|
||||
// #given opencode CLI binary detected, platform is Linux
|
||||
// given opencode CLI binary detected, platform is Linux
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
delete process.env.OPENCODE_CONFIG_DIR
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns ~/.config/opencode
|
||||
// then returns ~/.config/opencode
|
||||
expect(result).toBe(join(homedir(), ".config", "opencode"))
|
||||
})
|
||||
|
||||
test("returns $XDG_CONFIG_HOME/opencode on Linux when XDG_CONFIG_HOME is set", () => {
|
||||
// #given opencode CLI binary detected, platform is Linux with XDG_CONFIG_HOME set
|
||||
// given opencode CLI binary detected, platform is Linux with XDG_CONFIG_HOME set
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
process.env.XDG_CONFIG_HOME = "/custom/config"
|
||||
delete process.env.OPENCODE_CONFIG_DIR
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns $XDG_CONFIG_HOME/opencode
|
||||
// then returns $XDG_CONFIG_HOME/opencode
|
||||
expect(result).toBe("/custom/config/opencode")
|
||||
})
|
||||
|
||||
test("returns ~/.config/opencode on macOS", () => {
|
||||
// #given opencode CLI binary detected, platform is macOS
|
||||
// given opencode CLI binary detected, platform is macOS
|
||||
Object.defineProperty(process, "platform", { value: "darwin" })
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
delete process.env.OPENCODE_CONFIG_DIR
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns ~/.config/opencode
|
||||
// then returns ~/.config/opencode
|
||||
expect(result).toBe(join(homedir(), ".config", "opencode"))
|
||||
})
|
||||
|
||||
test("returns ~/.config/opencode on Windows by default", () => {
|
||||
// #given opencode CLI binary detected, platform is Windows
|
||||
// given opencode CLI binary detected, platform is Windows
|
||||
Object.defineProperty(process, "platform", { value: "win32" })
|
||||
delete process.env.APPDATA
|
||||
delete process.env.OPENCODE_CONFIG_DIR
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode", version: "1.0.200", checkExisting: false })
|
||||
|
||||
// #then returns ~/.config/opencode (cross-platform default)
|
||||
// then returns ~/.config/opencode (cross-platform default)
|
||||
expect(result).toBe(join(homedir(), ".config", "opencode"))
|
||||
})
|
||||
})
|
||||
|
||||
describe("for opencode-desktop Tauri binary", () => {
|
||||
test("returns ~/.config/ai.opencode.desktop on Linux", () => {
|
||||
// #given opencode-desktop binary detected, platform is Linux
|
||||
// given opencode-desktop binary detected, platform is Linux
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode-desktop"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode-desktop"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode-desktop", version: "1.0.200", checkExisting: false })
|
||||
|
||||
// #then returns ~/.config/ai.opencode.desktop
|
||||
// then returns ~/.config/ai.opencode.desktop
|
||||
expect(result).toBe(join(homedir(), ".config", TAURI_APP_IDENTIFIER))
|
||||
})
|
||||
|
||||
test("returns ~/Library/Application Support/ai.opencode.desktop on macOS", () => {
|
||||
// #given opencode-desktop binary detected, platform is macOS
|
||||
// given opencode-desktop binary detected, platform is macOS
|
||||
Object.defineProperty(process, "platform", { value: "darwin" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode-desktop"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode-desktop"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode-desktop", version: "1.0.200", checkExisting: false })
|
||||
|
||||
// #then returns ~/Library/Application Support/ai.opencode.desktop
|
||||
// then returns ~/Library/Application Support/ai.opencode.desktop
|
||||
expect(result).toBe(join(homedir(), "Library", "Application Support", TAURI_APP_IDENTIFIER))
|
||||
})
|
||||
|
||||
test("returns %APPDATA%/ai.opencode.desktop on Windows", () => {
|
||||
// #given opencode-desktop binary detected, platform is Windows
|
||||
// given opencode-desktop binary detected, platform is Windows
|
||||
Object.defineProperty(process, "platform", { value: "win32" })
|
||||
process.env.APPDATA = "C:\\Users\\TestUser\\AppData\\Roaming"
|
||||
|
||||
// #when getOpenCodeConfigDir is called with binary="opencode-desktop"
|
||||
// when getOpenCodeConfigDir is called with binary="opencode-desktop"
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode-desktop", version: "1.0.200", checkExisting: false })
|
||||
|
||||
// #then returns %APPDATA%/ai.opencode.desktop
|
||||
// then returns %APPDATA%/ai.opencode.desktop
|
||||
expect(result).toBe(join("C:\\Users\\TestUser\\AppData\\Roaming", TAURI_APP_IDENTIFIER))
|
||||
})
|
||||
})
|
||||
|
||||
describe("dev build detection", () => {
|
||||
test("returns ai.opencode.desktop.dev path when dev version detected", () => {
|
||||
// #given opencode-desktop dev version
|
||||
// given opencode-desktop dev version
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
|
||||
// #when getOpenCodeConfigDir is called with dev version
|
||||
// when getOpenCodeConfigDir is called with dev version
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode-desktop", version: "1.0.0-dev.123", checkExisting: false })
|
||||
|
||||
// #then returns path with ai.opencode.desktop.dev
|
||||
// then returns path with ai.opencode.desktop.dev
|
||||
expect(result).toBe(join(homedir(), ".config", TAURI_APP_IDENTIFIER_DEV))
|
||||
})
|
||||
|
||||
test("returns ai.opencode.desktop.dev on macOS for dev build", () => {
|
||||
// #given opencode-desktop dev version on macOS
|
||||
// given opencode-desktop dev version on macOS
|
||||
Object.defineProperty(process, "platform", { value: "darwin" })
|
||||
|
||||
// #when getOpenCodeConfigDir is called with dev version
|
||||
// when getOpenCodeConfigDir is called with dev version
|
||||
const result = getOpenCodeConfigDir({ binary: "opencode-desktop", version: "1.0.0-dev", checkExisting: false })
|
||||
|
||||
// #then returns path with ai.opencode.desktop.dev
|
||||
// then returns path with ai.opencode.desktop.dev
|
||||
expect(result).toBe(join(homedir(), "Library", "Application Support", TAURI_APP_IDENTIFIER_DEV))
|
||||
})
|
||||
})
|
||||
@@ -258,15 +258,15 @@ describe("opencode-config-dir", () => {
|
||||
|
||||
describe("getOpenCodeConfigPaths", () => {
|
||||
test("returns all config paths for CLI binary", () => {
|
||||
// #given opencode CLI binary on Linux
|
||||
// given opencode CLI binary on Linux
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
delete process.env.OPENCODE_CONFIG_DIR
|
||||
|
||||
// #when getOpenCodeConfigPaths is called
|
||||
// when getOpenCodeConfigPaths is called
|
||||
const paths = getOpenCodeConfigPaths({ binary: "opencode", version: "1.0.200" })
|
||||
|
||||
// #then returns all expected paths
|
||||
// then returns all expected paths
|
||||
const expectedDir = join(homedir(), ".config", "opencode")
|
||||
expect(paths.configDir).toBe(expectedDir)
|
||||
expect(paths.configJson).toBe(join(expectedDir, "opencode.json"))
|
||||
@@ -276,13 +276,13 @@ describe("opencode-config-dir", () => {
|
||||
})
|
||||
|
||||
test("returns all config paths for desktop binary", () => {
|
||||
// #given opencode-desktop binary on macOS
|
||||
// given opencode-desktop binary on macOS
|
||||
Object.defineProperty(process, "platform", { value: "darwin" })
|
||||
|
||||
// #when getOpenCodeConfigPaths is called
|
||||
// when getOpenCodeConfigPaths is called
|
||||
const paths = getOpenCodeConfigPaths({ binary: "opencode-desktop", version: "1.0.200", checkExisting: false })
|
||||
|
||||
// #then returns all expected paths
|
||||
// then returns all expected paths
|
||||
const expectedDir = join(homedir(), "Library", "Application Support", TAURI_APP_IDENTIFIER)
|
||||
expect(paths.configDir).toBe(expectedDir)
|
||||
expect(paths.configJson).toBe(join(expectedDir, "opencode.json"))
|
||||
@@ -294,28 +294,28 @@ describe("opencode-config-dir", () => {
|
||||
|
||||
describe("detectExistingConfigDir", () => {
|
||||
test("returns null when no config exists", () => {
|
||||
// #given no config files exist
|
||||
// given no config files exist
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
delete process.env.OPENCODE_CONFIG_DIR
|
||||
|
||||
// #when detectExistingConfigDir is called
|
||||
// when detectExistingConfigDir is called
|
||||
const result = detectExistingConfigDir("opencode", "1.0.200")
|
||||
|
||||
// #then result is either null or a valid string path
|
||||
// then result is either null or a valid string path
|
||||
expect(result === null || typeof result === "string").toBe(true)
|
||||
})
|
||||
|
||||
test("includes OPENCODE_CONFIG_DIR in search locations when set", () => {
|
||||
// #given OPENCODE_CONFIG_DIR is set to a custom path
|
||||
// given OPENCODE_CONFIG_DIR is set to a custom path
|
||||
process.env.OPENCODE_CONFIG_DIR = "/custom/opencode/path"
|
||||
Object.defineProperty(process, "platform", { value: "linux" })
|
||||
delete process.env.XDG_CONFIG_HOME
|
||||
|
||||
// #when detectExistingConfigDir is called
|
||||
// when detectExistingConfigDir is called
|
||||
const result = detectExistingConfigDir("opencode", "1.0.200")
|
||||
|
||||
// #then result is either null (no config file exists) or a valid string path
|
||||
// then result is either null (no config file exists) or a valid string path
|
||||
// The important thing is that the function doesn't throw
|
||||
expect(result === null || typeof result === "string").toBe(true)
|
||||
})
|
||||
|
||||
Reference in New Issue
Block a user