vim-pck 0.1.0

Configuration file

The main configuration file where the vim packages are specified. It’s default location follow the XDG specification that is $XDG_HOME_CONFIG/vimpck/config or ~/.config/vimpck/config if XDG_HOME_CONFIG is not set.

[SETTING]
    # The built in package directory. See :help packages
    pack_path=~/.vim/pack
    # pack_path= ~/.local/share/nvim/site/pack for neovim

[REPOSITORY]
    [[https://github.com/tpope/vim-commentary]]
        package = common
        type = start
        freeze = True # Don't update vim-commentary when launching vimpck upgrade

    [[https://github.com/tpope/vim-dispatch]]
    # default location pack_path/vimpck/start/vim-dispatch

    [[https://github.com/mustache/vim-mustache-handlebars]]
        package = filetype
        type = start

    [[https://github.com/altercation/vim-colors-solarized]]
        package = colors
        type = start

Then run vimpck install to clone each remote repository in the correct package location. For exemple, vim-commentary –> ~/.vim/pack/common/start/vim-commentary

For neovim the package path should be set to ~/.local/share/nvim/site/pack

Usage

To use it (see vimpck --help):

• $ vimpck install : install plugins from the configuration file

• $ vimpck ls : list all plugins

• $ vimpck ls --start : list plugins that are automatically loaded

• $ vimpck ls --opt : list plugins that have to be loaded manually

• $ vimpck upgrade : update all plugins that are not freezed

• $ vimpck upgrade <plug>... : only update <plug> plugin. The plugin have to be specified using the following pattern package/type/plugin. You can easily complete the <plug> with the zsh completion script.

• vimpck rm <plug>... : remove one or more <plug>. Support zsh completion.

• vimpck rm -r <plug>... : remove one or more <plug> and also remove the corresponding section from the configuration file.

• vimpck clean : remove unused plugins

Environment variable

• VIMPCKRC: override default configuration location (xdg standard)

Example : export VIMPCKRC=/path/to/conf/name

Completion

A zsh completion function is provided in the completion folder of this repository.

To use it copy _vimpck somewhere in the $fpath environment variable of zsh and make sure the completion module of zsh is loaded by putting these following lines in your .zshrc:

autoload -U compinit
compinit