README.md

   1 # The lsp-test repo has been merged into haskell/lsp
   2
   3 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)
   4
   5
   6 # 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)
   7 lsp-test is a functional testing framework for Language Server Protocol servers.
   8
   9 ```haskell
  10 import Language.LSP.Test
  11 main = runSession "hie" fullCaps "proj/dir" $ do
  12   doc <- openDoc "Foo.hs" "haskell"
  13   skipMany anyNotification
  14   symbols <- getDocumentSymbols doc
  15 ```
  16
  17 ## Examples
  18
  19 ### Unit tests with HSpec
  20 ```haskell
  21 describe "diagnostics" $
  22   it "report errors" $ runSession "hie" fullCaps "test/data" $ do
  23     openDoc "Error.hs" "haskell"
  24     [diag] <- waitForDiagnosticsSource "ghcmod"
  25     liftIO $ do
  26       diag ^. severity `shouldBe` Just DsError
  27       diag ^. source `shouldBe` Just "ghcmod"
  28 ```
  29
  30 ### Replaying captured session
  31 ```haskell
  32 replaySession "hie" "test/data/renamePass"
  33 ```
  34
  35 ### Parsing with combinators
  36 ```haskell
  37 skipManyTill loggingNotification publishDiagnosticsNotification
  38 count 4 (message :: Session ApplyWorkspaceEditRequest)
  39 anyRequest <|> anyResponse
  40 ```
  41
  42 Try out the example tests in the `example` directory with `cabal test`.
  43 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/).
  44
  45 Whilst writing your tests you may want to debug them to see what's going wrong.
  46 You can set the `logMessages` and `logStdErr` options in `SessionConfig` to see what the server is up to.
  47 There are also corresponding environment variables so you can turn them on from the command line:
  48 ```
  49 LSP_TEST_LOG_MESSAGES=1 LSP_TEST_LOG_STDERR=1 cabal test
  50 ```
  51
  52 ## Developing
  53 The tests for lsp-test use a dummy server found in `test/dummy-server/`.
  54 Run the tests with `cabal test` or `stack test`.
  55 Tip: If you want to filter the tests, use `cabal run test:tests -- -m "foo"`
  56
  57 ## Troubleshooting
  58 Seeing funny stuff when running lsp-test via stack? If your server is built upon Haskell tooling, [keep in mind that stack sets some environment variables related to GHC, and you may want to unset them.](https://github.com/alanz/haskell-ide-engine/blob/bfb16324d396da71000ef81d51acbebbdaa854ab/test/utils/TestUtils.hs#L290-L298)