https://github.com/microsoft/vscode-mock-debug

Starter sample for developing debug adapters for VSCode.
https://github.com/microsoft/vscode-mock-debug

Last synced: 3 months ago
JSON representation

Starter sample for developing debug adapters for VSCode.

• Host: GitHub
• URL: https://github.com/microsoft/vscode-mock-debug
• Owner: microsoft
• License: other
• Created: 2015-10-07T09:21:19.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-03-18T11:47:06.000Z (3 months ago)
• Last Synced: 2024-03-18T13:03:00.681Z (3 months ago)
• Language: TypeScript
• Size: 1.07 MB
• Stars: 291
• Watchers: 43
• Forks: 177
• Open Issues: 17
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Lists

• awesome-github-star - vscode-mock-debug
• awesome-stars - microsoft/vscode-mock-debug - Starter sample for developing debug adapters for VSCode. (TypeScript)

README

        
# VS Code Mock Debug

This is a starter sample for developing VS Code debug adapters.

**Mock Debug** simulates a debug adapter for Visual Studio Code.

It supports *step*, *continue*, *breakpoints*, *exceptions*, and

*variable access* but it is not connected to any real debugger.

The sample is meant as an educational piece showing how to implement a debug

adapter for VS Code. It can be used as a starting point for developing a real adapter.

More information about how to develop a new debug adapter can be found

[here](https://code.visualstudio.com/docs/extensions/example-debuggers).

## Using Mock Debug

* Install the **Mock Debug** extension in VS Code.

* Create a new 'program' file `readme.md` and enter several lines of arbitrary text.

* Switch to the debug viewlet and press the gear dropdown.

* Select the debug environment "Mock Debug".

* Press the green 'play' button to start debugging.

You can now 'step through' the `readme.md` file, set and hit breakpoints, and run into exceptions (if the word exception appears in a line).

![Mock Debug](images/mock-debug.gif)

## Build and Run

* Clone the project [https://github.com/Microsoft/vscode-mock-debug.git](https://github.com/Microsoft/vscode-mock-debug.git)

* Open the project folder in VS Code.

* Press `F5` to build and launch Mock Debug in another VS Code window.

* In the explorer view of the new window open the 'program' file `readme.md`

* Set some breakpoints

* From the editor's "Run and Debug" toolbar dropdown menu select "Debug File"