Vim: Difference between revisions

On unstable:

<syntaxhighlight lang="nix>

   programs.vim.enable = true;

</syntaxhighlight>

or

<syntaxhighlight lang="nix>

   programs.vim = {

   };

</syntaxhighlight>

On 24.05 or older:

<syntaxhighlight lang="nix>

   environment.systemPackages = with pkgs; [ vim ];

</syntaxhighlight>

<!--T:5-->

or

<syntaxhighlight lang="nix>

   environment.systemPackages = with pkgs; [ vim_configurable ];

</syntaxhighlight>

=== Using Home Manager === <!--T:7-->

<!--T:8-->

Vim can easily be set up using [[Special:MyLanguage/Home Manager|Home Manager]]. Here's a minimal example:

<syntaxhighlight lang="nix>

   programs.vim = {

   };

</syntaxhighlight>

<!--T:9-->

You can configure home-manager to install spelling files into your user directory by packaging individual spell files.  Here' an example for neovim and French:

<syntaxHighlight lang="nix">

let

};

nvim-spell-fr-utf8-suggestions = builtins.fetchurl {

   url = "http://ftp.vim.org/vim/runtime/spell/fr.utf-8.sug";

};

nvim-spell-fr-latin1-dictionary = builtins.fetchurl {

   url = "http://ftp.vim.org/vim/runtime/spell/fr.latin1.spl";

};

nvim-spell-fr-latin1-suggestions = builtins.fetchurl {

   url = "http://ftp.vim.org/vim/runtime/spell/fr.latin1.sug";

}

</syntaxHighlight>

==== NeoVim with Coc for Python ==== <!--T:16-->

On unstable:

<syntaxHighlight lang="nix">

{ pkgs, ... }:

     package = (pkgs.vim_configurable.override {  }).customize{

       name = "vim";

       # Install plugins for example for syntax highlighting of nix files

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

         start = [ vim-nix vim-lastplace ];

       };

       vimrcConfig.customRC = ''

         " your custom vimrc

         set nocompatible

         set backspace=indent,eol,start

         " Turn on syntax highlighting by default

         syntax on

         " ...

}

</syntaxHighlight>

On 24.05 or older:

<syntaxHighlight lang="nix">

{ pkgs, ... }:

{

     ((vim_configurable.override {  }).customize{

       name = "vim";

       # Install plugins for example for syntax highlighting of nix files

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

         start = [ vim-nix vim-lastplace ];

       };

       vimrcConfig.customRC = ''

         " your custom vimrc

         set nocompatible

         set backspace=indent,eol,start

         " Turn on syntax highlighting by default

         syntax on

         " ...

     configure = {

       customRC = ''

         " your custom vimrc

         set nocompatible

         set backspace=indent,eol,start

}

</syntaxHighlight>

<!--T:23-->

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

<syntaxHighlight lang="nix">

{     

}

</syntaxHighlight>

== Custom setup without using Home Manager == <!--T:24-->

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

<syntaxHighlight lang="nix">

{

     myVim = vim_configurable.customize {

       name = "vim-with-plugins";

       # add here code from the example section

     };

     myNeovim = neovim.override {

       configure = {

         customRC = ''

           # here your custom configuration goes!

         '';

         packages.myVimPackage = with pkgs.vimPlugins; {

           # see examples below how to use custom packages

           start = [ ];

           opt = [ ];

}

</syntaxHighlight>

<!--T:32-->

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.

<syntaxHighlight lang="nix">

vim_configurable.customize {

   name = "vim-with-plugins";

   # add custom .vimrc lines like this:

   vimrcConfig.customRC = ''

     set hidden

}

</syntaxHighlight>

<!--T:37-->

=== Using vim's builtin packaging capability === <!--T:38-->

<syntaxHighlight lang="nix">

vim_configurable.customize {

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

     # loaded on launch

     start = [ YouCompleteMe fugitive ];

     # manually loadable by calling `:packadd $plugin-name`

     opt = [ phpCompletion elm-vim ];

     # To automatically load a plugin when opening a filetype, add vimrc lines like:

     # autocmd FileType php :packadd phpCompletion

   }

};

</syntaxHighlight>

<!--T:40-->

<!--T:42-->

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>

=== Using Vim-Plug as manager === <!--T:43-->

<syntaxhighlight lang="nix">

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

</syntaxhighlight>

=== Adding new plugins === <!--T:45-->

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

<syntaxHighlight lang="nix">

let

     };

   };

in {

   users.users.<yourNickname>.packages = [

};

</syntaxHighlight>

==== Using flake ==== <!--T:53-->

<code>configuration.nix</code>:

<syntaxHighlight lang="nix">

</syntaxHighlight>

<code>flake.nix</code>:

<syntaxHighlight lang="nix">

   };

     nixosConfigurations.nixos = nixpkgs.lib.nixosSystem {

       system = "x86_64-linux";

}

</syntaxHighlight>

<!--T:57-->

==== Using language client ==== <!--T:60-->

<syntaxHighlight lang="nix">

vim_configurable.customize {

};

</syntaxHighlight>

<!--T:62-->

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

   # the following plugins are optional, they provide type checking, import sorting and code formatting

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

]))

</syntaxHighlight>

=== Real life examples === <!--T:63-->

<!--T:69-->

If you have defined your vim configuration in a `./my_vim.nix` file you can install vim with the python 3 support instead of python2 by overriding the python version like the following:

<syntaxHighlight  lang="nix">

(pkgs.callPackage ./my_vim.nix {                                                                                                                                                           

})

</syntaxHighlight>

== gvim and gview == <!--T:70-->

<!--T:71-->

<code>gvim</code> and <code>gview</code> may be installed using the <code>[https://search.nixos.org/packages/?query=vimHugeX vimHugeX]</code> attribute name (package name <code>[https://search.nixos.org/packages/?query=vim_configurable vim_configurable]</code>).

<syntaxhighlight lang=bash>

$ nix-env -iA nixos.vimHugeX

</syntaxhighlight>

<!--T:72-->

If you are using <code>vim_configurable.customize</code>, you can enable <code>wrapGui</code> to make <code>gvim</code> available, though this won't give you <code>gview</code>:

<syntaxhighlight lang=nix>

vim_configured = pkgs.vim_configurable.customize {

   wrapGui = true;

};

</translate>

[[Category:Applications]]

[[Category:Text Editor{{#translation:}}]]