From: Luke Lau <luke_lau@icloud.com>
Date: Thu, 14 May 2020 19:22:09 +0000 (+0100)
Subject: Mention some useful debugging options
X-Git-Tag: 0.11.0.0~4
X-Git-Url: https://git.lukelau.me/?p=lsp-test.git;a=commitdiff_plain;h=c60722dda60902fc52f689d6393a43b004b1d8f8

Mention some useful debugging options
---

diff --git a/README.md b/README.md
index 17811a2..b49ba84 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,14 @@ anyRequest <|> anyResponse
 ```
 
 Try out the example tests in the `example` directory with `cabal test`.
-For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction)
+For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction).
+
+Whilst writing your tests you may want to debug them to see what's going wrong.
+You can set the `logMessages` and `logStdErr` options in `SessionConfig` to see what the server is up to.
+There are also corresponding environment variables so you can turn them on from the command line:
+```
+LSP_TEST_LOG_MESSAGES=1 cabal test
+```
 
 ## Developing
 The tests for lsp-test use a dummy server found in `test/dummy-server/`.