From 9ffcc36aae067b9fdec080e2035e7154a60b7b57 Mon Sep 17 00:00:00 2001 From: fendor Date: Tue, 26 Feb 2019 11:17:39 +0100 Subject: [PATCH] Update README to include instructions on how to run tests --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 7cce8e5..eaec952 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,14 @@ For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introd 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 build-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`. + +When all prerequisites have been met, the tests can be executed by running `stack test`. \ No newline at end of file -- 2.30.2