Skip to content

docs: add plugin guideline requirements for dap plugins #3432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tonistiigi merged 1 commit into from
Sep 22, 2025
Merged

docs: add plugin guideline requirements for dap plugins #3432

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/dap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,17 @@ Please refer to the documentation in each of these repositories for installation

- [Visual Studio Code](https://github.com/docker/vscode-extension/)
- [Neovim](https://github.com/docker/nvim-dap-docker/)

### Plugin Integration Guidelines

An official debug adapter plugin must meet the requirements indicated in this section.

The plugin MUST support `args` as a launch argument. The `args` value must be an array and it MUST be passed at the end of the tool invocation.

The plugin MUST support `builder` as a launch argument. If present, `builder` will be passed as `--builder <value>` after the invocation of `buildx` but before the `build` argument.

The plugin MUST provide a way to run the DAP command through the `docker` command (i.e. `docker buildx`).

The plugin SHOULD provide a way to run the `buildx` binary in standalone mode.

The plugin SHOULD invoke the DAP command from the workspace root. If it cannot invoke the command from the workspace root for some reason, it MUST invoke it from the current working directory.