Skip to content

Commit f2039bf

Browse files
Alexander Chendatho7561
Alexander Chen
authored andcommitted
added debug instructions for debugging lemminx with vscode-xml
1 parent 99bfa76 commit f2039bf

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,30 @@ Contributions are essential for keeping this extension great. We try to keep it
5555

5656
![ Launch Extension ](./images/LaunchExtension.png)
5757

58+
### Debugging Language Server
59+
60+
After completing the prerequisite steps above, and after launching the **Extension Development Host** for `vscode-xml`, you can also debug the language `server/lemminx` and can be used as follows:
61+
62+
#### On VSCode
63+
64+
1. Ensure that the most recent changes of `lemminx` have been built before launching the **Extension Development Host** (as per Step 7 in [Steps](#Steps)), and that the **Extension Development Host** is running.
65+
66+
2. Open `lemminx` in VSCode. This should display the "Debug (Attach) - Remote" option in the "Debugging" tab.
67+
68+
3. To run the debugger, open the "Debugging" tab in VSCode.
69+
70+
4. Select and run "Debug (Attach) - Remote" at the top left:
71+
72+
![Debug Attach Remote](./images/DebugAttachRemote.png)
73+
74+
This will make the `lemminx` debugger attach to the **Extension Development Host** instance.
75+
76+
To confirm that the debugger has properly attached, the "Call Stack" dropdown in the "Debugging" tab should be populated as follows:
77+
78+
![Debug Menu Call Stack](./images/DebugMenuCallStack.png)
79+
80+
Now that the `lemminx` debugger is properly attached, any language server interactions can be debugged and breakpoints in `lemminx` will be tracked.
81+
5882
## Binary server development
5983

6084
### Testing a binary version of LemMinX

images/DebugAttachRemote.png

3.09 KB
Loading

images/DebugMenuCallStack.png

33.5 KB
Loading

0 commit comments

Comments
 (0)