Official NixOS Wiki

Neovim: Difference between revisions

← Older edit
DHCP (talk | contribs)
85 edits
VisualWikitext
Jopejoe1 (talk | contribs)
trusted
135 edits
Marked this version for translation
DHCP (talk | contribs)
85 edits
m →Tips and Tricks: style: fix headings case
 
(30 intermediate revisions by 13 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
  |name=Neovim
  |image=Neovim-mark.svg
  |type=Text Editor
  |developer=Neovim Core Team & Community
  |firstRelease=November 1, 2015
  |latestRelease=Nvim 0.12.2 (April 22, 2026)
  |status=Active
  |license=[https://www.apache.org/licenses/LICENSE-2.0 Apache 2.0] (with parts under Vim license)
  |os=Cross-platform (Linux, macOS, Windows)
  |platform=Desktop
  |programmingLanguage=C, Lua, Vim Script
  |website=[https://neovim.io/ neovim.io]
  |github=neovim/neovim
  |bugTracker=[https://github.com/neovim/neovim/issues GitHub Issues]
  |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-->
[https://neovim.io/ Neovim] is a highly extensible and open source text editor that aims to improve upon and modernize the popular [[Vim]] 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 <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.


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


==== Using nix-shell ==== <!--T:4-->
==== Shell ==== <!--T:4-->


<!--T:60-->
To temporarily use Neovim in a shell environment without modifying your system configuration, you can run:
</translate>
</translate>
<syntaxhighlight lang="bash" start="3">
 
nix-shell -p neovim
<syntaxhighlight lang="console">
$ nix-shell -p neovim
</syntaxhighlight>
</syntaxhighlight>
<translate>
==== Using Global Configuration ==== <!--T:5-->


</translate>
<syntaxhighlight lang="text">
environment.systemPackages = [
  pkgs.neovim
];
</syntaxhighlight>
<translate>
<translate>
<!--T:61-->
This makes the Neovim editor available in your current shell. You can then launch Neovim by typing <code>nvim</code>.


<!--T:37-->
==== System setup ==== <!--T:62-->
After modifying your configuration, apply the changes by running:


<!--T:63-->
To install Neovim system-wide, making it available to all users, add the following to your configuration:
</translate>
</translate>
<syntaxhighlight lang="bash">
sudo nixos-rebuild switch
</syntaxhighlight>
<translate>


==== Using Home Configuration ==== <!--T:6-->
{{code|lang=nix|line=no|1=<translate><!--T:64--> # Example for /etc/nixos/configuration.nix</translate>
 
environment.systemPackages = [
</translate>
   pkgs.neovim
<syntaxhighlight lang="text">
home.packages = [  
   pkgs.neovim  
];
];
</syntaxhighlight>
<translate>


<!--T:38-->
<translate><!--T:65--> # User-specific installation (in ~/.config/nixpkgs/home.nix)</translate>
After updating your configuration, apply the changes by running:
home.packages = [
  pkgs.neovim
];}}


</translate>
<syntaxhighlight lang="bash">
home-manager switch
</syntaxhighlight>
<translate>
<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.


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


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


</translate>
{{code|lang=nix|line=no|1=<translate>
<syntaxhighlight lang="nix">
<translate>
<!--T:39-->
<!--T:39-->
# Global Configuration
# Global Configuration
Line 79: Line 88:
     set number relativenumber
     set number relativenumber
   '';
   '';
};
};}}
</syntaxhighlight>
 
<translate>
<translate>
==== Advanced ==== <!--T:10-->
==== Advanced ==== <!--T:10-->
</translate>


</translate>
{{code|lang=nix|line=no|1=<translate>
<syntaxhighlight lang="nix">
<translate>
<!--T:41-->
<!--T:41-->
# Global Configuration
# Global Configuration
Line 117: 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;}}
</syntaxhighlight>
 
<translate>
<translate>
<!--T:12-->
== Tips and tricks ==
{{expand}}


== Tips and Tricks == <!--T:12-->
==== Nix configuration frameworks ====


==== Location of Options ==== <!--T:13-->
[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.


<!--T:43-->
==== Package variations ==== <!--T:15-->
The home manager options are defined in the following [https://nix-community.github.io/home-manager/options.xhtml#opt-programs.neovim.enable Home Manager Options Manual].
 
<!--T:14-->
The global options are listed on [https://mynixos.com/search?q=nixpkgs%2Foption%2Fprograms.neovim MyNixOS].
 
==== Neovim Nightly ==== <!--T:15-->


<!--T:44-->
<!--T:44-->
Have a look at the [https://github.com/nix-community/neovim-nightly-overlay Neovim Nightly Overlay] 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-->
<!--T:16-->
You can run the master version via the following command:
You can run the master version via the following command:
</translate>


<!--T:17-->
nix run "github:nix-community/neovim-nightly-overlay"


==== Pre-Configured Configurations ==== <!--T:18-->
<syntaxhighlight lang="console">
$ nix run "github:nix-community/neovim-nightly-overlay"
</syntaxhighlight>


<!--T:45-->
<translate>
If you prefer not to configure your system manually, NixOS offers several predefined configurations and community-supported options. Here are a few of them:
==== Plugin management ==== <!--T:21-->
 
</translate>
<!--T:19-->
* [https://www.lazyvim.org/ LazyVim]
 
<!--T:46-->
* [https://astronvim.com/ AstroVim]
 
<!--T:47-->
* [https://nvchad.com/ NVChad]
 
<!--T:48-->
Another excellent option is [https://www.lunarvim.org/docs/installation LunarVim]. 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:20-->
The configuration for LunarVim is stored in <code>./config/lvim</code>.


==== Plugin Management ==== <!--T:21-->
{{code|lang=nix|line=no|1=plugins = [
 
</translate>
<syntaxhighlight lang="nix">
plugins = [
<translate>
<translate>
   <!--T:49-->
   <!--T:49-->
Line 185: Line 173:
   <!--T:51-->
   <!--T:51-->
# Example Plugin: nvim-colorizer-lua with Lua config
# Example Plugin: nvim-colorizer-lua with Lua config
   # Due to how the runtimepath for Lua modules is processed, your configuration may require  
   # Due to how the runtimepath for Lua modules is processed, your configuration may require
   # packadd! plugin-name to require a module. A home-manager example:
   # packadd! plugin-name to require a module. A home-manager example:
</translate>
</translate>
Line 252: Line 240:
   <!--T:58-->
   <!--T:58-->
# Option 3: Installing grammars without Nix
# Option 3: Installing grammars without Nix
   # Installing grammar packages through the built-in command can lead to errors.  
   # Installing grammar packages through the built-in command can lead to errors.
   # The following Neovim command will install syntax highlighting for the C programming language: :TSInstall c
   # The following Neovim command will install syntax highlighting for the C programming language: :TSInstall c
</translate>
</translate>
];
];}}
</syntaxhighlight>
 
<translate>
==== Pre-made distributions ==== <!--T:18-->
 
<!--T:45-->
If you prefer not to configure your system manually, NixOS offers several predefined configurations and community-supported options. Here are a few of them:
 
<!--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://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:77-->
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>
 
{{code|lang=lua|line=no|1=
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
}}
 
<translate>
<!--T:78-->
[https://github.com/folke/lazy.nvim/issues/402#issuecomment-2084997594 Source]
 
==== FHS wrapper ==== <!--T:67-->
 
<!--T:68-->
You can create a custom neovim FHS wrapper
</translate>
 
{{code|lang=nix|line=no|1=
{
  buildFHSEnv,
  writeShellScript,
  neovim,
}:
buildFHSEnv {
  name = "nvim-fhs";
  targetPkgs = pkgs: [ neovim ];
 
  runScript = writeShellScript "nvim-fhs.sh" ''
    exec ${neovim}/bin/nvim "$@"
  '';
}
}}
 
<!--T:FHS_WRAPPER_SOURCE-->
<translate>
<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>.
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].
<!--T:59-->
== Troubleshooting ==
{{expand}}


== References == <!--T:27-->
==== 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:
</translate>
</translate>


# https://neovim.io/
{{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"}}
# https://github.com/neovim/neovim
 
# https://nix-community.github.io/home-manager/options.xhtml#opt-programs.neovim.enable
<!--T:LUA_LS_SO_REF-->
# https://mynixos.com/search?q=nixpkgs%2Foption%2Fprograms.neovim
<translate>
# https://github.com/m15a/flake-awesome-neovim-plugins
<!--T:72-->
# https://github.com/NixNeovim/NixNeovimPlugins
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>.
# https://www.lazyvim.org/
 
# https://astronvim.com/
== See also == <!--T:73-->
# https://nvchad.com/
 
<!--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]
* [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://discourse.nixos.org/search?q=neovim Neovim discussions on NixOS Discourse] – Community tips, troubleshooting, and use cases.
 
== References == <!--T:27-->
</translate>


[[Category:Applications]]
[[Category:Applications]]
[[Category:CLI Applications]]
[[Category:Text Editor]]
[[Category:Text Editor]]
Retrieved from "https://wiki.nixos.org/wiki/Neovim"