Skip to content
This repository has been archived by the owner on Jul 27, 2024. It is now read-only.

Commit

Permalink
Update TROUBLESHOOTING.md to include language server stopping guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mgmanzella committed Nov 16, 2022
1 parent 0d968d8 commit 5a760c9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,4 +204,4 @@ What you'll see is an interactive version of the following image:
## Troubleshooting
If you run into issues during development, see the [troubleshooting guide](/TROUBLESHOOTING)
If you run into issues during development, see the [troubleshooting guide](/TROUBLESHOOTING.md)
15 changes: 15 additions & 0 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,20 @@ chruby 3.1.2 #your theme ruby version
bundle install
```
### Language server sends an `initialize()` request to the client and stops
To debug, confirm these steps are included in your local language server startup script:
```bash
export THEME_CHECK_DEBUG=true
export THEME_CHECK_DEBUG_LOG_FILE="/tmp/theme-check-debug.log"
touch "$THEME_CHECK_DEBUG_LOG_FILE"
```
An example script can be found [here](/CONTRIBUTING.md#run-language-server).
Open `/tmp/theme-check-debug.log` in your IDE. Check if there are any exceptions being raised by language server.
If there are no exceptions, check if there are any logs that aren't in jsonrpc. The language server and client use stdin and stdout to communicate using jsonrpc. Debugging statements that aren't in a jsonrpc format might trigger unexpected behavior (this includes any logs from language server or echo statements in your language server script).

0 comments on commit 5a760c9

Please sign in to comment.