Vim: Difference between revisions

<syntaxhighlight lang="nix>

</syntaxhighlight>

or

</syntaxhighlight>

<syntaxhighlight lang="nix>

   programs.vim = {

   };

</syntaxhighlight>

See [https://github.com/rycee/home-manager/blob/master/modules/programs/vim.nix] for the full set of options.

<syntaxHighlight lang="nix">

let

in

{

}

</syntaxHighlight>

For NeoVim use this home manager config:

https://github.com/NixOS/nixpkgs/issues/98166#issuecomment-725319238

If you want a system wide "baseline" configuration for vim/nvim here are two examples:.

{ pkgs, ... }:

{

       name = "vim";

       vimrcConfig.packages.myplugins = with pkgs.vimPlugins; {

         start = [ vim-nix vim-lastplace ];

       };

       vimrcConfig.customRC = ''

         set nocompatible

         set backspace=indent,eol,start

         syntax on

         " ...

       '';

}

<syntaxHighlight lang="nix">

{ pkgs, ... }:

{

         set nocompatible

         set backspace=indent,eol,start

         " ...

       '';

       };

}

</syntaxHighlight>

import these in your <code>configuration.nix</code> and

<syntaxHighlight lang="nix">

{     

}

</syntaxHighlight>

{{note|To get a general overview about how to set up your vim in nix, refer to [https://www.mpscholten.de/nixos/2016/04/11/setting-up-vim-on-nixos.html mpscholten's blog] }}

Vim plugins can be installed with the help of nix. You can omit using vim plugin managers and do everything in your <code>.nixpkgs/config</code>.

Both vim and neovim can be further configured to include your favorite plugins and additional libraries. To list all available vim plugins, run <code>nix search nixpkgs#vimPlugins</code>.

Add the following code to your <code>~/.nixpkgs/config.nix</code>:

{

   packageOverrides = pkgs: with pkgs; {

       name = "vim-with-plugins";

     };

     myNeovim = neovim.override {

       configure = {

         customRC = ''

         '';

         packages.myVimPackage = with pkgs.vimPlugins; {

           start = [ ];

           opt = [ ];

   };

}

After that you can install your special grafted `myVim` or `myNeovim` packages.

NB: you ''must'' use <code>vimrcConfig.customRC</code> rather than installing a <code>~/.vimrc</code> by hand, since the customized Vim will silently ignore any vimrc in your home directory.

   name = "vim-with-plugins";

   vimrcConfig.customRC = ''

     set hidden

   '';

}

If you need to run code before plugins are added, you can use <code>vimrcConfig.beforePlugins</code> (be sure to include <code>set nocompatible</code> if you override [https://github.com/NixOS/nixpkgs/blob/c3df8057dad986bf7f3928de1b5233fadb52bb15/pkgs/misc/vim-plugins/vim-utils.nix#L264-L267 the default value]).

   vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {

     start = [ YouCompleteMe fugitive ];

     opt = [ phpCompletion elm-vim ];

     # autocmd FileType php :packadd phpCompletion

   }

};

Note that dynamically loading with opt may be buggy and the workaround is to use [https://vi.stackexchange.com/a/20818/30821 start instead].

There is a pathogen implementation as well, but its startup is slower and [VAM] has more features.  

<syntaxhighlight lang="nix">

vimrcConfig.pathogen.knownPlugins = vimPlugins; # optional

vimrcConfig.pathogen.pluginNames = [ "vim-addon-nix" "youcompleteme" ];

</syntaxhighlight>

<syntaxhighlight lang="nix">

vimrcConfig.plug.plugins = with pkgs.vimPlugins; [vim-addon-nix youcompleteme];

</syntaxhighlight>

For additional info, you may wish to look at [https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/vim.section.md documentation on the nixpkgs repository].

Sometimes you do not want to change upstream plugins, for this you can use  <code>vimUtils.buildVimPlugin</code> to create your own:

let

   vim-better-whitespace = pkgs.vimUtils.buildVimPlugin {

     };

   };

in {

   users.users.<yourNickname>.packages = [

       vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {

         start = [ vim-better-whitespace ];

   ];

};

<code>configuration.nix</code>:

<syntaxHighlight lang="nix">

}

</syntaxHighlight>

Then we can update the package with <code>nix flake lock --update-input winresizer-vim</code>, or update all inputs in flake.nix with <code>nix flake update</code>.

   vimrcConfig = {

     customRC = ''

     }

};

Then put the following expression in <code>environment.systemPackages</code> or in the home-manager package list,

to install python-language-server:

<syntaxHighlight  lang="nix">

(python3.withPackages(ps: [

   ps.python-language-server

   ps.pyls-mypy ps.pyls-isort ps.pyls-black

]))

</syntaxHighlight>

* [https://github.com/jagajaga/my_configs/blob/master/.nixpkgs/common.nix Jagajaga’s config]

* [https://github.com/andrewrk/dotfiles/blob/master/.nixpkgs/config.nix andrewrk's config]

* [https://github.com/wagnerf42/nixos-config/blob/master/config/my_vim.nix wagnerf42's config (good for rust language)]

Currently the youcompleteme plugin uses [https://github.com/NixOS/nixpkgs/blob/8e7b1f2ac2e261d5a644fef860a0d050ea227c06/pkgs/misc/vim-plugins/default.nix#L695 unwrapped clang on linux]. This causes it to not find <code>stdlib.h</code>. There is a [https://github.com/andrewrk/genesis/blob/5f49cd9a8c2b61b9859a22102bc3f732add9461a/.ycm_extra_conf.py workaround] you can put in your <code>.ycm_extra_conf.py</code> file, which works by executing the C/C++ compiler and getting it to output the list of search paths - which includes the search path to find <code>stdlib.h</code>.

A better alternative to youcompleteme for C/C++ is to use [https://github.com/cquery-project/cquery/ cquery] in combination with the [https://github.com/autozimu/LanguageClient-neovim LanguageClient-neovim]. It will also find in c header files when used in a nix-shell if you install cquery from nixpkgs as it uses a custom [https://github.com/NixOS/nixpkgs/commit/04f3b76dcec21f2fcba6b1b0afbb3ed224165050#diff-11cdfc0385b9e017089c1ac09c5b838e shell wrapper]

})

</syntaxhighlight>

[[Category:Applications]]