From 4f8e61322f1f661cc7ea66796985a5f4ef1284f5 Mon Sep 17 00:00:00 2001 From: SuperAuguste Date: Thu, 7 May 2020 13:54:58 -0400 Subject: [PATCH 1/3] README improvements --- .assets/zls.svg | 79 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 24 +++++++++++++-- 2 files changed, 100 insertions(+), 3 deletions(-) create mode 100644 .assets/zls.svg diff --git a/.assets/zls.svg b/.assets/zls.svg new file mode 100644 index 0000000..8f36763 --- /dev/null +++ b/.assets/zls.svg @@ -0,0 +1,79 @@ + + + + + + + + image/svg+xml + + + + + + + ZigLanguageServer + + diff --git a/README.md b/README.md index e11ef23..8a53344 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,39 @@ -# zls - Zig Language Server +![Zig Language Server](https://raw.githubusercontent.com/SuperAuguste/zls/master/.assets/zls.svg) -Zig Language Server (or `zls` for short) is a - you guessed it - language server for Zig! Based off of the code written by the great `andersfr`. +Zig Language Server, or `zls`, is a language server for Zig. The Zig wiki states that "The Zig community is decentralized" and "There is no concept of 'official' or 'unofficial'", so instead of calling `zls` unofficial, and I'm going to call it a cool option, one of [many](https://github.com/search?q=zig+language+server). ## Installation +Installation `zls` is pretty simple; + ```bash git clone https://github.com/SuperAuguste/zls cd zls zig build ``` +### Build Options + +| Option | Type | What it Does | +| --- | --- | --- | +| `-Dno_snippets` | `bool` | Enables "no snippets" mode for compatibility with language clients that do not support snippets (such as ale). | +| `-Ddata_version` | `string` | The data file version. Any files in the `src/data` file that correspond with the Zig version you want the language server to build for (0.6.0, master). + Then, you can use the `zls` executable in an editor of your choice that has a Zig language server client! ## Usage -**Please, I beg you, please don't use this unless you're developing or testing it!** +`zls` is in its early stages, with a full analysis/completion engine coming soon, but it is still usable. ### VSCode Install the `zig-lsc` extension from [here](https://github.com/SuperAuguste/zig-lsc). + + +## Related Projects +- [`sublime-zig-language` by @prime31](https://github.com/prime31/sublime-zig-language) + - Supports basic language features + - Uses data provided by `src/data` to perform builtin autocompletion + +## License +MIT From fd38e2d3efec60a99ee9bfa9eae79a6db2bbb205 Mon Sep 17 00:00:00 2001 From: SuperAuguste Date: Thu, 7 May 2020 13:57:38 -0400 Subject: [PATCH 2/3] resize --- .assets/zls.svg | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/.assets/zls.svg b/.assets/zls.svg index 8f36763..873c36d 100644 --- a/.assets/zls.svg +++ b/.assets/zls.svg @@ -11,12 +11,13 @@ inkscape:version="1.0 (4035a4fb49, 2020-05-01)" id="svg8" version="1.1" - viewBox="0 0 140.22915 82.020839" - height="310" - width="530"> + viewBox="0 0 64.822908 37.83542" + height="143" + width="245"> ZigZigLanguageLanguageServer + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:12.7px;font-family:Inter;-inkscape-font-specification:'Inter Bold';letter-spacing:0px;fill:#000000;fill-opacity:1;stroke-width:0.264583" + y="35.401028" + x="1.938048">Server From 042b47a27db283f72d5f33d5e404acb889807738 Mon Sep 17 00:00:00 2001 From: SuperAuguste Date: Thu, 7 May 2020 14:02:59 -0400 Subject: [PATCH 3/3] fix typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a53344..c6e99aa 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Zig Language Server, or `zls`, is a language server for Zig. The Zig wiki states ## Installation -Installation `zls` is pretty simple; +Installing `zls` is pretty simple; ```bash git clone https://github.com/SuperAuguste/zls