sponsor Vim development Vim logo Vim Book Ad

Proj : Simple project tool

 script karma  Rating 1368/353, Downloaded by 3636  Comments, bugs, improvements  Vim wiki

created by
Thomas Allen
script type
Proj lets you save settings for your project in a simple file.

    Note that the easiest way to use Proj is with the key mappings bound
    to the commands below. <Leader>pt is the default mapping to open a
    tab-specific project, for instance.

     Prompts to add a new project in the current directory.

     Open the project file in a split.

     Show all of the current project's settings in the status line.

     Open a menu with all of these commands.

     Open the project notes file in a split.

     Prompt to open a project.

     Prompt to open a project for the open tab. Projects opened this way will
     only be active in the opened tab, so that each tab can contain a project.

     Reload the current project.

     Reload the project file.

     Open the project's vim settings file in a split.

File Syntax:
    DOS .ini

Available Settings:
    browser - A custom command for the filebrowser
    notes - Path to a text file with project notes
    path - Path to the project root directory
    vim - Path to a file with vim commands
    docksend - Upload all files in the project on save if the TransmitFtp
      plugin is available

Sample Project File:
    ; This is a comment
    path = /path/to/project
    vim = /path/to/settings_file.vim
    docksend ; boolean option

    path = /path/to/my\ project ; Escape spaces with \

Global Options:
    * g:ProjDisableMappings (default: 0) - Set to 1 to turn off all
        mappings defined by this plugin
    * g:ProjFile (default: '~/.vimproj') - Path to the project file.
    * g:ProjFileBrowser (default: 'NERDTree') - The filebrowser command.
        Set to 'off' to not open a filebrowser.
    * g:ProjMapLeader (default: '<Leader>p') - The prefix for default mappings
    * g:ProjNoteFile (default: 'notes.txt') - Path to the project notes file
    * g:ProjSplitMethod (default: 'vsp') - Command to use when opening a file
        with a Proj command such as ProjFile.

    Default maps: These are all prefixed with g:ProjMapLeader by default.
        g:ProjAddMap (default: 'a') - Calls :ProjAdd
        g:ProjFileMap (default: 'f') - Calls :ProjFile
        g:ProjInfoMap (default: 'i') - Calls :ProjInfo
        g:ProjMenuMap (default: 'm') - Calls :ProjMenu
        g:ProjNotesMap (default: 'n') - Calls :ProjNotes
        g:ProjOpenMap (default: 'o') - Calls :ProjOpen
        g:ProjOpenTabMap (default: 't') - Calls :ProjOpenTab
        g:ProjReloadMap (default: 'r') - Calls :ProjReload
        g:ProjVim (default: 'v') - Calls :ProjVim
install details
1. Extract the downloaded proj.tgz file
2. Copy proj/doc/proj.txt to .vim/doc/proj.txt
3. Copy proj/plugin/proj.vim to .vim/plugin/proj.vim
4. Run :helptags ~/.vim/doc to load the documentation
5. Create a file at ~/.vimproj or your custom g:ProjFile location with your projects

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
proj.vim.zip 1.5.2 2015-06-16 7.0 Thomas Allen Fix bad global function definition.
proj.tgz 1.5.1 2010-10-06 7.0 Thomas Allen Fixed incorrect ProjOpenTab menu action.
proj.tgz 1.5 2010-10-06 7.0 Thomas Allen Tab-specific projects.
proj.tgz 1.4 2010-09-24 7.0 Thomas Allen Cleanup, more mappings, menu, basic prompts.
proj.tgz 1.3.1 2010-07-21 7.0 Thomas Allen Bugfixes for ProjNotes toggle, project entry with no docksend key.
proj.tgz 1.3 2010-07-21 7.0 Thomas Allen TransmitFTP docksend integration. ProjAdd mapping.
proj.tbz 1.2 2010-01-18 7.0 Thomas Allen ProjAdd command. Windows pathname bugfix (thanks Mikhail Stepura)
ip used for rating:

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
Vim at Github