# docker/vscode-extension architecture

> Architecture diagram of the GitHub repository docker/vscode-extension, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/docker/vscode-extension
- Repository: https://github.com/docker/vscode-extension

## Overview

Docker DX is a Visual Studio Code extension for Docker authoring, build diagnostics, vulnerability warnings, and Dockerfile build debugging. The main workflow starts when the extension activates: it connects a language client to a Docker language server, which provides editing intelligence and diagnostics in the editor. Separate paths support Buildx debugging and Docker Engine availability prompts; telemetry is collected and published independently. The README documents Compose and Bake features, but their implementation is not sampled, so those capabilities are represented at the language-server boundary. Arrows reflect shown calls or documented behavior; unsampled internals are not inferred.

Main entry points: [`src/extension.ts`](https://github.com/docker/vscode-extension/blob/main/src/extension.ts) (Extension activation), [`src/utils/monitor.ts`](https://github.com/docker/vscode-extension/blob/main/src/utils/monitor.ts) (Engine availability check), [`src/utils/lsp/languageClient.ts`](https://github.com/docker/vscode-extension/blob/main/src/utils/lsp/languageClient.ts) (Docker language client), [`src/utils/spawnDockerCommand.ts`](https://github.com/docker/vscode-extension/blob/main/src/utils/spawnDockerCommand.ts) (Docker command runner)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_extension["Extension runtime"]
  node_activation["Extension activation<br/>[extension.ts]"]
  node_editor["Editor decorations<br/>[editor.ts]"]
end

subgraph group_language["Language features"]
  node_language_client_setup["Language client setup<br/>[lsp.ts]"]
  node_language_client["Docker language client<br/>[languageClient.ts]"]
  node_language_server["Docker language server"]
  node_dockerfile_editing["Dockerfile editing"]
  node_compose_editing["Compose editing"]
  node_bake_editing["Bake editing"]
  node_vulnerability_scanning["Image vulnerability scanning"]
end

subgraph group_debug["Build debugging"]
  node_debug_setup["Debug configuration<br/>[config.ts]"]
  node_buildx_debug["Buildx DAP"]
end

subgraph group_runtime["Docker availability"]
  node_docker_cli["Docker CLI"]
  node_engine_monitor["Engine availability check<br/>[monitor.ts]"]
  node_docker_command["Docker command runner"]
  node_desktop_detection["Desktop detection<br/>[os.ts]"]
  node_availability_prompts["Availability prompts<br/>[prompt.ts]"]
  node_settings["Extension settings<br/>[settings.ts]"]
end

subgraph group_observability["Telemetry"]
  node_telemetry_client["Telemetry client<br/>[client.ts]"]
  node_telemetry_filter["Telemetry redaction<br/>[filter.ts]"]
  node_telemetry_service["Telemetry service"]
end

node_vscode(("VS Code user"))

node_vscode -->|"activates"| node_activation
node_activation -->|"starts"| node_language_client_setup
node_language_client_setup -->|"constructs"| node_language_client
node_language_client -->|"connects to"| node_language_server
node_language_server -->|"provides"| node_dockerfile_editing
node_language_server -->|"provides"| node_compose_editing
node_language_server -->|"provides"| node_bake_editing
node_language_server -->|"flags images"| node_vulnerability_scanning
node_dockerfile_editing -->|"shows diagnostics"| node_vscode
node_activation -->|"hooks"| node_editor
node_activation -->|"registers"| node_debug_setup
node_debug_setup -->|"launches"| node_buildx_debug
node_buildx_debug -->|"runs Buildx DAP"| node_docker_cli
node_activation -->|"checks engine"| node_engine_monitor
node_engine_monitor -->|"reads"| node_settings
node_engine_monitor -->|"runs status check"| node_docker_command
node_docker_command -->|"spawns"| node_docker_cli
node_engine_monitor -->|"checks installation"| node_desktop_detection
node_engine_monitor -->|"prompts user"| node_availability_prompts
node_docker_command -->|"prompts on error"| node_availability_prompts
node_availability_prompts -->|"updates preference"| node_settings
node_activation -->|"publishes"| node_telemetry_client
node_language_client -->|"reports errors"| node_telemetry_client
node_activation -->|"redacts errors"| node_telemetry_filter
node_telemetry_client -->|"posts events"| node_telemetry_service

click node_activation "https://github.com/docker/vscode-extension/blob/main/src/extension.ts"
click node_editor "https://github.com/docker/vscode-extension/blob/main/src/utils/editor.ts"
click node_language_client_setup "https://github.com/docker/vscode-extension/blob/main/src/utils/lsp/lsp.ts"
click node_language_client "https://github.com/docker/vscode-extension/blob/main/src/utils/lsp/languageClient.ts"
click node_debug_setup "https://github.com/docker/vscode-extension/blob/main/src/dap/config.ts"
click node_engine_monitor "https://github.com/docker/vscode-extension/blob/main/src/utils/monitor.ts"
click node_docker_command "https://github.com/docker/vscode-extension/blob/main/src/utils/spawnDockerCommand.ts"
click node_desktop_detection "https://github.com/docker/vscode-extension/blob/main/src/utils/os.ts"
click node_availability_prompts "https://github.com/docker/vscode-extension/blob/main/src/utils/prompt.ts"
click node_settings "https://github.com/docker/vscode-extension/blob/main/src/utils/settings.ts"
click node_telemetry_client "https://github.com/docker/vscode-extension/blob/main/src/telemetry/client.ts"
click node_telemetry_filter "https://github.com/docker/vscode-extension/blob/main/src/telemetry/filter.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_activation,node_editor,node_vscode toneBlue
class node_language_client_setup,node_language_client,node_language_server,node_dockerfile_editing,node_compose_editing,node_bake_editing,node_vulnerability_scanning toneAmber
class node_debug_setup,node_buildx_debug toneMint
class node_docker_cli,node_engine_monitor,node_docker_command,node_desktop_detection,node_availability_prompts,node_settings toneRose
class node_telemetry_client,node_telemetry_filter,node_telemetry_service toneIndigo
```

## Components

### Extension runtime

- [Extension activation](https://github.com/docker/vscode-extension/blob/main/src/extension.ts): `src/extension.ts`
- [Editor decorations](https://github.com/docker/vscode-extension/blob/main/src/utils/editor.ts): `src/utils/editor.ts`

### Language features

- [Language client setup](https://github.com/docker/vscode-extension/blob/main/src/utils/lsp/lsp.ts): `src/utils/lsp/lsp.ts`
- [Docker language client](https://github.com/docker/vscode-extension/blob/main/src/utils/lsp/languageClient.ts): `src/utils/lsp/languageClient.ts`
- **Docker language server**
- **Dockerfile editing**
- **Compose editing**
- **Bake editing**
- **Image vulnerability scanning**

### Build debugging

- [Debug configuration](https://github.com/docker/vscode-extension/blob/main/src/dap/config.ts): `src/dap/config.ts`
- **Buildx DAP**

### Docker availability

- **Docker CLI**
- [Engine availability check](https://github.com/docker/vscode-extension/blob/main/src/utils/monitor.ts): `src/utils/monitor.ts`
- [Docker command runner](https://github.com/docker/vscode-extension/blob/main/src/utils/spawnDockerCommand.ts): `src/utils/spawnDockerCommand.ts`
- [Desktop detection](https://github.com/docker/vscode-extension/blob/main/src/utils/os.ts): `src/utils/os.ts`
- [Availability prompts](https://github.com/docker/vscode-extension/blob/main/src/utils/prompt.ts): `src/utils/prompt.ts`
- [Extension settings](https://github.com/docker/vscode-extension/blob/main/src/utils/settings.ts): `src/utils/settings.ts`

### Telemetry

- [Telemetry client](https://github.com/docker/vscode-extension/blob/main/src/telemetry/client.ts): `src/telemetry/client.ts`
- [Telemetry redaction](https://github.com/docker/vscode-extension/blob/main/src/telemetry/filter.ts): `src/telemetry/filter.ts`
- **Telemetry service**

### Other components

- **VS Code user**

## Connections

- VS Code user → Extension activation: activates (evidence: `src/extension.ts`)
- Extension activation → Language client setup: starts (evidence: `src/extension.ts`)
- Language client setup → Docker language client: constructs (evidence: `src/utils/lsp/lsp.ts`)
- Docker language client → Docker language server: connects to (evidence: `src/utils/lsp/languageClient.ts`)
- Docker language server → Dockerfile editing: provides (evidence: `README.md`)
- Docker language server → Compose editing: provides (evidence: `README.md`)
- Docker language server → Bake editing: provides (evidence: `README.md`)
- Docker language server → Image vulnerability scanning: flags images (evidence: `README.md`)
- Dockerfile editing → VS Code user: shows diagnostics (evidence: `README.md`)
- Extension activation → Editor decorations: hooks (evidence: `src/extension.ts`)
- Extension activation → Debug configuration: registers (evidence: `src/extension.ts`)
- Debug configuration → Buildx DAP: launches (evidence: `src/dap/config.ts`)
- Buildx DAP → Docker CLI: runs Buildx DAP
- Extension activation → Engine availability check: checks engine (evidence: `src/extension.ts`)
- Engine availability check → Extension settings: reads (evidence: `src/utils/monitor.ts`)
- Engine availability check → Docker command runner: runs status check (evidence: `src/utils/monitor.ts`)
- Docker command runner → Docker CLI: spawns (evidence: `src/utils/spawnDockerCommand.ts`)
- Engine availability check → Desktop detection: checks installation (evidence: `src/utils/monitor.ts`)
- Engine availability check → Availability prompts: prompts user (evidence: `src/utils/monitor.ts`)
- Docker command runner → Availability prompts: prompts on error (evidence: `src/utils/spawnDockerCommand.ts`)
- Availability prompts → Extension settings: updates preference (evidence: `src/utils/prompt.ts`)
- Extension activation → Telemetry client: publishes (evidence: `src/extension.ts`)
- Docker language client → Telemetry client: reports errors (evidence: `src/utils/lsp/languageClient.ts`)
- Extension activation → Telemetry redaction: redacts errors (evidence: `src/extension.ts`)
- Telemetry client → Telemetry service: posts events (evidence: `src/telemetry/client.ts`)
