X-Git-Url: https://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=README.md;h=6f43add975965404cd57b982247ca72411ad7790;hp=17811a2468927418aa4b8608aaa902515a4b961c;hb=HEAD;hpb=f917c4b4f3d79b320bdf8c3721a0c82507f9d93a diff --git a/README.md b/README.md index 17811a2..6f43add 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ +# The lsp-test repo has been merged into haskell/lsp + +Please visit [haskell/lsp](https://github.com/haskell/lsp) instead (Don't worry though, it's still mantained and still lives under the same lsp-test package on hackage) + + # lsp-test [![Actions Status](https://github.com/bubba/lsp-test/workflows/Haskell%20CI/badge.svg)](https://github.com/bubba/lsp-test/actions) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test) 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 +40,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/`.