Skip to content

Commit d8548fc

Browse files
authored
docs(amazonq): Improved the local LSP setup documentation with more information (#7524)
## Problem The documentation was incomplete for setting up the LSP locally for testing. ## Solution Added the required information. --- - Treat all work as PUBLIC. Private `feature/x` branches will not be squash-merged at release time. - Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines). - License: I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent c88bfde commit d8548fc

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

docs/lsp.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ sequenceDiagram
2626

2727
## Language Server Debugging
2828

29-
1. Clone https://github.com/aws/language-servers.git and set it up in the same workspace as this project by cmd+shift+p and "add folder to workspace" and selecting the language-servers folder that you just cloned. Your VS code folder structure should look like below.
30-
31-
29+
1. Clone https://github.com/aws/language-servers.git and set it up in the same workspace as this project by cmd+shift+p and "add folder to workspace" and selecting the language-servers folder that you just cloned. Your VS code folder structure should look like below.
3230

3331
```
3432
/aws-toolkit-vscode
@@ -45,7 +43,7 @@ sequenceDiagram
4543
npm run package
4644
```
4745
to get the project setup
48-
3. Enable the lsp experiment:
46+
3. You need to open VScode user settings (Cmd+Shift+P and Search "Open User Settings (JSON)") and add the lines below at the bottom of the settings to enable the lsp experiment:
4947
```
5048
"aws.experiments": {
5149
"amazonqLSP": true,
@@ -54,7 +52,7 @@ sequenceDiagram
5452
}
5553
```
5654
4. Uncomment the `__AMAZONQLSP_PATH` and `__AMAZONQLSP_UI` variables in the `amazonq/.vscode/launch.json` extension configuration
57-
5. Use the `Launch LSP with Debugging` configuration and set breakpoints in VSCode or the language server
55+
5. Use the `Launch LSP with Debugging` configuration and set breakpoints in VSCode or the language server, Once you run "Launch LSP with Debugging" a new window should start, wait for the plugin to show up there. Then go to the run menu again and run "Attach to Language Server (amazonq)" after this you should be able to add breakpoints in the LSP code.
5856
6. (Optional): Enable `"amazonq.trace.server": "on"` or `"amazonq.trace.server": "verbose"` in your VSCode settings to view detailed log messages sent to/from the language server. These log messages will show up in the "Amazon Q Language Server" output channel
5957
6058
## Amazon Q Inline Activation

0 commit comments

Comments
 (0)