A ruby script to create, install, and list the contents of vimballs
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
README.markdown
vimball.rb

README.markdown

vimball.rb

The vimball.rb ruby script that allows user to create, install, and list the contents of vimballs.

Configuration

Configuration is done via yaml files:

  • VIMFILES/vimballs/config_${hostname}.yml
  • or VIMFILES/vimballs/config.yml

Example configuration file:

--- 
vimfiles: /home/foo/.vim/
installdir: /home/foo/.vim/
compress: false
helptags: gvim --cmd "helptags %s|quit"
username: foo
password: bar
history_fmt: Please see http://github.com/foo/%s_vim/commits/master/
ignore_git_messages_rx: ^- (readme|docs|misc|meta|etc|minor)$
roots:
  - /home/foo/.vim/bundle

Examples

Create a vimball:

vimball.rb vba myplugin.recipe

Create vimballs if a file has changed:

vimball.rb -u vba myplugin.recipe

Create a vimball and upload it to vim.org with vimscriptuploader.rb:

rm myplugin.yml || echo ignore error
if vimball.rb -u --save-yaml -- vba myplugin.recipe | grep "vimball: Save as"; then
    vimscriptdef.rb --recipe myplugin.recipe
    vimscriptuploader.rb --user foo --password bar myplugin.yml
fi

Install a vimball:

vimball.rb install myplugin.vba

Install a vimball as a "bundle" (i.e. in its own directory under ~/.vim/bundle):

vimball.rb --repo install myplugin.vba

Dependencies

  • ruby 1.8