X-Git-Url: http://git.lukelau.me/?a=blobdiff_plain;f=README.md;h=eb5250a8a36b512492ec3d597e1e115636370ca0;hb=fa383bac05f88cae81a2c4caaa8814ca24be8add;hp=f866ccfcc30af7ff000583314e73bae5813aaefb;hpb=2fc7db80e8ec7bf37e1022b2e28c098eb390167c;p=lsp-test.git

diff --git a/README.md b/README.md
index f866ccf..eb5250a 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,54 @@
-# haskell-lsp-test [![Build Status](https://travis-ci.com/Bubba/haskell-lsp-test.svg?branch=master)](https://travis-ci.com/Bubba/haskell-lsp-test)
-This is the functional testing framework for [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine), and potentially any other Language Server Protocol server.
+# 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)
+lsp-test is a functional testing framework for Language Server Protocol servers.
 
 ```haskell
-runSession "session/root/dir" $ do
-  doc <- openDoc "foo.hs" "haskell"
+import Language.Haskell.LSP.Test
+runSession "hie" fullCaps "proj/dir" $ do
+  doc <- openDoc "Foo.hs" "haskell"
+  skipMany anyNotification
+  symbols <- getDocumentSymbols doc
+```
 
-  skipMany notification
+## Examples
 
-  sendRequest (Proxy :: Proxy DocumentSymbolRequest)
-              TextDocumentDocumentSymbol
-              (DocumentSymbolParams doc)
+### Unit tests with HSpec
+```haskell
+describe "diagnostics" $
+  it "report errors" $ runSession "hie" fullCaps "test/data" $ do
+    openDoc "Error.hs" "haskell"
+    [diag] <- waitForDiagnosticsSource "ghcmod"
+    liftIO $ do
+      diag ^. severity `shouldBe` Just DsError
+      diag ^. source `shouldBe` Just "ghcmod"
+```
+
+### Replaying captured session
+```haskell
+replaySession "hie" "test/data/renamePass"
+```
+
+### Parsing with combinators
+```haskell
+skipManyTill loggingNotification publishDiagnosticsNotification
+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.
+
+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.
+
+The language server `javascript-typescript-langserver` can be installed by invoking `npm i -g javascript-typescript-langserver`.
 
-  RspDocumentSymbols rspSymbols <- response
-  let (List symbols) = fromJust (rspSymbols ^. result)
+When all prerequisites have been met, the tests can be executed by running `stack test`.
\ No newline at end of file