-
-
Notifications
You must be signed in to change notification settings - Fork 302
Installation
Note If you only intend to use Visual Studio Code, you don't need to install ZLS or Zig manually
Note We currently recommend using the latest binaries as Zig and ZLS are fast-evolving.
x86-64 | AArch64 | x86 | |
---|---|---|---|
Linux | x86-64 Linux | AArch64 Linux | x86 Linux |
Windows | x86-64 Windows | - | x86 Windows |
MacOS | x86-64 Macos | AArch64 MacOS | - |
Head to the Releases
tab and select the right executable in the Assets
section at the bottom of the latest release.
tar -x --strip-components=1 -f [archive] [output_path]
See this section in the README.
Most extensions expect you to either manually specify the path to ZLS or add ZLS to your PATH
Note You don't need to install ZLS or Zig manually
Using ZLS in Visual Studio Code is as simple as installing the official Zig Language extension (open in VSCode).
- install the LSP and sublime-zig-language package (Package Control Usage)
- place the following snippet in the
LSP.sublime-settings
(Preferences -> Package Settings -> LSP -> Settings) - place the following snippet in the
Zig.sublime-settings
(Preferences -> Package Settings -> Zig -> Settings)
// Zig.sublime-settings
{
// ZLS will run format on save
"zig.fmt.on_save": false,
// automatically hide the build/fmt output panel
"zig.quiet": true,
}
// LSP.sublime-settings
{
// General settings
"lsp_format_on_save": true,
"lsp_code_actions_on_save": {
"source.fixAll": true,
},
"show_inlay_hints": true,
"semantic_highlighting": true,
// Language server configurations
"clients": {
"zig": {
// the startup command -- what you would type in a terminal
"command": ["/path/to/zls_executable"],
// enable this configuration
"enabled": true,
// the selector that selects which type of buffers this language server attaches to
"selector": "source.zig"
}
}
}
// LSP.sublime-settings
{
"clients": {
"zig": {
"command": ["/path/to/zls_executable"],
"enabled": true,
"languageId": "zig",
"scopes": ["source.zig"],
"syntaxes": ["Packages/Zig Language/Syntaxes/Zig.tmLanguage"]
}
}
}
Run :CocInstall coc-zls
to install coc-zls. This extension supports the same functionality as the VS Code extension.
{
"languageserver": {
"zls" : {
"command": "/path/to/zls_executable",
"filetypes": ["zig"]
}
}
}
- Install YouCompleteMe from here.
- Add these lines to your vimrc:
"ensure zig is a recognized filetype
autocmd BufNewFile,BufRead *.zig set filetype=zig
let g:ycm_language_server =
\\ [
\\{
\\ 'name': 'zls',
\\ 'filetypes': [ 'zig' ],
\\ 'cmdline': [ '/path/to/zls_executable' ]
\\ }
\\ ]
Requires Nvim 0.5 (HEAD)!
nvim-lspconfig already ships a configuration for zls. A simple init.vim
might look like this:
call plug#begin('~/.config/nvim/plugged')
Plug 'neovim/nvim-lspconfig'
Plug 'nvim-lua/completion-nvim'
Plug 'ziglang/zig.vim'
call plug#end()
:lua << EOF
local lspconfig = require('lspconfig')
local on_attach = function(_, bufnr)
vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.vim.lsp.omnifunc')
require('completion').on_attach()
end
local servers = {'zls'}
for _, lsp in ipairs(servers) do
lspconfig[lsp].setup {
on_attach = on_attach,
}
end
EOF
" Set completeopt to have a better completion experience
set completeopt=menuone,noinsert,noselect
" Enable completions as you type
let g:completion_enable_auto_popup = 1
- Install the LanguageClient-neovim from here.
- Edit your neovim configuration and add
zls
for zig filetypes:
let g:LanguageClient_serverCommands = {
\\ 'zig': ['/path/to/zls_executable'],
\\ }
- Install language support for Zig from here.
- 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 inLSP client's
GUI settings)
{
"servers": {
"zig": {
"command": ["/path/to/zls_executable"],
"url": "https://github.com/zigtools/zls",
"highlightingModeRegex": "^Zig$"
}
}
}
;; Setup lsp-mode as desired.
;; See https://emacs-lsp.github.io/lsp-mode/page/installation/ for more information.
(require 'lsp-mode)
;; Either place zls in your PATH or add the following:
(setq lsp-zig-zls-executable "/path/to/zls_executable")
- Enable
:tools lsp
module. - Enable
:lang (zig +lsp)
module. - Run
doom sync
in a terminal.
- Add
lsp
andzig
todotspacemacs-configuration-layers
in your.spacemacs
file. - If you don't have
zls
in yourPATH
, add the following todotspacemacs/user-config
in your.spacemacs
file:
(setq lsp-zig-zls-executable "/path/to/zls_executable")
Add zls
to your PATH
or manually specify the path in <config_dir>/helix/languages.toml
with the following:
[language-server.zls]
command = "/path/to/zls_executable"
Further information on languages.toml files
Then run hx --health
to check if helix found zls
.
Questions not answered by this wiki? Join our Discord server or start a discussion!