doom-emacs/modules/lang/zig
Henrik Lissner 4fa9362224
docs(*): replace all-the-icons with nerd-icons
Also colorizes the leading icon in notices.
2024-05-21 17:16:13 +02:00
..
config.el feat(format): add :lang zig formatter 2024-05-21 17:16:00 +02:00
doctor.el fix(zig): correct doctor check 2024-05-21 17:16:09 +02:00
packages.el bump: :lang elm fsharp haskell lean lua purescript solidity web zig 2024-05-21 17:15:48 +02:00
README.org docs(*): replace all-the-icons with nerd-icons 2024-05-21 17:16:13 +02:00

:lang zig

Description   unfold

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

Module flags

+lsp
Enables integration for the zls LSP server. It is highly recommended you use this.
+tree-sitter
Leverages tree-sitter for better syntax highlighting and structural text editing. Requires doom-module::tools tree-sitter.

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

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,

TODO Usage

󱌣 This module's usage documentation is incomplete. Complete it?

LSP support

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

  1. zls installed,
  2. The doom-module::tools lsp module enabled. Only doom-package:lsp-mode is supported for now,
  3. The doom-module:+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

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

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

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?