Merge pull request #90 from data-man/kate_with_zls

Add usage instruction with Kate

README.md

@@ -13,6 +13,7 @@ Zig Language Server, or `zls`, is a language server for Zig. The Zig wiki states
 - [Usage](#usage)
   - [VSCode](#vscode)
   - [Sublime Text 3](#sublime-text-3)
+  - [Kate](#kate)
 - [Related Projects](#related-projects)
 - [License](#license)
 
@@ -82,6 +83,23 @@ Install the `zls-vscode` extension from [here](https://github.com/zigtools/zls-v
 }
 ```
 
+### Kate
+
+- Enable `LSP client` plugin in Kate settings.
+- Add this snippet to `LSP client's` user settings (e.g. /$HOME/.config/kate/lspclient)
+  (or paste it in `LSP client's` GUI settings)
+```json
+{
+    "servers": {
+        "zig": {
+            "command": ["zls"],
+            "url": "https://github.com/zigtools/zls",
+            "highlightingModeRegex": "^Zig$"
+        }
+    }
+}
+```
+
 ## Related Projects
 - [`sublime-zig-language` by @prime31](https://github.com/prime31/sublime-zig-language)
   - Supports basic language features

build.zig

@@ -27,16 +27,14 @@ pub fn config(step: *std.build.Step) anyerror!void {
     std.debug.warn("Writing to config...\n", .{});
 
     const content = std.json.stringify(.{
-
         .zig_lib_path = lib_path,
         .enable_snippets = snippets,
-        .warn_style = style
+        .warn_style = style,
-
     }, std.json.StringifyOptions{}, out);
 
     std.debug.warn("Successfully saved configuration options!\n", .{});
 
-    const editor = try zinput.askSelectOne("Which code editor do you use?", enum { VSCode, Sublime, Other });
+    const editor = try zinput.askSelectOne("Which code editor do you use?", enum { VSCode, Sublime, Kate, Other });
     std.debug.warn("\n", .{});
 
     switch (editor) {
@@ -64,12 +62,28 @@ pub fn config(step: *std.build.Step) anyerror!void {
                 \\}}
             , .{});
         },
+        .Kate => {
+            std.debug.warn(
+                \\To use ZLS in Kate, enable `LSP client` plugin in Kate settings.
+                \\Then, add the following snippet to `LSP client's` user settings:
+                \\(or paste it in `LSP client's` GUI settings)
+                \\{{
+                \\    "servers": {{
+                \\        "zig": {{
+                \\            "command": ["zls"],
+                \\            "url": "https://github.com/zigtools/zls",
+                \\            "highlightingModeRegex": "^Zig$"
+                \\        }}
+                \\    }}
+                \\}}
+            , .{});
+        },
         .Other => {
             std.debug.warn(
                 \\We might not *officially* support your editor, but you can definitely still use ZLS!
                 \\Simply configure your editor for use with language servers and point it to the ZLS executable!
             , .{});
-        }
+        },
     }
 
     std.debug.warn("\nYou can find the ZLS executable in the \"zig-cache/bin\" by default.\nNOTE: Make sure that if you move the ZLS executable, you move the `zls.json` config file with it as well!\n\nAnd finally: Thanks for choosing ZLS!\n\n", .{});