ZLS
Go to file
Auguste Rame 847414d9ca
Merge pull request #54 from alexnask/goto_definition
Fixed field completions with partial identifiers after the period
2020-05-18 09:25:00 -04:00
.assets Fixed logo viewbox, now it doesn't overflow 2020-05-14 07:04:00 +03:00
.github/workflows fix 2020-05-14 10:09:50 -04:00
src Merge pull request #54 from alexnask/goto_definition 2020-05-18 09:25:00 -04:00
.gitignore init 2020-04-24 18:19:03 -04:00
build.zig Removed no_snippets build option. 2020-05-09 16:43:51 +03:00
LICENSE.md Completion of global values, and some reformatting 2020-04-27 16:38:35 -04:00
README.md Make style guideline warnings opt-in 2020-05-15 15:14:37 -04:00

Zig Language Server

CI Zig Tools

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.

Table Of Contents

Installation

Installing zls is pretty simple;

git clone https://github.com/zigtools/zls
cd zls
zig build

Build Options

Option Type What it Does
-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!

Note:zls itself must be built using the master branch of zig currently due to a bug in std.json which was fixed after 0.6.0 was released.

Configuration Options

You can configure zls by providing a zls.json file in the same directory as the executable.
The following options are currently available.

Option Type Default value What it Does
enable_snippets bool true Enables snippet completion, set to false for compatibility with language clients that do not support snippets (such as ale).
zig_lib_path ?[]const u8 null zig library path, used to analyze std library imports.
warn_style bool false Enables warnings for style guideline mismatches

Usage

zls is in its early stages, with a full analysis/completion engine coming soon, but it is still usable.

VSCode

Install the zls-vscode extension from here.

License

MIT