Skip to content

Commit e31f66f

Browse files
Readme Update
1 parent e4d3e4b commit e31f66f

3 files changed

Lines changed: 18 additions & 13 deletions

File tree

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,15 @@
1212
## Features
1313

1414
- **Macro Recording and Playback**: Record debugging sessions, including step-ins, step-outs, and breakpoints. Play back the recorded sessions at any time.
15+
**Recording**
16+
![JavaDebugXMacroRecording](/media/vscode-java-debugx-macro-recording.gif)
17+
**Playback**
18+
![JavaDebugXMacro](/media/vscode-java-debugx-play-macro.gif)
19+
1520
- **Customizable Bridge Configurations**: Define custom bridge classes and methods to integrate additional debugging insights.
1621
- **Advanced Debug Insights**: View detailed, real-time debugging information in a dedicated Insights view.
22+
![DebugInsight](/media/vscode-java-debugx-bridge.gif)
23+
1724
- **Search External Files**: Search and index external files during debugging to improve traceability.
1825
- **Customizable File Patterns**: Define which files to include when indexing external files.
1926

@@ -26,7 +33,7 @@ To install the **Java DebugX** extension in Visual Studio Code:
2633

2734
1. Open **Visual Studio Code**.
2835
2. Go to the **Extensions** view by clicking on the Extensions icon in the Activity Bar or pressing `Ctrl+Shift+X`.
29-
3. Search for **Vscode Java DebugX**.
36+
3. Search for **Java DebugX**.
3037
4. Click **Install**.
3138

3239
Alternatively, you can install it directly from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=soumyaprasadrana.vscode-java-debugx).
@@ -79,7 +86,11 @@ To generate a sample bridge configuration file:
7986

8087
This will generate a new bridge configuration file in your workspace, which you can modify to create your custom bridge logic.
8188

82-
![DebugInsight](/media/vscode-java-debugx-bridge.gif)
89+
90+
91+
## Limitation
92+
93+
The macro recording feature is well-tested when your debug session interacts with only a single thread. However, if you are debugging multiple threads simultaneously, the events will be recorded but playback might not work as expected. We are actively working on improving support for multi-threaded debugging sessions.
8394

8495
## Development
8596

@@ -93,14 +104,7 @@ If you'd like to contribute or develop the extension locally, follow these steps
93104
```bash
94105
npm install
95106
```
96-
3. Build the extension:
97-
```bash
98-
npm run build-prod
99-
```
100-
4. Launch the extension in VS Code with:
101-
```bash
102-
npm run watch
103-
```
107+
3. Launch the extension in VS Code with from debug view
104108

105109
## License
106110

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
"name": "Soumya Prasad Rana",
77
"email": "soumyaprasad.rana@gmail.com"
88
},
9-
"version": "0.0.1",
9+
"version": "1.0.0",
1010
"publisher": "soumyaprasadrana",
11+
"icon": "vscode-java-debugx.png",
1112
"engines": {
1213
"vscode": "^1.60.0"
1314
},
@@ -126,7 +127,7 @@
126127
},
127128
"java.debugx.macro.stepDelayInSeconds": {
128129
"type": "integer",
129-
"default": 2,
130+
"default": 1,
130131
"description": "Path to the external folder to index."
131132
},
132133
"java.debugx.bridgeConfigPath": {

src/registerMacroRecordingCommands.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ async function playMacro(macro: StackFrame[], macroFilePath: string, debugInfoSt
187187
let isPaused = ContextProvider.getContextFromWorkspaceState<boolean>('java.debugx.macro.isPaused') ?? false;
188188

189189
const config = vscode.workspace.getConfiguration('java.debugx');
190-
const delayTime = config.get<number>('macro.stepDelayInSeconds') ?? 2;
190+
const delayTime = config.get<number>('macro.stepDelayInSeconds') ?? 1;
191191
// Iterate through each step in the macro
192192
let count = 0;
193193
while (isPlaying) {

0 commit comments

Comments
 (0)