X-Git-Url: https://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=README.md;h=6f43add975965404cd57b982247ca72411ad7790;hp=eb5250a8a36b512492ec3d597e1e115636370ca0;hb=HEAD;hpb=fa383bac05f88cae81a2c4caaa8814ca24be8add

diff --git a/README.md b/README.md
index eb5250a..6f43add 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,14 @@
-# lsp-test [![Build Status](https://travis-ci.com/bubba/lsp-test.svg?branch=master)](https://travis-ci.com/bubba/lsp-test) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test-0.1.0.0)
+# 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
-runSession "hie" fullCaps "proj/dir" $ do
+import Language.LSP.Test
+main = runSession "hie" fullCaps "proj/dir" $ do
   doc <- openDoc "Foo.hs" "haskell"
   skipMany anyNotification
   symbols <- getDocumentSymbols doc
@@ -34,21 +39,20 @@ count 4 (message :: Session ApplyWorkspaceEditRequest)
 anyRequest <|> anyResponse
 ```
 
-Try out the example tests in the `example` directory with `cabal new-test`.
-For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction)
-
-## Developing
-To test make sure you have the following language servers installed:
-- [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
-- [javascript-typescript-langserver](https://github.com/sourcegraph/javascript-typescript-langserver)
-
-## How to run tests
-
-The present tests are integration tests. Thus, it is required that that the executables `hie` and `javascript-typescript-langserver` are on the path.
+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), or see this [introductory blog post](https://lukelau.me/haskell/posts/lsp-test/).
 
-The executable `hie` has to have been built using GHC 8.6.2. This can be done by cloning [Haskell-IDE-Engine](https://github.com/haskell/haskell-ide-engine) and invoking `stack install.hs hie-8.6.2`. This will create the executables `hie`, `hie-8.6` and `hie-8.6.2` in your `$HOME/.local/bin`, or respective `stack path --local-bin` location.
-To make sure the test environment is identical to the travis setup, in `.travis.yml` you can find the exact git hash that has been used to execute the tests and build `hie` from that snapshot.
+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
+```
 
-The language server `javascript-typescript-langserver` can be installed by invoking `npm i -g javascript-typescript-langserver`.
+## Developing
+The tests for lsp-test use a dummy server found in `test/dummy-server/`.
+Run the tests with `cabal test` or `stack test`.
+Tip: If you want to filter the tests, use `cabal run test:tests -- -m "foo"`
 
-When all prerequisites have been met, the tests can be executed by running `stack test`.
\ No newline at end of file
+## Troubleshooting
+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)