s/haskell-lsp-test/lsp-test

[opengl.git] / README.md

diff --git a/README.md b/README.md
index 0af386e54c3a75c8be2f2af3af767ff6fb2693ce..6fa8ce6881809af144c4b138e1edfa81c880e8d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,42 @@
-# 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/haskell-lsp-test.svg?branch=master)](https://travis-ci.com/Bubba/haskell-lsp-test)
+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 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"
+```
 
-  rspSymbols <- response :: DocumentSymbolsResponse
-  let (List symbols) = fromJust (rspSymbols ^. result)
+### Replaying captured session
+```haskell
+replaySession "hie" "test/data/renamePass"
 ```
+
+### Parsing with combinators
+```haskell
+skipManyTill loggingNotification publishDiagnosticsNotification
+count 4 (message :: Session ApplyWorkspaceEditRequest)
+anyRequest <|> anyResponse
+```
+
+For more examples check the [Wiki](https://github.com/Bubba/haskell-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)