Official NixOS Wiki

Neovim: Difference between revisions

← Older edit
DHCP (talk | contribs)
85 edits
VisualWikitext
m Fix link to Nix Search site
DHCP (talk | contribs)
85 edits
m →Tips and Tricks: style: fix headings case
 
(18 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{low quality|reason=<translate>Most of the provided nix code snippets look out of context, lacking indication where the provided configuration belongs (e.g. home-manager, configuration.nix or elsewhere?). [[#Beginning]] is over too wordy.</translate>}}
{{infobox application
{{infobox application
   |name=Neovim
   |name=Neovim
Line 6: Line 7:
   |developer=Neovim Core Team & Community
   |developer=Neovim Core Team & Community
   |firstRelease=November 1, 2015
   |firstRelease=November 1, 2015
   |latestRelease=Nvim 0.11.2 (May 30, 2025)
   |latestRelease=Nvim 0.12.2 (April 22, 2026)
   |status=Active
   |status=Active
   |license=[https://www.apache.org/licenses/LICENSE-2.0 Apache 2.0] (with parts under Vim license)
   |license=[https://www.apache.org/licenses/LICENSE-2.0 Apache 2.0] (with parts under Vim license)
Line 17: Line 18:
   |documentation=[https://neovim.io/doc/ Official Documentation]
   |documentation=[https://neovim.io/doc/ Official Documentation]
}}
}}
<translate>
<translate>
<!--T:76-->
:''See also: <tvar name=vim>[[Special:MyLanguage/Vim|Vim]]</tvar>''
<!--T:1-->
<!--T:1-->
:''See also: [[Vim]]''
[https://neovim.io/ Neovim]<ref>Neovim Team, "Home - Neovim", Neovim Official Website, Last updated March 2025, Accessed June 2025. https://neovim.io/</ref> is a highly extensible and open source text editor that aims to improve upon and modernize the popular <tvar name=vim>[[Special:MyLanguage/Vim|Vim]]</tvar><ref>NixOS Wiki Community, "Vim", NixOS Wiki, Last edited 24 February 2025, Accessed June 2025. https://wiki.nixos.org/wiki/Vim</ref> editor. It's designed to be a drop-in replacement for Vim, maintaining compatibility with most Vim plugins and configurations while offering additional features and improvements. Neovim focuses on extensibility, usability, and performance.
[https://neovim.io/ Neovim]<ref>Neovim Team, "Home - Neovim", Neovim Official Website, Last updated March 2025, Accessed June 2025. https://neovim.io/</ref> is a highly extensible and open source text editor that aims to improve upon and modernize the popular [[Vim]]<ref>NixOS Wiki Community, "Vim", NixOS Wiki, Last edited 24 February 2025, Accessed June 2025. https://wiki.nixos.org/wiki/Vim</ref> editor. It's designed to be a drop-in replacement for Vim, maintaining compatibility with most Vim plugins and configurations while offering additional features and improvements. Neovim focuses on extensibility, usability, and performance.


<!--T:2-->
<!--T:2-->
Line 27: Line 31:
== Installation == <!--T:3-->
== Installation == <!--T:3-->


==== Shell ====
==== Shell ==== <!--T:4-->


<!--T:60-->
To temporarily use Neovim in a shell environment without modifying your system configuration, you can run:
To temporarily use Neovim in a shell environment without modifying your system configuration, you can run:
{{code|lang=bash|line=no|1=$ nix-shell -p neovim}}
</translate>
This makes the Neovim editor available in your current shell. You can then launch Neovim by typing <code>neovim</code>.
 
<syntaxhighlight lang="console">
$ nix-shell -p neovim
</syntaxhighlight>


==== System setup ====
<translate>
<!--T:61-->
This makes the Neovim editor available in your current shell. You can then launch Neovim by typing <code>nvim</code>.


==== System setup ==== <!--T:62-->
<!--T:63-->
To install Neovim system-wide, making it available to all users, add the following to your configuration:
To install Neovim system-wide, making it available to all users, add the following to your configuration:
{{code|lang=nix|line=no|1=# Example for /etc/nixos/configuration.nix
</translate>
 
{{code|lang=nix|line=no|1=<translate><!--T:64--> # Example for /etc/nixos/configuration.nix</translate>
environment.systemPackages = [
environment.systemPackages = [
   pkgs.neovim
   pkgs.neovim
];
];


# User-specific installation (in ~/.config/nixpkgs/home.nix)
<translate><!--T:65--> # User-specific installation (in ~/.config/nixpkgs/home.nix)</translate>
home.packages = [
home.packages = [
   pkgs.neovim
   pkgs.neovim
];}}
];}}
<translate>
<!--T:66-->
After rebuilding your system with <code>nixos-rebuild switch</code> or <code>home-manager switch</code>, Neovim will be installed and accessible.
After rebuilding your system with <code>nixos-rebuild switch</code> or <code>home-manager switch</code>, Neovim will be installed and accessible.


== Configuration == <!--T:7-->
== Configuration == <!--T:7-->


==== Basic ==== <!--T:8-->
==== Basic ==== <!--T:8-->
</translate>


</translate>
{{code|lang=nix|line=no|1=<translate>
{{code|lang=nix|line=no|1=<translate>
<!--T:39-->
<!--T:39-->
Line 72: Line 89:
   '';
   '';
};}}
};}}
<translate>
<translate>
==== Advanced ==== <!--T:10-->
==== Advanced ==== <!--T:10-->
</translate>


</translate>
{{code|lang=nix|line=no|1=<translate>
{{code|lang=nix|line=no|1=<translate>
<!--T:41-->
<!--T:41-->
Line 107: Line 124:
# You have to add the line below to set it as the default editor:
# You have to add the line below to set it as the default editor:
</translate>
</translate>
environment.variables.EDITOR = "nvim";}}
programs.neovim.defaultEditor = true;}}
 
<translate>
<translate>
<!--T:12-->
== Tips and tricks ==
{{expand}}


== Tips and Tricks == <!--T:12-->
==== Nix configuration frameworks ====
{{expand}}
 
[https://github.com/nix-community/nixvim Nixvim] and [https://github.com/NotAShelf/nvf nvf] provide a framework for declaratively configuring neovim with [[Nix (language)|Nix]]. They support, among the other things, plugin configuration, as well as mixing in plain Lua config snippets.
Linux and Darwin platforms are supported using standalone Nix, [[NixOS]] or [[Home Manager]] modules.


==== Package Variations ==== <!--T:15-->
==== Package variations ==== <!--T:15-->


<!--T:44-->
Have a look at the [https://github.com/nix-community/neovim-nightly-overlay Neovim Nightly Overlay]<ref>Nix Community, "neovim-nightly-overlay", GitHub, Last updated June 2025, Accessed June 2025. https://github.com/nix-community/neovim-nightly-overlay</ref> to install the most recent current nightly version of Neovim.
Have a look at the [https://github.com/nix-community/neovim-nightly-overlay Neovim Nightly Overlay]<ref>Nix Community, "neovim-nightly-overlay", GitHub, Last updated June 2025, Accessed June 2025. https://github.com/nix-community/neovim-nightly-overlay</ref> to install the most recent current nightly version of Neovim.
<!--T:16-->
You can run the master version via the following command:
You can run the master version via the following command:
{{code|lang=bash|line=no|1=$ nix run "github:nix-community/neovim-nightly-overlay"}}
</translate>


==== Plugin Management ==== <!--T:21-->


<syntaxhighlight lang="console">
$ nix run "github:nix-community/neovim-nightly-overlay"
</syntaxhighlight>
<translate>
==== Plugin management ==== <!--T:21-->
</translate>
</translate>
{{code|lang=nix|line=no|1=plugins = [
{{code|lang=nix|line=no|1=plugins = [
<translate>
<translate>
Line 212: Line 244:
</translate>
</translate>
];}}
];}}
<translate>
<translate>
 
==== Pre-made distributions ==== <!--T:18-->
==== Frameworks ==== <!--T:18-->


<!--T:45-->
<!--T:45-->
Line 221: Line 253:
<!--T:19-->
<!--T:19-->
* [https://www.lazyvim.org/ LazyVim]<ref>LazyVim Team, "Getting Started", LazyVim Official Website, © 2025, Accessed June 2025. https://www.lazyvim.org/</ref>
* [https://www.lazyvim.org/ LazyVim]<ref>LazyVim Team, "Getting Started", LazyVim Official Website, © 2025, Accessed June 2025. https://www.lazyvim.org/</ref>
* [https://astronvim.com/ AstroNvim]<ref>AstroNvim Team, "AstroNvim", AstroNvim Official Website, N/A, Accessed June 2025. https://astronvim.com/</ref>
* [https://nvchad.com/ NVChad]<ref>Siduck, "NvChad", NvChad Official Website, © 2025, Accessed June 2025. https://nvchad.com/</ref>


<!--T:46-->
<!--T:77-->
* [https://astronvim.com/ AstroVim]<ref>AstroNvim Team, "AstroNvim", AstroNvim Official Website, N/A, Accessed June 2025. https://astronvim.com/</ref>
LazyVim, by default, will prevent loading plugins that are not managed by LazyVim. This includes all plugins installed via Nix. If you want to install plugins with both Nix and LazyVim, add the following to your LazyVim setup:
</translate>


<!--T:47-->
{{code|lang=lua|line=no|1=
* [https://nvchad.com/ NVChad]<ref>Siduck, "NvChad", NvChad Official Website, © 2025, Accessed June 2025. https://nvchad.com/</ref>
require("lazy").setup(lazyPackages, {
  performance = {
    reset_packpath = false, -- so that plugins outside of lazy can be loaded
  },
})
vim.cmd("packloadall") -- load plugins outside of lazy
}}


<!--T:48-->
<translate>
Another excellent option is [https://www.lunarvim.org/docs/installation LunarVim]<ref>LunarVim Team, "Installation", LunarVim Documentation, Version 1.4, Accessed June 2025. https://www.lunarvim.org/docs/installation</ref>. The development community describes it as "an IDE layer for Neovim with sane defaults." LunarVim includes an installer/updater for LSP modules and other features. It can be installed via the <code>lunarvim</code> package from <code>nixpkgs</code> and is started with the <code>lvim</code> command.
<!--T:78-->
[https://github.com/folke/lazy.nvim/issues/402#issuecomment-2084997594 Source]


<!--T:20-->
==== FHS wrapper ==== <!--T:67-->
The configuration for LunarVim is stored in <code>./config/lvim</code>.


==== FHS wrapper ====
<!--T:68-->
You can create a custom neovim FHS wrapper
</translate>


You can create a custom neovim FHS wrapper
{{code|lang=nix|line=no|1=
{{code|lang=nix|line=no|1=
{
{
Line 254: Line 296:


<!--T:FHS_WRAPPER_SOURCE-->
<!--T:FHS_WRAPPER_SOURCE-->
<translate>
<!--T:69-->
This FHS wrapper example is based on a contribution to nixpkgs<ref name="nixpkgs-pr-334032">NixOS, "Feature: Custom Neovim FHS Wrapper" (Pull Request #334032), GitHub, 2025, Accessed June 2025. https://github.com/NixOS/nixpkgs/pull/334032</ref>.
This FHS wrapper example is based on a contribution to nixpkgs<ref name="nixpkgs-pr-334032">NixOS, "Feature: Custom Neovim FHS Wrapper" (Pull Request #334032), GitHub, 2025, Accessed June 2025. https://github.com/NixOS/nixpkgs/pull/334032</ref>.
For an extended configuration that includes setting up `mason.nvim` with a similar FHS environment, see this [https://github.com/NixOS/nixpkgs/issues/281219#issuecomment-2284713258 NixOS/nixpkgs issue comment].
For an extended configuration that includes setting up <code>mason.nvim</code> with a similar FHS environment, see this [https://github.com/NixOS/nixpkgs/issues/281219#issuecomment-2284713258 NixOS/nixpkgs issue comment].


== Troubleshooting == <!--T:59-->
<!--T:59-->
== Troubleshooting ==
{{expand}}
{{expand}}


==== lua-language-server: Dynamically linked executable error ====
==== lua-language-server: Dynamically linked executable error ==== <!--T:70-->


<!--T:71-->
In your <code>~/.local/state/nvim/lsp.log</code>, you have the following error:
In your <code>~/.local/state/nvim/lsp.log</code>, you have the following error:
</translate>


{{code|lang=text|line=no|1=[ERROR][2025-06-07 23:13:15] ...p/_transport.lua:36 "rpc" "lua-language-server" "stderr" "Could not start dynamically linked executable: /home/incogshift/.local/share/nvim/mason/packages/lua-language-server/libexec/bin/lua-language-server\nNixOS cannot run dynamically linked executables intended for generic\nlinux environments out of the box. For more information, see:\nhttps://nix.dev/permalink/stub-ld\n"}}
{{code|lang=text|line=no|1=[ERROR][2025-06-07 23:13:15] ...p/_transport.lua:36 "rpc" "lua-language-server" "stderr" "Could not start dynamically linked executable: /home/incogshift/.local/share/nvim/mason/packages/lua-language-server/libexec/bin/lua-language-server\nNixOS cannot run dynamically linked executables intended for generic\nlinux environments out of the box. For more information, see:\nhttps://nix.dev/permalink/stub-ld\n"}}


<!--T:LUA_LS_SO_REF-->
<!--T:LUA_LS_SO_REF-->
<translate>
<!--T:72-->
A solution for this issue can be found on Stack Overflow<ref name="so-lua-ls-dynlink">Stack Overflow Contributor, "Answer to 'Could not start dynamically linked executable... on NixOS'", Stack Overflow, 2025, Accessed June 2025. https://stackoverflow.com/a/78215911/27134695</ref>.
A solution for this issue can be found on Stack Overflow<ref name="so-lua-ls-dynlink">Stack Overflow Contributor, "Answer to 'Could not start dynamically linked executable... on NixOS'", Stack Overflow, 2025, Accessed June 2025. https://stackoverflow.com/a/78215911/27134695</ref>.


== References == <!--T:27-->
== See also == <!--T:73-->
 
== See also ==


<!--T:74-->
* [[Home Manager]] – For declarative Neovim configuration at the user level: [https://nix-community.github.io/home-manager/options.html#opt-programs.neovim.enable Neovim module in Home Manager]
* [[Home Manager]] – For declarative Neovim configuration at the user level: [https://nix-community.github.io/home-manager/options.html#opt-programs.neovim.enable Neovim module in Home Manager]
* [https://neovim.io/doc/ Official Documentation] – Official Neovim documentation.
* [https://neovim.io/doc/ Official Documentation] – Official Neovim documentation.
* [https://search.nixos.org/options?channel=unstable&query=programs.neovim NixOS options for Neovim] – System-level Neovim configuration.
* [https://search.nixos.org/options?channel=unstable&query=programs.neovim NixOS options for Neovim] – System-level Neovim configuration.
* [https://discourse.nixos.org/search?q=neovim Neovim discussions on NixOS Discourse] – Community tips, troubleshooting, and use cases.
* [https://discourse.nixos.org/search?q=neovim Neovim discussions on NixOS Discourse] – Community tips, troubleshooting, and use cases.
* [https://github.com/nix-community/neovim-overlay Neovim Overlay on Nixpkgs] – For nightly builds and additional Neovim packages.
== References ==


== References == <!--T:27-->
</translate>
</translate>


Retrieved from "https://wiki.nixos.org/wiki/Neovim"