mirror of https://github.com/NeuralNomadsAI/CodeNomad.git synced 2026-07-10 00:14:27 +00:00

Shantur Rathore cf88dc06ef

Package CodeNomad OpenCode plugin (#433 )

## Summary
- Rename the OpenCode config template into a versioned npm-packable
CodeNomad plugin package.
- Build and package the plugin through the server bundle, with
Electron/Tauri carrying it via existing server resources.
- Replace OPENCODE_CONFIG_DIR injection with JSONC-aware
OPENCODE_CONFIG_CONTENT merging that appends the CodeNomad plugin while
preserving user config.

## Validation
- npm run build --workspace @codenomad/codenomad-opencode-plugin
- npm run prepare-plugin --workspace @neuralnomads/codenomad
- npm run typecheck --workspace @neuralnomads/codenomad
- npm run typecheck --workspace @neuralnomads/codenomad-electron-app
- node --import tsx --test \"src/opencode-plugin.test.ts\"
\"src/workspaces/__tests__/spawn.test.ts\"

## Notes
- Production plugin loading uses an explicit npm file alias for the
packaged tarball.
- Dev loading still references the TypeScript plugin entry directly.

---------

Co-authored-by: Pascal André <pascalandr@gmail.com>

2026-05-12 09:00:22 +01:00

2 KiB

Raw Blame History

CodeNomad OpenCode Plugin

TLDR

Packaged OpenCode plugin injected into every OpenCode instance that CodeNomad launches. It provides the CodeNomad bridge for local event exchange between the CLI server and OpenCode.

What it is

An npm-packable plugin package. Production builds ship a local .tgz and inject it through OPENCODE_CONFIG_CONTENT; dev runs reference the TypeScript plugin entry directly with a file:// URL.

How it works

CodeNomad sets OPENCODE_CONFIG_CONTENT when spawning each OpenCode instance (packages/server/src/workspaces/manager.ts).
The server packs this package during build (packages/server/scripts/package-opencode-plugin.mjs).
OpenCode loads the plugin from plugin entries injected into the config content.
The CodeNomadPlugin reads CODENOMAD_INSTANCE_ID + CODENOMAD_BASE_URL, connects to GET /workspaces/:id/plugin/events, and posts to POST /workspaces/:id/plugin/event (packages/opencode-plugin/plugin/lib/client.ts).
The server exposes the plugin routes and maps events into the UI SSE pipeline (packages/server/src/server/routes/plugin.ts, packages/server/src/plugins/handlers.ts).

Expectations

Local-only bridge (no auth/token yet).
Plugin must fail startup if it cannot connect after 3 retries.
Keep plugin entrypoints thin; put shared logic under plugin/lib/ to avoid autoloaded helpers.
Keep event shapes small and explicit; use type + properties only.

Ideas

Add feature modules under plugin/lib/features/ (tool lifecycle, permission prompts, custom commands).
Expand /workspaces/:id/plugin/* with dedicated endpoints as needed.
Promote stable event shapes and version tags once the protocol settles.

Pointers

Plugin entry: packages/opencode-plugin/plugin/codenomad.ts
Plugin client: packages/opencode-plugin/plugin/lib/client.ts
Plugin server routes: packages/server/src/server/routes/plugin.ts
Plugin event handling: packages/server/src/plugins/handlers.ts
Workspace env injection: packages/server/src/workspaces/manager.ts

2 KiB Raw Blame History