Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 2.71 KB

README.org

File metadata and controls

87 lines (67 loc) · 2.71 KB

:lang zig

Description

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

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

Maintainers

  • @bnjmnt4n

Become a maintainer?

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.

Packages

  • doom-package:zig-mode

Hacks

No hacks documented for this module.

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,

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

BindingDescription
<localleader> bzig-compile
<localleader> fzig-format-buffer
<localleader> rzig-run
<localleader> tzig-test-buffer

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?

Appendix

󱌣 This module has no appendix yet. Write one?