X-Git-Url: http://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=README.md;h=8a16945bb5730b4f0be3d16c7755b411dd354c97;hp=4a8762be7cf90bf11cb298fec70e1025362aed00;hb=5cc69357da694c5521a78b0ab64866d76993de65;hpb=5ad934c026bf88521199d1e82aa12fe51626b92f diff --git a/README.md b/README.md index 4a8762b..8a16945 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# haskell-lsp-test [![Build Status](https://travis-ci.com/Bubba/haskell-lsp-test.svg?branch=master)](https://travis-ci.com/Bubba/haskell-lsp-test) -haskell-lsp-test is a functional testing framework for Language Server Protocol servers. +# 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 import Language.Haskell.LSP.Test @@ -24,7 +24,7 @@ describe "diagnostics" $ ### Replaying captured session ```haskell -replaySession "hie --lsp" "test/data/renamePass" +replaySession "hie" "test/data/renamePass" ``` ### Parsing with combinators @@ -34,9 +34,15 @@ count 4 (message :: Session ApplyWorkspaceEditRequest) anyRequest <|> anyResponse ``` -For more examples check the [Wiki](https://github.com/Bubba/haskell-lsp-test/wiki/Introduction) +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) +The tests are integration tests, so make sure you have the following language servers installed and on your PATH: +### [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine) +- Check out a relatively recent version of the repo, or see `.travis.yml` to get the exact commit used for CI. +- `stack install` +### [javascript-typescript-langserver](https://github.com/sourcegraph/javascript-typescript-langserver) +`npm i -g javascript-typescript-langserver` + +Then run the tests with `stack test` or `cabal new-test`.