You are here: Home Software collective.recipe.vimproject
Document Actions

collective.recipe.vimproject

RSS Feed Category: Buildout, Python, Python Modules — Other products by this author
Set up a VIM development environment.

Experimental releases

There are no experimental releases available at the moment.

Project Description

Project resources

collective.recipe.vimproject

Author:$Author: seletz $
Date:$Date: 2008-07-01 15:10:04 +0200 (Di, 01 Jul 2008) $
Revision:$Revision: 67600 $

Abstract

This is a recipe to create a VIM project file. This is good for development, and if you use VIM with the Project plugin.

This recipe makes use of the mkvimproject egg.

code repository: https://svn.plone.org/svn/collective/buildout/collective.recipe.vimproject/trunk

Usage

Just add a buildout section like this:

[buildout]
parts=vpj

[vpj]
recipe = collective.recipe.vimproject
patterns=.py .zcml .pt .cfg .xml .txt .rst
create_tagfile=yes
in_vim_additional=
  set hlsearch
tags=/opt/inquant/buildout/eggs/tags

Change history

2008-03-17 Stefan Eletzhofer <stefan.eletzhofer@inquant.de>

  • setup.py: fixed namespace declaration, added std long_description.
    • added test setup

Supported options

The recipe supports the following options:

All options are optional.

patterns
a list of patterns to be included in the project file
create_tagfile
If this key exists, the recipe wil also use ctags to create a tag file of the buildout directory
tags
This list will be added to the in.vim script to set the tag files. Here you can add special directories (like buildout egg caches)
in_vim_additional
additional statements to add verbatim to the in.vim script.

Example usage

We'll start by creating a buildout that uses the recipe:

>>> write('buildout.cfg',
... """
... [buildout]
... parts=vpj
... eggs=mkvimproject
... newest=true
...
... [vpj]
... recipe = collective.recipe.vimproject
... patterns=.py .zcml .pt .cfg .xml .txt .rst
... create_tagfile=yes
... in_vim_additional=
...  set hlsearch
... tags=/opt/inquant/buildout/eggs/tags
... """)

Running the buildout gives us:

>>> print system(buildout)
Upgraded:
...
Installing test1.
Unused options for test1: 'option2' 'option1'.

Contributors

Stefan Eletzhofer