Jump to content

Neovim: Difference between revisions

Neovim (view source)

Revision as of 05:32, 5 May 2024

1,619 bytes added ,  5 May
m
→‎Installing Plugins
VisualWikitext
imported>Jooooscha
m (Removed some white lines)
(23 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__TOC__
[https://neovim.io Neovim] is a fork of [[Vim]] aiming to improve the codebase, allowing for easier implementation of APIs, improved user experience and plugin implementation.


== Installation and configuration ==
== Installation ==


Neovim shares most of its configuration with Vim. See the [[Vim|Vim page]] for more details on the use of both.
=== With Home Manager ===
 
[[Home Manager]] has a module for Neovim, which can be enabled via
 
<syntaxhighlight lang="nix">
programs.neovim = {
  enable = true;
  extraConfig = ''
    set number relativenumber
  '';
};
</syntaxhighlight>
 
More information about the module can be found here: [https://nix-community.github.io/home-manager/options.xhtml#opt-programs.neovim.enable Home Manager Manual].
 
=== System-wide ===
 
If you do not use Home Manager, you can use the following code in your NixOS configuration:
 
<syntaxhighlight lang="nix">
programs.neovim = {
  enable = true;
  defaultEditor = true;
};
</syntaxhighlight>


=== With Home Manager ===
You can also manually add Neovim to your packages. This should only be used if the two version above do not work for you.


[https://nixos.wiki/wiki/Home_Manager Home Manager] has a module for Neovim, which can be enabled via
<syntaxhighlight lang="nix">
environment.systemPackages = [ pkgs.neovim ];
</syntaxhighlight>


  programs.neovim = {
== Configuration ==
    enable = true;
    extraConfig = ''
      set number relativenumber
    ''
  };


More information about the module can be found here: [https://nix-community.github.io/home-manager/options.html#opt-programs.neovim.enable Home Manager Manual].
Neovim shares most of its configuration with Vim. See the [[Vim|Vim page]] for more details on the use of both.


==== Configuration ====
=== With Home Manager ===


The Home Manager module does not expose many configuration options.
The Home Manager module does not expose many configuration options. Therefore, the easiest way to get started is to use the [https://nix-community.github.io/home-manager/options.html#opt-programs.neovim.extraConfig extraConfig] option.
Therefore, the easiest way to get started is to use the [https://nix-community.github.io/home-manager/options.html#opt-programs.neovim.extraConfig extraConfig] option.
You can copy your old config or directly load your default Neovim config via:
You can copy your old config or directly load your default Neovim config via:


  programs.neovim.extraConfig = lib.fileContents ../path/to/your/init.vim;
<syntaxhighlight lang="nix">
programs.neovim.extraConfig = lib.fileContents ../path/to/your/init.vim;
</syntaxhighlight>


To use Neovim as your default editor, you can set the <code>EDITOR</code> [https://search.nixos.org/options?show=environment.variables&type=packages&query=environment.variables environmental variable] to "nvim" by adding the following to your NixOS configuration:
To use Neovim as your default editor, you can set the <code>EDITOR</code> [https://search.nixos.org/options?show=environment.variables&type=packages&query=environment.variables environmental variable] to "nvim" by adding the following to your NixOS configuration:


  environment.variables.EDITOR = "nvim";
<syntaxhighlight lang="nix">
environment.variables.EDITOR = "nvim";
</syntaxhighlight>


The Home Manager module does also expose options to automatically add <code>vi</code> and <code>vim</code> aliases.
The Home Manager module does also expose options to automatically add <code>vi</code> and <code>vim</code> aliases.
To use them, add the following to your Home Manager configuration:
To use them, add the following to your Home Manager configuration:


  programs.neovim = {
<syntaxhighlight lang="nix">
    viAlias = true;
programs.neovim = {
    vimAlias = true;
  viAlias = true;
  };
  vimAlias = true;
};
</syntaxhighlight>


==== Installing Plugins ====
==== Installing Plugins ====
Line 43: Line 69:
You can add only the plugin, or the plugin with its corresponding config:
You can add only the plugin, or the plugin with its corresponding config:


  programs.neovim.plugins = [
<syntaxhighlight lang="nix">
    vimPlugins.nvim-tree-lua
programs.neovim.plugins = [
    {
  pkgs.vimPlugins.nvim-tree-lua
      plugin = vim-startify;
  {
      config = "let g:startify_change_to_vcs_root = 0";
    plugin = pkgs.vimPlugins.vim-startify;
    }
    config = "let g:startify_change_to_vcs_root = 0";
  ];
  }
];
</syntaxhighlight>


If you only add the plugin, you can add the configuration as described above.
If you only add the plugin, you can add the configuration as described above.


An index of official packages can be found in on [https://search.nixos.org/packages?from=0&size=50&sort=relevance&type=packages&query=vimPlugins search.nixos.org].
An index of official packages can be found in on [https://search.nixos.org/packages?from=0&size=50&sort=relevance&type=packages&query=vimPlugins search.nixos.org].
In addition to the official packages, there are several user maintained repositories, such as [https://github.com/m15a/nixpkgs-vim-extra-plugins vim-extra-plugins] or [https://github.com/NixNeovim/NixNeovimPlugins NixNeovimPlugins].
In addition to the official packages, there are several user maintained repositories, such as [https://github.com/m15a/flake-awesome-neovim-plugins awesome-neovim-plugins] or [https://github.com/NixNeovim/NixNeovimPlugins NixNeovimPlugins]. Plugins which are
 
not available in any of these repositories may be integrated using the <code>vimUtils.buildVimPlugin</code> function from Nixpkgs:
=== Without Home Manager ===
 
If you do not use Home Manager, you can use the following code in your NixOS configuration:


   programs.neovim = {
<syntaxhighlight lang="nix">
     enable = true;
pkgs.vimUtils.buildVimPlugin {
     defaultEditor = true;
  pname = "whatever";
   version = "whatever";
  src = builtins.fetchGit {
     url = "https://github.com/example/whatever.git";
     ref = "whatever";
   };
   };
  buildScript = ":";
}
</syntaxhighlight>


==== Configuration ====
=== System-wide ===


The NixOS module does not have an <code>extraConfig</code> option as the Home Manager module does.
The NixOS module does not have an <code>extraConfig</code> option as the Home Manager module does.
Instead, you can use the <code>programs.neovim.configure</code> option as described [https://search.nixos.org/options?show=programs.neovim.configure&type=packages&query=neovim here].
Instead, you can use the <code>programs.neovim.configure</code> option as described [https://search.nixos.org/options?show=programs.neovim.configure&type=packages&query=neovim here].


Similarly to the Home Manager module, to set Neovim as your default editor you have to set the <code>EDITOR</code> environment variable like this:
The following example configures RC commands and enables the plugin <code>ctrlp</code> to support fuzzy file search (see [https://github.com/ctrlpvim/ctrlp.vim homepage] on how to use it)
 
<syntaxhighlight lang="nix">
programs.neovim = {
  enable = true;
  configure = {
    customRC = ''
      set number
      set cc=80
      set list
      set listchars=tab:→\ ,space:·,nbsp:␣,trail:•,eol:¶,precedes:«,extends:»
      if &diff
        colorscheme blue
      endif
    '';
    packages.myVimPackage = with pkgs.vimPlugins; {
      start = [ ctrlp ];
    };
  };
};
</syntaxhighlight>
 
To set Neovim as your default editor:


  environment.variables.EDITOR = "nvim";
<syntaxhighlight lang="nix">
programs.neovim = {
  defaultEditor = true;
};
</syntaxhighlight>


Further, the NixOS module does also expose options to automatically add <code>vi</code> and <code>vim</code> aliases.
Further, the NixOS module does also expose options to automatically add <code>vi</code> and <code>vim</code> aliases.
To use them, add the following to your NixOS configuration:
To use them, add the following to your NixOS configuration:


  programs.neovim = {
<syntaxhighlight lang="nix">
    viAlias = true;
programs.neovim = {
    vimAlias = true;
  viAlias = true;
  };
  vimAlias = true;
 
};
=== Manually ===
</syntaxhighlight>
 
You can also manually add Neovim to your packages. This should only be used if the two version above do not work for you.


  environment.systemPackages = [ pkgs.neovim ];
== Tips and tricks ==


=== Build Neovim using Nix ===
=== Build Neovim using Nix ===
Line 96: Line 152:
You can run the master version via the following command:
You can run the master version via the following command:


  nix run github:neovim/neovim?dir=contrib
  nix run "github:neovim/neovim?dir=contrib"


Finally, there is a [https://github.com/nix-community/neovim-nightly-overlay Neovim Nightly Overlay].
Finally, there is a [https://github.com/nix-community/neovim-nightly-overlay Neovim Nightly Overlay].


== Note on Lua plugins  ==
=== Note on Lua plugins  ===


Due to how the `runtimepath` for Lua modules is [https://github.com/nanotee/nvim-lua-guide#a-note-about-packages processed], your configuration may require <code>packadd! plugin-name</code> to require a module. A home-manager example:
Due to how the `runtimepath` for Lua modules is [https://github.com/nanotee/nvim-lua-guide#a-note-about-packages processed], your configuration may require <code>packadd! plugin-name</code> to require a module. A home-manager example:


  programs.neovim = {
<syntaxhighlight lang="nix">
    plugins = [
programs.neovim = {
      {
  plugins = [
        plugin = nvim-colorizer-lua
    {
        config = ''
      plugin = pkgs.vimPlugins.nvim-colorizer-lua;
          packadd! nvim-colorizer.lua
      config = ''
          lua require 'colorizer'.setup()
        packadd! nvim-colorizer.lua
        '';
        lua << END
       }
require 'colorizer'.setup {
    ];
  '*'; -- Highlight all files, but customize some others.
  }
  '!vim'; -- Exclude vim from highlighting.
}
END
       '';
    }
  ];
}
</syntaxhighlight>


== See Also ==
== See Also ==
* [[Vim]]
* [[Vim]]
* [[Tree sitters]]
* [[Treesitter|Treesitter for Neovim]]


[[Category:Applications]]
[[Category:Applications]]
M15a
1

edit

Retrieved from "https://wiki.nixos.org/wiki/Special:MobileDiff/7466...12648"