Split the project into a reusable component library LSP-lib and an …

…implementation depending on the library (#202)

* Base the code off lib-lsp

* Update .gitmodules and README

* Update CI

* Rename package to `idris2-lsp`; bump package version

* Properly (?) add submodule

* Update Makefile

* Remove a TODO from README

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ env:
   SCHEME: scheme
 
 jobs:
-  build-idris2-with-api: 
+  build-idris2-with-api:
     runs-on: ubuntu-latest
     env:
       IDRIS2_CG: chez
@@ -72,6 +72,13 @@ jobs:
           sudo apt-get install -y chezscheme
           echo "$HOME/.idris2/bin" >> $GITHUB_PATH
           chmod +x $HOME/.idris2/bin/idris2 $HOME/.idris2/bin/idris2_app/*
+      - name: Get LSP-lib submodule
+        run: |
+          git submodule update --init LSP-lib
+      - name: Build and install LSP-lib
+        working-directory: LSP-lib
+        run: |
+          idris2 --install-with-src
       - name: build and test
         run: |
           make build && make test INTERACTIVE=''

.gitmodules

@@ -1,3 +1,7 @@
 [submodule "Idris2"]
 	path = Idris2
 	url = https://github.com/idris-lang/Idris2
+
+[submodule "LSP-lib"]
+	path = LSP-lib
+	url = https://github.com/idris-community/LSP-lib

Makefile

@@ -22,14 +22,14 @@ VERSION_TAG ?= $(GIT_SHA1)
 .PHONY: build FORCE
 
 build: src/Server/Generated.idr
-	$(IDRIS2) --build lsp.ipkg
+	$(IDRIS2) --build idris2-lsp.ipkg
 
 clean:
-	$(IDRIS2) --clean lsp.ipkg
+	$(IDRIS2) --clean idris2-lsp.ipkg
 	$(RM) -r build
 
 repl: src/Server/Generated.idr
-	rlwrap $(IDRIS2) --repl lsp.ipkg
+	rlwrap $(IDRIS2) --repl idris2-lsp.ipkg
 
 testbin:
 	@${MAKE} -C tests testbin

README.md

@@ -1,11 +1,11 @@
-# [WIP] idris2-lsp
+# idris2-lsp
 Language Server for Idris2.
 
 **NOTE: At this stage the LSP server requires an ipkg file to work correctly, for reference material about packages look [here](https://idris2.readthedocs.io/en/latest/tutorial/packages.html) and [here](https://idris2.readthedocs.io/en/latest/reference/packages.html). To start a new project with an ipkg, even for a single file, you can issue the `idris2 --init` command, which provides an interactive interface for package creation.**
 
 ## Installation with [Pack](https://github.com/stefan-hoeck/idris2-pack) (Recommended)
 ```bash
-pack install-app lsp
+pack install-app idris2-lsp
 ```
 
 ## Manual Installation
@@ -24,6 +24,10 @@ make install # Install Idris
 make install-with-src-libs # Install sources for libraries
 make install-with-src-api # Install the API with sources
 cd .. # Go back to the idris2-lsp directory
+git submodule update --init LSP-lib # Get the associated LSP-lib commit
+cd LSP-lib
+idris2 --install-with-src # Install the LSP library
+cd .. # Go back to the idris2-lsp directory
 make install # Install idris2-lsp
 ```
 

idris2-lsp.ipkg

@@ -0,0 +1,13 @@
+package idris2-lsp
+version = 0.6.0
+
+opts = "-Wno-shadowing"
+
+depends = idris2, contrib, lsp-lib
+
+sourcedir = "src"
+
+main = Server.Main
+executable = idris2-lsp
+
+prebuild = "make src/Server/Generated.idr"