ZIm/docs/src/languages
Remco Smits 41a60ffecf
Debugger implementation (#13433)
###  DISCLAIMER

> As of 6th March 2025, debugger is still in development. We plan to
merge it behind a staff-only feature flag for staff use only, followed
by non-public release and then finally a public one (akin to how Git
panel release was handled). This is done to ensure the best experience
when it gets released.

### END OF DISCLAIMER 

**The current state of the debugger implementation:**


https://github.com/user-attachments/assets/c4deff07-80dd-4dc6-ad2e-0c252a478fe9


https://github.com/user-attachments/assets/e1ed2345-b750-4bb6-9c97-50961b76904f

----

All the todo's are in the following channel, so it's easier to work on
this together:
https://zed.dev/channel/zed-debugger-11370

If you are on Linux, you can use the following command to join the
channel:
```cli
zed https://zed.dev/channel/zed-debugger-11370 
```

## Current Features

- Collab
  - Breakpoints
    - Sync when you (re)join a project
    - Sync when you add/remove a breakpoint
  - Sync active debug line
  - Stack frames
    - Click on stack frame
      - View variables that belong to the stack frame
      - Visit the source file
    - Restart stack frame (if adapter supports this)
  - Variables
  - Loaded sources
  - Modules
  - Controls
    - Continue
    - Step back
      - Stepping granularity (configurable)
    - Step into
      - Stepping granularity (configurable)
    - Step over
      - Stepping granularity (configurable)
    - Step out
      - Stepping granularity (configurable)
  - Debug console
- Breakpoints
  - Log breakpoints
  - line breakpoints
  - Persistent between zed sessions (configurable)
  - Multi buffer support
  - Toggle disable/enable all breakpoints
- Stack frames
  - Click on stack frame
    - View variables that belong to the stack frame
    - Visit the source file
    - Show collapsed stack frames
  - Restart stack frame (if adapter supports this)
- Loaded sources
  - View all used loaded sources if supported by adapter.
- Modules
  - View all used modules (if adapter supports this)
- Variables
  - Copy value
  - Copy name
  - Copy memory reference
  - Set value (if adapter supports this)
  - keyboard navigation
- Debug Console
  - See logs
  - View output that was sent from debug adapter
    - Output grouping
  - Evaluate code
    - Updates the variable list
    - Auto completion
- If not supported by adapter, we will show auto-completion for existing
variables
- Debug Terminal
- Run custom commands and change env values right inside your Zed
terminal
- Attach to process (if adapter supports this)
  - Process picker
- Controls
  - Continue
  - Step back
    - Stepping granularity (configurable)
  - Step into
    - Stepping granularity (configurable)
  - Step over
    - Stepping granularity (configurable)
  - Step out
    - Stepping granularity (configurable)
  - Disconnect
  - Restart
  - Stop
- Warning when a debug session exited without hitting any breakpoint
- Debug view to see Adapter/RPC log messages
- Testing
  - Fake debug adapter
    - Fake requests & events

---

Release Notes:

- N/A

---------

Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
Co-authored-by: Anthony Eid <hello@anthonyeid.me>
Co-authored-by: Anthony <anthony@zed.dev>
Co-authored-by: Piotr Osiewicz <peterosiewicz@gmail.com>
Co-authored-by: Piotr <piotr@zed.dev>
2025-03-18 12:55:25 -04:00
..
ansible.md Fix typo in Ansible docs (#20267) 2024-11-05 16:31:39 -07:00
asciidoc.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
astro.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
bash.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
biome.md Docs Party 2024 (#15876) 2024-08-09 13:37:54 -04:00
c.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
clojure.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
cpp.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
csharp.md csharp: Extract to zed-extensions/csharp repository (#26166) 2025-03-05 22:23:49 +00:00
css.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
dart.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
deno.md deno: Extract to zed-extensions/deno repository (#26129) 2025-03-05 15:31:21 +00:00
diff.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
docker.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
elixir.md elixir: Extract to zed-extensions/elixir repository (#26167) 2025-03-05 22:50:35 +00:00
elm.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
emmet.md Docs Party 2024 (#15876) 2024-08-09 13:37:54 -04:00
erlang.md erlang: Extract to zed-extensions/erlang repository (#26248) 2025-03-06 22:53:13 +00:00
fish.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
gdscript.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
gleam.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
glsl.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
go.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
groovy.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
haskell.md haskell: Extract to zed-extensions/haskell repository (#26306) 2025-03-07 22:07:04 +00:00
helm.md docs: Add Helm extension docs (#19095) 2024-10-15 10:40:47 -04:00
html.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
java.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
javascript.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
json.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
jsonnet.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
julia.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
kotlin.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
lua.md lua: Extract to zed-extensions/lua repository (#26250) 2025-03-06 23:17:34 +00:00
luau.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
makefile.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
markdown.md Debugger implementation (#13433) 2025-03-18 12:55:25 -04:00
nim.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
ocaml.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
php.md docs: Use correct name for Intelephense license file (#26986) 2025-03-18 12:31:57 +00:00
prisma.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
proto.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
purescript.md purescript: Extract to zed-extensions/purescript repository (#26571) 2025-03-12 18:42:12 +00:00
python.md Initial PyLSP documentation (#26835) 2025-03-15 11:03:35 -04:00
r.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
racket.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
rego.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
roc.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
rst.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
ruby.md ruby: Document use_bundler configuration option (#22498) 2024-12-30 16:56:25 +00:00
rust.md docs: Update rust-analyzer doc links (#25521) 2025-02-25 00:27:41 +00:00
scala.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
scheme.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
sh.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
svelte.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
swift.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
tailwindcss.md docs: Remove empty Tree-sitter grammar link in the Tailwind docs (#25426) 2025-02-23 10:33:03 -05:00
terraform.md terraform: Extract to zed-extensions/terraform repository (#26475) 2025-03-11 19:10:51 +00:00
toml.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
typescript.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
uiua.md uiua: Extract to zed-extensions/uiua repository (#26587) 2025-03-12 19:55:37 +00:00
vue.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
xml.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
yaml.md docs: Fix casing of "Tree-sitter" (#25427) 2025-02-23 15:30:10 +00:00
yarn.md docs: Format docs (#15352) 2024-07-27 14:52:21 -04:00
zig.md zig: Extract to zed-extensions/zig repository (#26569) 2025-03-12 18:28:26 +00:00