feat: v0.1.0-alpha

Author: ViTeXFTW

.gitignore

@@ -1,3 +1,4 @@
+TODO.txt
 out
 node_modules
 client/server

LISCENSE LICENSELISCENSE renamed to LICENSE

@@ -6,6 +6,51 @@
 ## Introduction
 **ZeroHour-Server** is a language server written in TypeScript for Command and Conquor Generals Zero Hour INI. The server is intended to provide formatting, linting and code completion. Currently this is intended for Visual Studio Code only, however all functionallities will be server sided and can be utilized in other IDEs by creating an interface for communicating with the server over Json-RPC.
 
+## How to install
+
+1. Open Visual Studio Code
+2. Open the Extensions Tab
+3. Search for ZeroSyntax
+4. Click Install
+5. Click Reload
+6. Done!
+
+## Functionallities
+ZeroSyntax language server supports the following functionallities:
+- Formatting
+- Diagnostics
+- Code Completion
+
+
+### Formatting
+To format a ini file you can use the following command:
+
+1. Access it from the Command Pallette (Ctrl+Shift+P or Cmd+Shift+P on Mac)
+2. Write:
+```plaintext
+> Format Document
+```
+3. Press Enter
+
+#### Before 
+TODO: Add image
+
+#### After
+TODO: Add image
+
+
+### Diagnostics
+Diagnostics works out of the box. Any syntax errors will be highlighted in the editor.
+
+### Code Completion
+The server supports context based code completion. This is done by analyzing the syntax tree and collecting possible completions based on the current context.
+
+1. Write some code
+2. Press Ctrl+Space
+
+[Completions](./images/gifs/ZeroSyntax-ServerCompletionGif.gif)
+
+
 ## Contributing
 For contributing you will need to fork the repository, create your own branch make and test any changes you feel is missing from the project and create a pull request. I will then take a look at the code changes and merge the code if everything is in order.
 

README.md

@@ -31,8 +31,11 @@
 		"vscode-test": "^1.6.1"
 	},
 	"dependencies": {
+		"@types/vscode": "^1.94.0",
 		"glob": "^11.0.0",
 		"vscode-languageclient": "^9.0.1",
-		"vscode-languageserver-textdocument": "^1.0.12"
+		"vscode-languageserver-protocol": "^3.17.5",
+		"vscode-languageserver-textdocument": "^1.0.12",
+		"vscode-languageserver-types": "^3.17.5"
 	}
 }

client/package-lock.json

@@ -103,6 +103,8 @@ export function activate(context: vscode.ExtensionContext) {
 	if (languageServerRunning) {
 		client.start();
 	}
+
+	vscode.window.showWarningMessage('Zero Syntax: This is an alpha version!\nPlease report bugs to https://github.com/ViTeXFTW/ZeroSyntax-Server/issues');
 }
 
 vscode.workspace.onDidChangeConfiguration((e) => {