zls/README.md

40 lines
1.5 KiB
Markdown
Raw Normal View History

2020-05-07 18:54:58 +01:00
![Zig Language Server](https://raw.githubusercontent.com/SuperAuguste/zls/master/.assets/zls.svg)
2020-04-24 23:19:03 +01:00
2020-05-07 18:54:58 +01:00
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).
2020-04-24 23:19:03 +01:00
## Installation
2020-05-07 18:54:58 +01:00
Installation `zls` is pretty simple;
2020-04-24 23:19:03 +01:00
```bash
git clone https://github.com/SuperAuguste/zls
cd zls
zig build
```
2020-05-07 18:54:58 +01:00
### 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).
2020-04-24 23:19:03 +01:00
Then, you can use the `zls` executable in an editor of your choice that has a Zig language server client!
## Usage
2020-05-07 18:54:58 +01:00
`zls` is in its early stages, with a full analysis/completion engine coming soon, but it is still usable.
2020-04-24 23:19:03 +01:00
### VSCode
Install the `zig-lsc` extension from [here](https://github.com/SuperAuguste/zig-lsc).
2020-05-07 18:54:58 +01:00
## 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