037b018cdd
These optional dotfiles indicate the root of a module or module group (:lang), and will later contain module metadata. They will also serve as an alternative to packages.el and doctor.el, and will aide the parts of the v3.0 module API concerned with resolving the current module from a path (`doom-module-from-path`), which currently rely too heavily on parsing path strings. For now, however, they're simply placeholders. |
||
|---|---|---|
| .. | ||
| .doommodule | ||
| config.el | ||
| doctor.el | ||
| packages.el | ||
| README.org | ||
:lang zig
Description unfold
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
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
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:
- zls installed,
- The doom-module::tools lsp module enabled. Only doom-package:lsp-mode is supported for now,
- 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?