doomemacs/modules/lang/zig/README.org

lang/zig

• Description
  • Maintainers
  • Module Flags
  • Plugins
• Prerequisites
• Features
  • LSP support
  • Keybinds
• Configuration
  • Customize zls path

Description

This module adds Zig support, with optional (but recommended) LSP support via zls.

• Syntax highlighting
• Syntax-checking (flycheck)
• Code completion and LSP integration (zls)

Maintainers

• @bnjmnt4n (Author)

Module Flags

• +lsp Enables integration for the zls LSP server. It is highly recommended you use this.

Plugins

• zig-mode

Prerequisites

To get started with Zig, you need the zig tool. Pre-built binaries for most systems are available for download from https://ziglang.org/download/ or from system package managers.

zls is a language server for Zig, which provides code completion,

Features

LSP support

This module supports LSP integration. For it to work you'll need:

1. zls installed.
2. The :tools lsp module enabled. Only lsp-mode is supported for now.
3. The +lsp flag on this module enabled.

Keybinds

Binding	Description
<localleader> b	zig-compile
<localleader> f	zig-format-buffer
<localleader> r	zig-run
<localleader> t	zig-test-buffer

Configuration

Customize zls path

To customize the path of the zls executable, modify lsp-zig-zls-executable.

;; in $DOOMDIR/config.el
(setq lsp-zig-zls-executable "~/path/to/zls")