From c453a099be7a2bbb3ca207e6dbc7b67b82896742 Mon Sep 17 00:00:00 2001 From: RubenKraft Date: Thu, 31 Oct 2024 17:53:40 +0000 Subject: [PATCH] docs: add Readme.md --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 30cd903..5926e27 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ # JavaTXLanguageServer +This Repo contains the LanguageServer for JavaTX as well as various Clients to use it.
+It uses the LSP4J Framework in Version 0.23.1. -Language Server for JavaTX including various Clients. \ No newline at end of file +## Functionality +Currently the Language Server has the following functionalities: +- Syntax-Check +- Test Hovereffect. + + +## Project Structure +``` +. +├── Client/ +│ ├── VisualStudioCode -> Containing the Client for VS Code. In this Case a Extension. +│ ├── Eclipse +│ ├── Intellij +│ └── ... +└── LanguageServer/ + └── src/main/java/com/example/ + ├── model/ + │ └── parseError/ + │ └── ... -> Containing Custom Parse-Errors. + ├── parser/ + │ └── ... -> Containing an the JavaTX ANTLR Parser for Syntax-Checks. + ├── JavaTXLanguageServer.java -> Orchestrator of the Language Server + ├── JavaTXLanguageServerLauncher.java -> Class to start the Language Server. + ├── JavaTXTextDocumentService.java -> Language-Server Features for a Single File + └── JavaTXWorkspaceService.java -> Language-Server Features for the Workspace +``` + +## Usage +To use this Language Server you have to follow this steps: +1. Package the LanguageServer with ```maven:package```. +2. Open the VS-Code Client and run ```npm install```. +3. change Path in ```extensions.ts``` to absolute Path of your packaged Jar-File that you packaged in Step 1. (Line 20 and 24) +4. run ```npm run compile``` +5. Go to Debug and Run the Extension. +6. Press F1 and execute the Hello World Command. +7. You can create .java Files which will be analysed by the Language Server. \ No newline at end of file