Complete documentation and update .cabal

[lsp-test.git] / lsp-test.cabal

diff --git a/lsp-test.cabal b/lsp-test.cabal
index df4833d37ec02b56ffa87bce621b1f946d69d89c..c293534f1f2be532976d2b963b213540d3809369 100644 (file)
--- a/lsp-test.cabal
+++ b/lsp-test.cabal
@@ -1,7 +1,18 @@
 name:                lsp-test
 version:             0.1.0.0
 synopsis:            Functional test framework for LSP servers.
--- description:
+description:
+  A test framework for writing tests against 
+  <https://microsoft.github.io/language-server-protocol/ Language Server Protocol servers>.
+  @lsp-test@ launches your server as a subprocess and allows you to simulate a session
+  down to the wire.
+  Used for testing in <https://github.com/haskell/haskell-ide-engine haskell-ide-engine>.
+  > runSession "hie" fullCaps "path/to/root/dir" $ do
+  > doc <- openDoc "Desktop/simple.hs" "haskell"
+  > diags <- waitForDiagnostics
+  > let pos = Position 12 5
+  >     params = TextDocumentPositionParams doc
+  > hover <- request TextDocumentHover params
 homepage:            https://github.com/Bubba/haskell-lsp-test#readme
 license:             BSD3
 license-file:        LICENSE
@@ -12,13 +23,17 @@ bug-reports:         https://github.com/Bubba/haskell-lsp-test/issues
 copyright:           2018 Luke Lau
 category:            Testing
 build-type:          Simple
-cabal-version:       >=1.10
+cabal-version:       2.0
 extra-source-files:  README.md
+tested-with:         GHC == 8.2.2 , GHC == 8.4.2 , GHC == 8.4.3
+
+source-repository head
+  type:     git
+  location: https://github.com/Bubba/haskell-lsp-test/
 
 library
   hs-source-dirs:      src
   exposed-modules:     Language.Haskell.LSP.Test
-                     , Language.Haskell.LSP.Test.Capabilities
                      , Language.Haskell.LSP.Test.Replay
   reexported-modules:  haskell-lsp:Language.Haskell.LSP.Types
                      , haskell-lsp:Language.Haskell.LSP.Types.Capabilities
@@ -49,7 +64,8 @@ library
     build-depends:     Win32
   else
     build-depends:     unix
-  other-modules:       Language.Haskell.LSP.Test.Compat
+  other-modules:       Language.Haskell.LSP.Test.Capabilities
+                       Language.Haskell.LSP.Test.Compat
                        Language.Haskell.LSP.Test.Decoding
                        Language.Haskell.LSP.Test.Exceptions
                        Language.Haskell.LSP.Test.Files