Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Set up a VIM development environment.

Project description

collective.recipe.vimproject
============================

:Author: $Author: seletz $
:Date: $Date: 2008-03-17 16:46:58 +0100 (Mo, 17 Mär 2008) $
:Revision: $Revision: 60824 $

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


.. _VIM: http://vim.org
.. _Project: http://www.vim.org/scripts/script.php?script_id=69
.. _mkvimproject: http://pypi.python.org/pypi/mkvimproject/


::

vim: set ft=rst tw=75 nocin nosi ai sw=4 ts=4 expandtab:

Change history
**************

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

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

Detailed Documentation
**********************

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

Download
********

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
collective.recipe.vimproject-0.3.2-py2.4.egg (6.5 kB) Copy SHA256 hash SHA256 Egg 2.4
collective.recipe.vimproject-0.3.2.tar.gz (3.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page