diff options
author | Matthieu Coudron <mcoudron@hotmail.com> | 2022-06-25 19:35:48 +0200 |
---|---|---|
committer | Matthieu Coudron <teto@users.noreply.github.com> | 2022-07-10 20:38:09 +0200 |
commit | 341b9564bb7d9f69b9e804d956680c8d2ebf61b2 (patch) | |
tree | 79cd0734e1d24e35455a0e6f2c2af1e818c1e54b /doc/languages-frameworks/vim.section.md | |
parent | 63230b2fce32dafff08c8f10d88afc385c2f1a11 (diff) | |
download | nixlib-341b9564bb7d9f69b9e804d956680c8d2ebf61b2.tar nixlib-341b9564bb7d9f69b9e804d956680c8d2ebf61b2.tar.gz nixlib-341b9564bb7d9f69b9e804d956680c8d2ebf61b2.tar.bz2 nixlib-341b9564bb7d9f69b9e804d956680c8d2ebf61b2.tar.lz nixlib-341b9564bb7d9f69b9e804d956680c8d2ebf61b2.tar.xz nixlib-341b9564bb7d9f69b9e804d956680c8d2ebf61b2.tar.zst nixlib-341b9564bb7d9f69b9e804d956680c8d2ebf61b2.zip |
vimUtils: remove vam support
having this many (complex) options not only is hard to maintain but I cant see the benefit of these options now that vim supports packages
Diffstat (limited to 'doc/languages-frameworks/vim.section.md')
-rw-r--r-- | doc/languages-frameworks/vim.section.md | 98 |
1 files changed, 1 insertions, 97 deletions
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md index 98173d7b2afb..ec0e60389155 100644 --- a/doc/languages-frameworks/vim.section.md +++ b/doc/languages-frameworks/vim.section.md @@ -5,11 +5,9 @@ and additional libraries. Loading can be deferred; see examples. -At the moment we support three different methods for managing plugins: +At the moment we support two different methods for managing plugins: - Vim packages (*recommended*) -- VAM (=vim-addon-manager) -- Pathogen - vim-plug ## Custom configuration {#custom-configuration} @@ -213,100 +211,6 @@ neovim.override { } ``` -## Managing plugins with VAM {#managing-plugins-with-vam} - -### Handling dependencies of Vim plugins {#handling-dependencies-of-vim-plugins} - -VAM introduced .json files supporting dependencies without versioning -assuming that "using latest version" is ok most of the time. - -### Example {#example} - -First create a vim-scripts file having one plugin name per line. Example: - -```vim -"tlib" -{'name': 'vim-addon-sql'} -{'filetype_regex': '\%(vim)$', 'names': ['reload', 'vim-dev-plugin']} -``` - -A discrete vim-scripts file can be read by VAM as well like this: - -```vim -call vam#Scripts(expand('~/.vim-scripts'), {}) -``` - -Create a default.nix file: - -```nix -{ nixpkgs ? import <nixpkgs> {}, compiler ? "ghc7102" }: -nixpkgs.vim_configurable.customize { name = "vim"; vimrcConfig.vam.pluginDictionaries = [ "vim-addon-vim2nix" ]; } -``` - -Create a generate.vim file: - -```vim -ActivateAddons vim-addon-vim2nix -let vim_scripts = "vim-scripts" -call nix#ExportPluginsForNix({ -\ 'path_to_nixpkgs': eval('{"'.substitute(substitute(substitute($NIX_PATH, ':', ',', 'g'), '=',':', 'g'), '\([:,]\)', '"\1"',"g").'"}')["nixpkgs"], -\ 'cache_file': '/tmp/vim2nix-cache', -\ 'try_catch': 0, -\ 'plugin_dictionaries': ["vim-addon-manager"]+map(readfile(vim_scripts), 'eval(v:val)') -\ }) -``` - -Then run - -```bash -nix-shell -p vimUtils.vim_with_vim2nix --command "vim -c 'source generate.vim'" -``` - -You should get a Vim buffer with the nix derivations (output1) and vam.pluginDictionaries (output2). -You can add your Vim to your system's configuration file like this and start it by "vim-my": - -```nix -my-vim = - let plugins = let inherit (vimUtils) buildVimPluginFrom2Nix; in { - copy paste output1 here - }; in vim_configurable.customize { - name = "vim-my"; - - vimrcConfig.vam.knownPlugins = plugins; # optional - vimrcConfig.vam.pluginDictionaries = [ - copy paste output2 here - ]; - - }; -``` - -Sample output1: - -```nix -"reload" = buildVimPluginFrom2Nix { # created by nix#NixDerivation - name = "reload"; - src = fetchgit { - url = "https://github.com/xolox/vim-reload"; - rev = "0a601a668727f5b675cb1ddc19f6861f3f7ab9e1"; - sha256 = "0vb832l9yxj919f5hfg6qj6bn9ni57gnjd3bj7zpq7d4iv2s4wdh"; - }; - dependencies = ["nim-misc"]; - -}; -[...] -``` - -Sample output2: - -```nix -[ - ''vim-addon-manager'' - ''tlib'' - { "name" = ''vim-addon-sql''; } - { "filetype_regex" = ''\%(vim)$$''; "names" = [ ''reload'' ''vim-dev-plugin'' ]; } -] -``` - ## Adding new plugins to nixpkgs {#adding-new-plugins-to-nixpkgs} Nix expressions for Vim plugins are stored in [pkgs/applications/editors/vim/plugins](https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/editors/vim/plugins). For the vast majority of plugins, Nix expressions are automatically generated by running [`./update.py`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/update.py). This creates a [generated.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/generated.nix) file based on the plugins listed in [vim-plugin-names](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/vim-plugin-names). Plugins are listed in alphabetical order in `vim-plugin-names` using the format `[github username]/[repository]@[gitref]`. For example https://github.com/scrooloose/nerdtree becomes `scrooloose/nerdtree`. |