sponsor Vim development Vim logo Vim Book Ad

MessageRecall : Browse and re-insert previous (commit, status) messages.

 script karma  Rating 1/1, Downloaded by 106    Comments, bugs, improvements  Vim wiki

created by
Ingo Karkat
 
script type
utility
 
description
DESCRIPTION
This plugin automatically persists (parts of) buffers used for the editing of
commit (or other) messages, where Vim is invoked as the editor from an
external tool. In these buffers, it sets up mappings and commands to iterate
through stored past messages, and recall the contents for use in the currently
edited message. This way, you automatically collect a history of (committed or
aborted) past messages, and can quickly base your current message on contents
recalled from that history.

SEE ALSO
This plugin is used by:
VcsMessageRecall (vimscript #4117): Browse and re-insert previous VCS commit
                                    messages.

USAGE
The plugin is completely inactive until you set it up for a particular
buffer through the following function; you'll find the details directly in the
.vim/autoload/MessageRecall.vim implementation file.

MessageRecall#Setup( messageStoreDirspec, ... )


INSIDE THE CURRENT MESSAGE BUFFER
After setup, the following mappings and commands are available in the current
message buffer:

CTRL-P, CTRL-N          When the buffer has no unsaved changes: Replace the
                        edited message with a [count]'th previous / next
                        stored message.
                        When the buffer is modified: Open the [count]'th
                        previous / first stored message in the preview window.


:[count]MessageView
                        View the [count]'th previous stored message in the
                        preview-window.
:MessageView {message}|{filespec}
                        View {message} (auto-completed from the message store
                        directory) or any arbitrary {filespec} contents
                        in the preview-window.


:[count]MessageRecall[!]
                        Insert the [count]'th previous stored message below
                        the current line.
:MessageRecall[!] {message}|{filespec}
                        Insert {message} (auto-completed from the message
                        store directory) or any arbitrary {filespec} contents
                        below the current line.

                        When the existing message consists of just empty
                        lines (originating from the message template that the
                        tool invoking Vim has put there), the inserted message
                        replaces those empty lines. With [!]: Replace an
                        existing message with the inserted one.


INSIDE A MESSAGE PREVIEW WINDOW
CTRL-P, CTRL-N          Go to the previous / next stored message.

:MessageRecall          Insert the previewed stored message below the current
                        line in the buffer from which the message preview was
                        opened.
 
install details
INSTALLATION
This script is packaged as a vimball. If you have the "gunzip" decompressor
in your PATH, simply edit the *.vba.gz package in Vim; otherwise, decompress
the archive first, e.g. using WinZip. Inside Vim, install by sourcing the
vimball or via the :UseVimball command.
    vim MessageRecall.vba.gz
    :so %
To uninstall, use the :RmVimball command.

DEPENDENCIES
- Requires Vim 7.0 or higher.
- Requires the EditSimilar plugin (vimscript #2544), version 2.00 or higher.
- Requires the BufferPersist plugin (vimscript #4115).
 

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
MessageRecall.vba.gz 1.01 2012-07-12 7.0 Ingo Karkat BUG: Script error E486 when replacing a non-matching commit message buffer.
MessageRecall.vba.gz 1.00 2012-06-25 7.0 Ingo Karkat Initial upload
ip used for rating: 50.16.132.180

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.
   
SourceForge.net Logo