This script provides two features:
-
Symlink ~/.vim to a specified location
This is useful if you'd like to keep a version-controlled dotvim repo in some location near other repositories on your system, rather than at ~/.vim
-
Symlink vim-plugins into ~/.vim
This is a thin layer on top of GNU Stow, and makes it easy to manage (add, remove, update) such symlinks without fear or fuss.
I've gotten a lot of good use out of this while developing my own plugins and working on NixOS. My nix config bakes specific plugin versions into the system-wide Vim installation, and this tool lets me temporarily override them by symlinking to local the copies I'm working on.
Symlinks are placed within ~/.vim which is earlier in Vim's runtimepath than the locations where the system-wide versions reside.
That means I can test stuff locally and get quick feedback before pushing up a new revision and updating my nix config.