X-Git-Url: https://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=README.md;h=ce452fe715d8858a995bf5a19230a394e8700492;hp=7cce8e55f1c8ca6c22b240b4549b5de6d0589662;hb=2a1a602d8f21a042e6db4dce211a23cb138b8398;hpb=1efccbac7aa4e9f93ae716fb92cbae156fabc391 diff --git a/README.md b/README.md index 7cce8e5..ce452fe 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,14 @@ 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`. + +## 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)