From a116c18dd87b727511ceaae28ecab8f1590b39d4 Mon Sep 17 00:00:00 2001 From: mmfallacy <31348500+mmfallacy@users.noreply.github.com> Date: Fri, 29 Aug 2025 23:50:32 +0800 Subject: [PATCH] doc/vim: fix instructions on vim-plugins-updater update See https://github.com/NixOS/nixpkgs/blob/1e71cad6e484919d7e67952ce4ffd90ee10f4346/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 --- doc/languages-frameworks/vim.section.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md index 0000860095e7..d884b5f23a7c 100644 --- a/doc/languages-frameworks/vim.section.md +++ b/doc/languages-frameworks/vim.section.md @@ -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