squeek502 / zls Goto Github PK

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.

• Installation
  • Build Options
  • Configuration Options
• Usage
  • VSCode
  • Sublime Text 3
  • Kate
  • Neovim/Vim8
• Related Projects
• License

Installing zls is pretty simple;

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

# To configure ZLS:
zig build config

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, as well as various parser changes that have happened since.

You can configure zls by providing a zls.json file.
zls will look for a zls.json configuration file in multiple locations with the following priority:

• In the folders open in your workspace (this applies for files in those folders)
• In the local configuration folder of your OS (as provided by known-folders)
• In the same directory as the executable

The following options are currently available.

zls will supercharge your Zig programming experience with autocomplete, function documentation, and more! Follow the instructions for your specific editor below:

Install the zls-vscode extension from here.

• Install the LSP package from here or via Package Control.
• Add this snippet to LSP's user settings:

{
    "clients": {
        "zig":{
            "command": ["zls"],
            "enabled": true,
            "languageId": "zig",
            "scopes": ["source.zig"],
            "syntaxes": ["Packages/Zig/Syntaxes/Zig.tmLanguage"]
        }
    }
}

• 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)

{
    "servers": {
        "zig": {
            "command": ["zls"],
            "url": "https://github.com/zigtools/zls",
            "highlightingModeRegex": "^Zig$"
        }
    }
}

• Install the CoC engine from here.
• Issue :CocConfig from within your Vim editor, and the following snippet:

{
   "lanuageserver": {
       "zls" : {
           "command": "command_or_path_to_zls",
           "filetypes": ["zig"]
       }
   }
}

• sublime-zig-language by @prime31
  • Supports basic language features
  • Uses data provided by src/data to perform builtin autocompletion
• zig-lsp by @xackus
  • Inspiration for zls
• known-folders by @ziglibs
  • Provides API to access known folders on Linux, Windows and Mac OS

MIT