Neovim: Difference between revisions
imported>Jooooscha I reorganized the description and added some information and distinctions between using Neovim with/without Home Manager |
Marked this version for translation |
||
(43 intermediate revisions by 15 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> | |||
<translate> | |||
<!--T:1--> | |||
[https://neovim.io/ Neovim]<ref>Neovim Team, "Home - Neovim", Neovim Official Website, N/A. 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, Vim. 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. | |||
== Installation | == Installation == <!--T:3--> | ||
==== Using nix-shell ==== <!--T:4--> | |||
</translate> | |||
<syntaxhighlight lang="bash" start="3"> | |||
nix-shell -p neovim | |||
</syntaxhighlight> | |||
<translate> | |||
=== | ==== Using Global Configuration ==== <!--T:5--> | ||
[ | </translate> | ||
<syntaxhighlight lang="text"> | |||
environment.systemPackages = [ | |||
pkgs.neovim | |||
]; | |||
</syntaxhighlight> | |||
<translate> | |||
<!--T:37--> | |||
After modifying your configuration, apply the changes by running: | |||
</translate> | |||
<syntaxhighlight lang="bash"> | |||
sudo nixos-rebuild switch | |||
</syntaxhighlight> | |||
<translate> | |||
==== Using Home Configuration ==== <!--T:6--> | |||
</translate> | |||
<syntaxhighlight lang="text"> | |||
home.packages = [ | |||
pkgs.neovim | |||
]; | |||
</syntaxhighlight> | |||
<translate> | |||
<!--T:38--> | |||
After updating your configuration, apply the changes by running: | |||
= | </translate> | ||
<syntaxhighlight lang="bash"> | |||
home-manager switch | |||
</syntaxhighlight> | |||
<translate> | |||
== Configuration == <!--T:7--> | |||
==== Basic ==== <!--T:8--> | |||
</translate> | |||
<syntaxhighlight lang="nix"> | |||
<translate> | |||
<!--T:39--> | |||
# Global Configuration | |||
</translate> | |||
programs.neovim = { | |||
enable = true; | |||
defaultEditor = true; | |||
}; | |||
<translate> | |||
<!--T:40--> | |||
# Home Configuration | |||
</translate> | |||
programs.neovim = { | |||
enable = true; | |||
extraConfig = '' | |||
set number relativenumber | |||
''; | |||
}; | |||
</syntaxhighlight> | |||
<translate> | |||
==== Advanced ==== <!--T:10--> | |||
</translate> | |||
<syntaxhighlight lang="nix"> | |||
<translate> | |||
<!--T:41--> | |||
# Global Configuration | |||
</translate> | |||
programs.neovim = { | |||
enable = true; | |||
defaultEditor = true; | |||
viAlias = true; | |||
vimAlias = 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 ]; | |||
}; | |||
}; | }; | ||
}; | |||
= | <translate> | ||
<!--T:42--> | |||
# Home Configuration | |||
# You have to add the line below to set it as the default editor: | |||
</translate> | |||
environment.variables.EDITOR = "nvim"; | |||
</syntaxhighlight> | |||
<translate> | |||
== Tips and Tricks == <!--T:12--> | |||
==== Location of Options ==== <!--T:13--> | |||
<!--T:43--> | |||
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]<ref>Nix Community, "Home Manager Option Search", Nix Community GitHub Pages, N/A. https://nix-community.github.io/home-manager/options.xhtml#opt-programs.neovim.enable</ref>. | |||
<!--T:14--> | |||
The global options are listed on [https://mynixos.com/search?q=nixpkgs%2Foption%2Fprograms.neovim MyNixOS]<ref>MyNixOS Team, "Search: nixpkgs/option/programs.neovim", MyNixOS, N/A. https://mynixos.com/search?q=nixpkgs%2Foption%2Fprograms.neovim</ref>. | |||
=== | ==== 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, N/A. 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: | |||
<!--T:17--> | |||
nix run "github:nix-community/neovim-nightly-overlay" | |||
==== Plugin Management ==== <!--T:21--> | |||
</translate> | |||
<syntaxhighlight lang="nix"> | |||
plugins = [ | |||
<translate> | |||
<!--T:49--> | |||
# Example Plugin: nvim-tree-lua | |||
</translate> | |||
pkgs.vimPlugins.nvim-tree-lua | |||
<translate> | |||
<!--T:50--> | |||
# Example Plugin: vim-startify with configuration | |||
</translate> | |||
{ | |||
plugin = pkgs.vimPlugins.vim-startify; | |||
config = "let g:startify_change_to_vcs_root = 0"; | |||
} | |||
<translate> | |||
<!--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: | |||
</translate> | |||
{ | |||
plugin = pkgs.vimPlugins.nvim-colorizer-lua; | |||
config = '' | |||
packadd! nvim-colorizer.lua | |||
lua << END | |||
require 'colorizer'.setup { | |||
'*';<translate> <!--T:52--> -- Highlight all files, but customize some others.</translate> | |||
'!vim';<translate> <!--T:53--> -- Exclude vim from highlighting.</translate> | |||
} | |||
END | |||
''; | |||
} | |||
<translate> | |||
<!--T:54--> | |||
# Example Plugin: nvim-treesitter with Lua config | |||
} | </translate> | ||
{ | |||
plugin = pkgs.vimPlugins.nvim-treesitter; | |||
config = '' | |||
packadd! nvim-treesitter | |||
lua <<EOF | |||
require'nvim-treesitter.configs'.setup { | |||
highlight = { | |||
enable = true, <translate><!--T:55--> -- false will disable the whole extension</translate> | |||
disable = {}, <translate><!--T:56--> -- list of languages that will be disabled</translate> | |||
}, | |||
incremental_selection = { | |||
enable = true, | |||
keymaps = { | |||
init_selection = "gnn", | |||
node_incremental = "grn", | |||
scope_incremental = "grc", | |||
node_decremental = "grm", | |||
}, | |||
}, | |||
textobjects = { | |||
select = { | |||
enable = true, | |||
lookahead = true, | |||
keymaps = { | |||
["af"] = "@function.outer", | |||
["if"] = "@function.inner", | |||
["ac"] = "@class.outer", | |||
["ic"] = "@class.inner", | |||
}, | |||
}, | |||
}, | |||
} | |||
EOF | |||
''; | |||
} | |||
<translate> | |||
<!--T:57--> | |||
# Installing grammars for tree-sitter | |||
# Option 1: Install all grammar packages | |||
pkgs.vimPlugins.nvim-treesitter.withAllGrammars | |||
# Option 2: Install specific grammar packages | |||
# (pkgs.vimPlugins.nvim-treesitter.withPlugins (p: [ p.c p.java ])) | |||
<!--T:58--> | |||
# 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 | |||
</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:// | * [https://www.lazyvim.org/ LazyVim]<ref>LazyVim Team, "LazyVim", LazyVim Official Website, N/A. https://www.lazyvim.org/</ref> | ||
<!--T:46--> | |||
* [https://astronvim.com/ AstroVim]<ref>AstroNvim Team, "AstroNvim", AstroNvim Official Website, N/A. https://astronvim.com/</ref> | |||
<!--T:47--> | |||
* [https://nvchad.com/ NVChad]<ref>NvChad Team, "NvChad", NvChad Official Website, N/A. https://nvchad.com/</ref> | |||
<!--T:48--> | |||
Another excellent option is [https://www.lunarvim.org/docs/installation LunarVim]<ref>LunarVim Team, "Installation", LunarVim Documentation, N/A. 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:20--> | |||
The configuration for LunarVim is stored in <code>./config/lvim</code>. | |||
== Troubleshooting == <!--T:59--> | |||
== References == <!--T:27--> | |||
</translate> | |||
[[Category:Applications]] | [[Category:Applications]] | ||
[[Category:Text Editor]] |