X-Git-Url: http://git.lukelau.me/?p=lsp-test.git;a=blobdiff_plain;f=README.md;h=17811a2468927418aa4b8608aaa902515a4b961c;hp=a263847774322ef80f8fbdc64dba606170ae0f29;hb=f917c4b4f3d79b320bdf8c3721a0c82507f9d93a;hpb=75db44e4ff6541608adca5e6f15523575c98e558 diff --git a/README.md b/README.md index a263847..17811a2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# lsp-test [![Actions Status](https://github.com/bubba/lsp-test/workflows/Haskell%20CI/badge.svg)](https://github.com/bubba/lsp-test/actions) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test-0.1.0.0) +# lsp-test [![Actions Status](https://github.com/bubba/lsp-test/workflows/Haskell%20CI/badge.svg)](https://github.com/bubba/lsp-test/actions) [![Hackage](https://img.shields.io/hackage/v/lsp-test.svg)](https://hackage.haskell.org/package/lsp-test) lsp-test is a functional testing framework for Language Server Protocol servers. ```haskell @@ -38,14 +38,9 @@ Try out the example tests in the `example` directory with `cabal test`. For more examples check the [Wiki](https://github.com/bubba/lsp-test/wiki/Introduction) ## Developing -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 `cabal test` or `stack test`. +The tests for lsp-test use a dummy server found in `test/dummy-server/`. +Run the tests with `cabal test` or `stack test`. +Tip: If you want to filter the tests, use `cabal run test:tests -- -m "foo"` ## 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)