@vscode/debugprotocol

What is @vscode/debugprotocol?

@vscode/debugprotocol is a package that provides the Debug Adapter Protocol (DAP) used by Visual Studio Code and other IDEs to facilitate communication between the editor and a debugger. It defines a set of requests and events that allow for debugging operations such as setting breakpoints, stepping through code, and inspecting variables.

What are @vscode/debugprotocol's main functionalities?

Initialize Request

The initialize request is the first message sent from the client to the debug adapter. It is used to configure the debug session and exchange capabilities. The code sample shows how to send an initialize request with various configuration options.

{ "command": "initialize", "arguments": { "clientID": "vscode", "clientName": "Visual Studio Code", "adapterID": "node", "pathFormat": "path", "linesStartAt1": true, "columnsStartAt1": true, "supportsVariableType": true, "supportsVariablePaging": true, "supportsRunInTerminalRequest": true } }

Set Breakpoints Request

The setBreakpoints request allows the client to set breakpoints in the source code. The code sample demonstrates how to specify breakpoints at specific lines in a given file.

{ "command": "setBreakpoints", "arguments": { "source": { "path": "/path/to/file.js" }, "breakpoints": [ { "line": 10 }, { "line": 20 } ] } }

Stack Trace Request

The stackTrace request retrieves the call stack for a given thread. This is useful for understanding the current execution context. The code sample shows how to request the stack trace for a specific thread.

{ "command": "stackTrace", "arguments": { "threadId": 1 } }

Other packages similar to @vscode/debugprotocol

vscode-debugadapter

vscode-debugadapter is a package that provides a base implementation for building debug adapters that communicate using the Debug Adapter Protocol. It is similar to @vscode/debugprotocol but focuses on providing a framework for implementing the server side of the protocol.

node-inspect

node-inspect is a command-line debugger for Node.js programs. It provides similar debugging capabilities but is specific to Node.js and does not use the Debug Adapter Protocol. It is more of a standalone tool compared to the protocol-focused @vscode/debugprotocol.

chrome-debug-protocol

chrome-debug-protocol is a package that implements the Chrome DevTools Protocol, which is used for debugging web applications in Chrome. While it serves a similar purpose of enabling debugging, it is specific to web applications and the Chrome browser, unlike the more general-purpose @vscode/debugprotocol.

README

VS Code Debug Protocol

This npm module contains declarations for the json-based Visual Studio Code debug protocol.

History

As of August 2018 the change history of the Debug Adapter Protocol lives on the Debug Adapter Protocol web site.

License

MIT