NixOS Wiki

Neovim: Difference between revisions

← Older edit
VisualWikitext
Duob (talk | contribs)
2 edits
No edit summary
U32 (talk | contribs)
1 edit
mNo edit summary
 
(18 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{infobox application
  |name=Neovim
  |image=Neovim-mark.svg
  |type=Text Editor
  |developer=Neovim Core Team & Community
  |firstRelease=November 1, 2015
  |latestRelease=Nvim 0.11.2 (May 30, 2025)
  |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>
[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.
<!--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 [[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-->
It introduces a powerful plugin architecture that allows for asynchronous plugin execution, which can significantly improve performance for certain operations. It also includes a built-in terminal emulator, allowing users to run shell commands directly within the editor. The project emphasizes code quality and maintainability, with a clean, well-documented codebase that makes it easier for developers to contribute.
It introduces a powerful plugin architecture that allows for asynchronous plugin execution, which can significantly improve performance for certain operations. It also includes a built-in terminal emulator, allowing users to run shell commands directly within the editor. The project emphasizes code quality and maintainability, with a clean, well-documented codebase that makes it easier for developers to contribute.


== Installation ==
== Installation == <!--T:3-->


==== Using nix-shell ====
==== Shell ====
<syntaxhighlight lang="bash" start="3">
nix-shell -p neovim
</syntaxhighlight>


==== Using Global Configuration ====
To temporarily use Neovim in a shell environment without modifying your system configuration, you can run:
<syntaxhighlight lang="text">
{{code|lang=bash|line=no|1=$ nix-shell -p neovim}}
This makes the Neovim editor available in your current shell. You can then launch Neovim by typing <code>neovim</code>.
 
==== System setup ====
 
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
environment.systemPackages = [
environment.systemPackages = [
  pkgs.neovim
  pkgs.neovim
];
];
</syntaxhighlight>After modifying your configuration, apply the changes by running:<syntaxhighlight lang="bash">
sudo nixos-rebuild switch
</syntaxhighlight>


==== Using Home Configuration ====
# User-specific installation (in ~/.config/nixpkgs/home.nix)
<syntaxhighlight lang="text">
home.packages = [
home.packages = [  
   pkgs.neovim
   pkgs.neovim  
];}}
];
After rebuilding your system with <code>nixos-rebuild switch</code> or <code>home-manager switch</code>, Neovim will be installed and accessible.
</syntaxhighlight>After updating your configuration, apply the changes by running:<syntaxhighlight lang="bash">
 
home-manager switch
 
</syntaxhighlight>
== Configuration == <!--T:7-->


== Configuration ==
==== Basic ==== <!--T:8-->


==== Basic ====
</translate>
<syntaxhighlight lang="nix">
{{code|lang=nix|line=no|1=<translate>
<!--T:39-->
# Global Configuration
# Global Configuration
</translate>
programs.neovim = {
programs.neovim = {
   enable = true;
   enable = true;
Line 40: Line 62:
};
};


<translate>
<!--T:40-->
# Home Configuration
# Home Configuration
</translate>
programs.neovim = {
programs.neovim = {
   enable = true;
   enable = true;
Line 46: Line 71:
     set number relativenumber
     set number relativenumber
   '';
   '';
};
};}}
</syntaxhighlight>
<translate>
 
==== Advanced ==== <!--T:10-->


==== Advanced ====
</translate>
<syntaxhighlight lang="nix">
{{code|lang=nix|line=no|1=<translate>
<!--T:41-->
# Global Configuration
# Global Configuration
</translate>
programs.neovim = {
programs.neovim = {
   enable = true;
   enable = true;
Line 73: Line 102:
};
};


<translate>
<!--T:42-->
# Home Configuration
# Home Configuration
# 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:
environment.variables.EDITOR = "nvim";
</translate>
</syntaxhighlight>
environment.variables.EDITOR = "nvim";}}
<translate>


== Tips and Tricks ==
== Tips and Tricks == <!--T:12-->
{{expand}}


==== Location of Options ====
==== 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].
 
The global options are listed on [https://mynixos.com/search?q=nixpkgs%2Foption%2Fprograms.neovim MyNixOS].
 
==== Neovim Nightly ====
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.
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"}}


nix run "github:nix-community/neovim-nightly-overlay"
==== Plugin Management ==== <!--T:21-->


==== Pre-Configured Configurations ====
</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:
{{code|lang=nix|line=no|1=plugins = [
 
<translate>
* [https://www.lazyvim.org/ LazyVim]
  <!--T:49-->
* [https://astronvim.com/ AstroVim]
# Example Plugin: nvim-tree-lua
* [https://nvchad.com/ NVChad]
</translate>
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.
 
The configuration for LunarVim is stored in <code>./config/lvim</code>.
 
==== Plugin Management ====
<syntaxhighlight lang="nix">
plugins = [
  # Example Plugin: nvim-tree-lua
   pkgs.vimPlugins.nvim-tree-lua
   pkgs.vimPlugins.nvim-tree-lua


   # Example Plugin: vim-startify with configuration
<translate>
   <!--T:50-->
# Example Plugin: vim-startify with configuration
</translate>
   {
   {
     plugin = pkgs.vimPlugins.vim-startify;
     plugin = pkgs.vimPlugins.vim-startify;
Line 114: Line 138:
   }
   }


   # Example Plugin: nvim-colorizer-lua with Lua config
<translate>
   # Due to how the runtimepath for Lua modules is processed, your configuration may require  
   <!--T:51-->
# Example Plugin: nvim-colorizer-lua with Lua config
   # 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>
   {
   {
     plugin = pkgs.vimPlugins.nvim-colorizer-lua;
     plugin = pkgs.vimPlugins.nvim-colorizer-lua;
Line 123: Line 150:
       lua << END
       lua << END
         require 'colorizer'.setup {
         require 'colorizer'.setup {
           '*'; -- Highlight all files, but customize some others.
           '*';<translate> <!--T:52--> -- Highlight all files, but customize some others.</translate>
           '!vim'; -- Exclude vim from highlighting.
           '!vim';<translate> <!--T:53--> -- Exclude vim from highlighting.</translate>
         }
         }
       END
       END
Line 130: Line 157:
   }
   }


   # Example Plugin: nvim-treesitter with Lua config
<translate>
   <!--T:54-->
# Example Plugin: nvim-treesitter with Lua config
</translate>
   {
   {
     plugin = pkgs.vimPlugins.nvim-treesitter;
     plugin = pkgs.vimPlugins.nvim-treesitter;
Line 138: Line 168:
         require'nvim-treesitter.configs'.setup {
         require'nvim-treesitter.configs'.setup {
           highlight = {
           highlight = {
             enable = true,              -- false will disable the whole extension
             enable = true,              <translate><!--T:55--> -- false will disable the whole extension</translate>
             disable = {},              -- list of languages that will be disabled
             disable = {},              <translate><!--T:56--> -- list of languages that will be disabled</translate>
           },
           },
           incremental_selection = {
           incremental_selection = {
Line 167: Line 197:
   }
   }


   # Installing grammars for tree-sitter
<translate>
   <!--T:57-->
# Installing grammars for tree-sitter
   # Option 1: Install all grammar packages
   # Option 1: Install all grammar packages
   pkgs.vimPlugins.nvim-treesitter.withAllGrammars
   pkgs.vimPlugins.nvim-treesitter.withAllGrammars
Line 174: Line 206:
   # (pkgs.vimPlugins.nvim-treesitter.withPlugins (p: [ p.c p.java ]))
   # (pkgs.vimPlugins.nvim-treesitter.withPlugins (p: [ p.c p.java ]))


   # Option 3: Installing grammars without Nix
   <!--T:58-->
   # Installing grammar packages through the built-in command can lead to errors.  
# Option 3: Installing grammars without Nix
   # 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>
</syntaxhighlight>
];}}
<translate>
 
==== Frameworks ==== <!--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>
 
<!--T:46-->
* [https://astronvim.com/ AstroNvim]<ref>AstroNvim Team, "AstroNvim", AstroNvim Official Website, N/A, Accessed June 2025. https://astronvim.com/</ref>
 
<!--T:47-->
* [https://nvchad.com/ NVChad]<ref>Siduck, "NvChad", NvChad Official Website, © 2025, Accessed June 2025. https://nvchad.com/</ref>
 
<!--T:48--> ==== FHS wrapper ====
 
You can create a custom neovim FHS wrapper
{{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-->
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].
 
== Troubleshooting == <!--T:59-->
{{expand}}
 
==== lua-language-server: Dynamically linked executable error ====
 
In your <code>~/.local/state/nvim/lsp.log</code>, you have the following error:
 
{{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-->
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 ==
 
* [[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.
* [https://github.com/nix-community/neovim-overlay Neovim Overlay on Nixpkgs] – For nightly builds and additional Neovim packages.


== References ==
== References ==


# https://neovim.io/
</translate>
# https://github.com/neovim/neovim
# https://nix-community.github.io/home-manager/options.xhtml#opt-programs.neovim.enable
# https://mynixos.com/search?q=nixpkgs%2Foption%2Fprograms.neovim
# https://github.com/m15a/flake-awesome-neovim-plugins
# https://github.com/NixNeovim/NixNeovimPlugins
# https://www.lazyvim.org/
# https://astronvim.com/
# https://nvchad.com/


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