README.org

:lang nix

Description

This module adds support for the Nix language to Doom Emacs, along with tools for managing Nix(OS).

Includes:

• Syntax highlighting
• Completion through doom-package:company and/or doom-package:helm
• Nix option lookup
• Formatting (nixfmt)

Maintainers

• @hlissner

Become a maintainer?

Module flags

+tree-sitter

Leverages tree-sitter for better syntax highlighting and structural text editing. Requires doom-module::tools tree-sitter.

+lsp

Enable an LSP hook for nix-mode. Requires doom-module::tools lsp and a language server (one of either nil or rnix-lsp).

You can still start a nix lsp manually without this flag, this just adds a hook to always start the lsp when loading nix-mode.

Packages

• doom-package:company-nixos-options if doom-module::completion company
• doom-package:helm-nixos-options if doom-module::completion helm
• doom-package:nix-mode
• doom-package:nix-update

Hacks

No hacks documented for this module.

Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires:

• The Nix package manager, for a variety of its features (besides syntax highlighting).
• nixfmt, for automatic formatting (requires doom-module::editor format).
• MacOS: TODO
• Arch Linux: TODO
• NixOS: in pkgs.nixfmt

Usage

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

Keybindings

Binding	Description
<localleader> b	nix-build
<localleader> f	nix-update-fetch
<localleader> o	+nix/lookup-option
<localleader> p	nix-format-buffer
<localleader> r	nix-repl-show
<localleader> s	nix-repl-shell
<localleader> u	nix-unpack

Configuration

󱌣 This module has no configuration documentation yet. Write some?

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?