X-Git-Url: https://git.lukelau.me/?a=blobdiff_plain;f=README.md;h=7ba10d6a2b273dbb0ec4b095814c716b6805b684;hb=dea9d74e296cc9a4e94c3d35ed9f14c6b40986af;hp=17811a2468927418aa4b8608aaa902515a4b961c;hpb=f917c4b4f3d79b320bdf8c3721a0c82507f9d93a;p=lsp-test.git diff --git a/README.md b/README.md index 17811a2..7ba10d6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ lsp-test is a functional testing framework for Language Server Protocol servers. ```haskell -import Language.Haskell.LSP.Test +import Language.LSP.Test main = runSession "hie" fullCaps "proj/dir" $ do doc <- openDoc "Foo.hs" "haskell" skipMany anyNotification @@ -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), or see this [introductory blog post](https://lukelau.me/haskell/posts/lsp-test/). + +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 LSP_TEST_LOG_STDERR=1 cabal test +``` ## Developing The tests for lsp-test use a dummy server found in `test/dummy-server/`.