Skip to content

Commit 39feed4

Browse files
committed
docs: add plugin guideline requirements for dap plugins
Signed-off-by: Jonathan A. Sternberg <jonathan.sternberg@docker.com>
1 parent bc8ede2 commit 39feed4

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/dap.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,17 @@ Please refer to the documentation in each of these repositories for installation
6161

6262
- [Visual Studio Code](https://github.com/docker/vscode-extension/)
6363
- [Neovim](https://github.com/docker/nvim-dap-docker/)
64+
65+
### Plugin Integration Guidelines
66+
67+
An official debug adapter plugin must meet the requirements indicated in this section.
68+
69+
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.
70+
71+
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.
72+
73+
The plugin MUST provide a way to run the DAP command through the `docker` command (i.e. `docker buildx`).
74+
75+
The plugin SHOULD provide a way to run the `buildx` binary in standalone mode.
76+
77+
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.

0 commit comments

Comments
 (0)