nix-community.nixvim/docs/user-guide/faq.md

48 lines
1.7 KiB
Markdown
Raw Normal View History

2024-02-18 15:56:18 +01:00
# Frequently Asked Questions
## How do I use a plugin not implemented in nixvim
Using a plugin not supported by nixvim, but packaged in nixpkgs is straightforward:
- Register the plugin through `extraPlugins`: `extraPlugins = [pkgs.vimPlugins."<plugin name>"]`.
- Configure the plugin through `extraConfigLua`: `extraConfigLua = "require('my-plugin').setup({foo = "bar"})";`
## How do I use a plugin not packaged in nixpkgs
This is straightforward too, you can add the following to `extraPlugins` for a plugin hosted on GitHub:
```nix
extraPlugins = [(pkgs.vimUtils.buildVimPlugin {
name = "my-plugin";
src = pkgs.fetchFromGitHub {
owner = "<owner>";
repo = "<repo>";
rev = "<commit hash>";
hash = "<nix NAR hash>";
};
})];
```
The [nixpkgs manual](https://nixos.org/manual/nixpkgs/stable/#managing-plugins-with-vim-packages) has more information on this.
## How do I solve `<name>` missing
When using NixVim it is possible to encounter an error of the type `attribute 'name' missing`, for example it could look like:
```
(stack trace truncated; use '--show-trace' to show the full trace)
error: attribute 'haskell-scope-highlighting-nvim' missing
at /nix/store/k897af00nzlz4ylxr5vakzpcvh6m3rnn-source/plugins/languages/haskell-scope-highlighting.nix:12:22:
11| originalName = "haskell-scope-highlighting.nvim";
12| defaultPackage = pkgs.vimPlugins.haskell-scope-highlighting-nvim;
| ^
13|
```
This usually means one of two things:
- The nixpkgs version is not in line with NixVim (for example nixpkgs nixos-23.11 is used with NixVim master)
- The nixpkgs unstable version used with NixVim is not recent enough.