gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc/vim: fix instructions on vim-plugins-updater update

Browse Source 
See 1e71cad6e4/maintainers/scripts/pluginupdate-py/pluginupdate.py (L487).

This line checks the plugin's name and normalizes it before checking with `to_update`.
`to_update` is a raw list of packages you want to update.

Thus, calling `vim-plugins-updater update "package-name"` filters `current_plugin_specs`, removing all `PluginDesc` with *normalized* names that do not match `to_update`

Hence, updating something like "mini.nvim" does not work as the filter expects normalized names. Using "mini-nvim" instead works as intended
This commit is contained in:
mmfallacy
2025-08-29 23:50:32 +08:00
parent 603ff7ec48
commit a116c18dd8
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/languages-frameworks/vim.section.md
View File

@@ -186,12 +186,17 @@ Alternatively, set the number of processes to a lower count to avoid rate-limiti
nix-shell -p vimPluginsUpdater --run 'vim-plugins-updater --proc 1'
```
If you want to update only certain plugins, you can specify them after the `update` command. Note that you must use the same plugin names as the `pkgs/applications/editors/vim/plugins/vim-plugin-names` file.
To update only specific plugins, list them after the `update` command:
```sh
nix-shell -p vimPluginsUpdater --run 'vim-plugins-updater update "nvim-treesitter" "LazyVim"'
nix-shell -p vimPluginsUpdater --run 'vim-plugins-updater update "nvim-treesitter" "mini.nvim" "mini-nvim"'
```
The updater script accepts plugin arguments in different formats:
- `"mini.nvim"` := The GitHub repository name, the raw plugin name, or the alias defined in `vim-plugin-names`.
- `"mini-nvim"` := The normalized plugin name, which matches the attribute name generated in `generated.nix`
## How to maintain an out-of-tree overlay of vim plugins? {#vim-out-of-tree-overlays}
You can use the updater script to generate basic packages out of a custom vim