|
1 |
| -# Debug graph |
| 1 | +# 📊 Debug Graph |
2 | 2 |
|
3 |
| -A Visual Studio Code extension that shows all the function calls (code paths) that lead to a breakpoint. |
| 3 | +A Visual Studio Code extension that visualizes the function calls (code paths) leading up to your breakpoints. Gain insights into the execution flow in your code and troubleshoot efficiently! |
4 | 4 |
|
5 |
| -## Features |
| 5 | +## ✨ Features |
6 | 6 |
|
7 | 7 | 
|
8 | 8 |
|
9 |
| -## Requirements |
| 9 | +## 🚀 Requirements |
10 | 10 |
|
11 |
| -This extension works with **all languages** that Visual Studio Code supports. |
12 |
| -Although, i have only tested: |
| 11 | +This extension is designed to work with **all languages** supported by Visual Studio Code. However, the following languages have been tested for compatibility: |
13 | 12 |
|
14 |
| -* Go |
15 |
| -* Python |
16 |
| -* JavaScript |
17 |
| -* TypeScript |
| 13 | +- Go |
| 14 | +- Python |
| 15 | +- JavaScript |
| 16 | +- TypeScript |
18 | 17 |
|
19 |
| -<!-- more testing needed |
20 |
| -* c# |
21 |
| -* c++ |
22 |
| -* c |
23 |
| -* Java (limited) |
24 |
| ---> |
| 18 | +> More testing is planned for additional languages such as C#, C++, C, and Java. |
25 | 19 |
|
26 |
| -## How to get started |
| 20 | +## 🛠️ How to Get Started |
27 | 21 |
|
28 |
| -1. Set a breakpoint in your code |
29 |
| -2. Click on the `Call Graph` icon in the top bar of your editor |
30 |
| -3. See what variables are and where you are coming from |
| 22 | +1. Set a breakpoint in your code. |
| 23 | +2. Click on the `Call Graph` icon in the top bar of your editor. |
| 24 | +3. Explore the variables and trace the origin of your execution. |
31 | 25 |
|
32 |
| -## How to install |
| 26 | +## 📥 How to Install |
33 | 27 |
|
34 |
| -1. Open Visual Studio Code |
35 |
| -2. Go to the Extensions view by clicking on the square icon in the sidebar |
36 |
| -3. Search for `Call Graph` |
37 |
| -4. Click on the Install button |
| 28 | +1. Open Visual Studio Code. |
| 29 | +2. Go to the Extensions view (square icon in the sidebar). |
| 30 | +3. Search for Debug Graph and click Install. |
38 | 31 |
|
39 |
| -## Known Issues |
| 32 | +You can also install it directly from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=k0in.debug-graph). |
40 | 33 |
|
41 |
| -* Sometimes the theme colors are not matched to vscode theme, this resolves when opening the call graph again |
| 34 | +## 💻 Issues and Contributions |
| 35 | + |
| 36 | +For bug reports or feature requests, please visit our [GitHub Repository](https://github.com/K0IN/stacktrace-history). |
| 37 | + |
| 38 | +## 📦 Store Information |
| 39 | + |
| 40 | +- Extension Name: **debug-graph** |
| 41 | +- Extension ID: **k0in.debug-graph** |
| 42 | +- [View on Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=k0in.debug-graph) |
| 43 | + |
| 44 | +## Tech Stack |
| 45 | + |
| 46 | +- TypeScript |
| 47 | +- [Vue.js](https://vuejs.org/) (for the frontend) |
| 48 | +- [Comlink](https://github.com/GoogleChromeLabs/comlink) (for communication between the frontend and backend) |
0 commit comments