From 7d61b32dab99d410fe41178859871d7d9244dacf Mon Sep 17 00:00:00 2001 From: ops Date: Wed, 24 Dec 2025 05:12:46 +0100 Subject: [PATCH] docs: add infos about server debugging --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c16d664a275..52d342709d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,12 +53,12 @@ your debugger via that URL. Other methods can result in breakpoints being mapped Caveats: -- `*.tsx` files won't have their breakpoints correctly mapped. This seems due to Bun currently not supporting source maps on code transformed - via `BunPlugin`s (currently necessary due to our dependency on `@opentui/solid`). Currently, the best you can do in terms of debugging `*.tsx` - files is writing a `debugger;` statement. Debugging facilities like stepping won't work, but at least you will be informed if a specific code - is triggered. - If you want to run the OpenCode TUI and have breakpoints triggered in the server code, you might need to run `bun dev spawn` instead of the usual `bun dev`. This is because `bun dev` runs the server in a worker thread and breakpoints might not work there. +- If `spawn` does not work for you, you can debug the server separately: + - Debug server: `bun run --inspect=ws://localhost:6499/ ./src/index.ts serve --port 4096`, + then attach TUI with `opencode attach http://localhost:4096` + - Debug TUI: `bun run --inspect=ws://localhost:6499/ --conditions=browser ./src/index.ts` Other tips and tricks: