Aurum

Vim plugin providing Mercurial ↔ Vim integration

1. Status

This plugin is not distributed with Mercurial or Vim.

Author: Nikolay Pavlov

Repository: https://bitbucket.org/ZyX_I/aurum

Web page: https://bitbucket.org/ZyX_I/aurum, http://www.vim.org/scripts/script.php?script_id=3828

Warning: do not edit the Overview section below by hand. It is generated by the script from the help file. Instead create an issue.

2. Overview

This plugin provides a vim <--> VCS (currently mercurial, git and subversion) integration for your projects. Features:

• Partially committing changes (:AuRecord).

• Viewing file state at particular revision (aurum://file, :AuFile).

• Viewing uncommited changes in a vimdiff, as well as changes between specific revisions (:AuVimDiff). It is also possible to open multiple tabs with all changes to all files viewed as side-by-side diffs.

• Viewing revisions log (:AuLog). Output is highly customizable.

• Viewing working directory status (:AuStatus).

• Commiting changes (:AuCommit), commit messages are remembered in case of rollback (g:aurum_remembermsg).

• Obtaining various URL’s out of remote repository URL (like URL of the HTML version of the current file with URL fragment pointing to the current line attached: useful for sharing) (:AuHyperlink). For mercurial it also supports git and subversion revisions (in case you are using hg-git and hgsubversion respectively).

• aurum#changeset(), aurum#repository() and aurum#status() functions that are to be used from modeline.

• Frontends for various other VCS commands.

Most commands can be reached with a set of mappings (see aurum-mappings), all mappings are customizable.

Plugin’s mercurial driver is able to use mercurial python API as well as its CLI, but remember that the former is much slower and less tested. In order to use mercurial python API you must have vim compiled with +python (mercurial currently does not support python 3) and have mercurial in python’s sys.path (note: on windows msi installer is not adding mercurial to sys.path, so you won’t be able to use its python API).

Plugin requires some additional plugins:

• frawor

• (optional) ansi_esc_echo

• (optional) one of

  • Command-T

  • ctrlp

  • FuzzyFinder

  • unite

  • ku

  • tlib

  • for :AuFile prompt option and a number of OpenAny/AnnotateAny mappings.

(with their dependencies).

Note: aurum supports VAM. It is prefered that you use it for aurum installation.

3. Configuration

This plugin does not require any modifications to .hgrc. You can use vim-addon-manager to install it or manually clone https://bitbucket.org/ZyX_I/aurum and https://bitbucket.org/ZyX_I/frawor somewhere and add

set rtp+=/path/to/aurum,/path/to/frawor

to your vimrc.