vim-tools - Python scripts to publish Vim plug-ins

GitHub: Watched by 8 people, most recent update was Sat May 04 23:11:35 UTC 2013

I’m a programmer which naturally means I hate performing repetitive tasks… Publishing my Vim plug-ins quickly turned out to fall in this category; I’d keep making the same mistakes and having users e-mail me because I screwed up again and uploaded a broken release to www.vim.org. After a while this got embarrassing so I decided to solve this annoying problem once and for all. This git repository contains the results in the form of several shell and Python scripts:

# vim-plugin-release

This program (written in Python) makes it easier for me to publish my Vim plug-ins on GitHub and Vim Online. This is what I use to publish my plug-ins on http://www.vim.org. It might be a bit specific to my workflow but you never know, someone might find it useful :-)

# mkd2vimdoc.py

This Python module converts Markdown formatted text to Vim’s help file format. I created this code because I write a README.md document for every project I publish on GitHub and thought it would be nice to include these documents in a more readable format with the ZIP archives I upload to http://www.vim.org. The code is basically one big hack, desperately trying to avoid becoming a multi pass parser but it worked and I was happy with it for a while, so there ;-)

# html2vimdoc.py

This Python script works in the same way as mkd2vimdoc.py except that it takes HTML as input which makes it more flexible, for example I use it to convert the Lua, LPeg and Lua/APR manuals to Vim’s help file format. This script already does more than mkd2vimdoc.py but it still has some warts I want to fix before I forget about mkd2vimdoc.py and switch to html2vimdoc.py completely.

# Git hooks

The hooks directory contains git pre-commit and post-commit hooks that automate parts of my workflow. They’re very specific to my setup so can’t be re-used by others without making serious changes, but the code might nevertheless be useful to someone as inspiration :-).

# Pre-commit hook

Pathogen/Vundle uses kept complaining I didn’t have .gitignore files to exclude doc/tags, so now the pre-commit hook warns me when I forget
I always forget to update the year of copyright in the readme / documentation, so the pre-commit is now responsible for this
The Vim help files are generated from the Markdown readme files using html2vimdoc.py and automatically included in commits that change README.md

# Post-commit hook

Right now the post-commit hook does one thing: Automatically tag commits on master branches that change a plug-in’s version number.

In the future I may extend this to automatically run vim-plugin-release, but right now it’s not fast enough so it would either break my flow or force me to work in feature branches for intermediate commits.

Last updated Sat May 04 23:11:35 UTC 2013.