aitatanit / vim-bookmarks Goto Github PK

This vim plugin allows toggling bookmarks per line. A quickfix window gives access to all bookmarks. Annotations can be added as well. These are special bookmarks with a comment attached. They are useful for preparing code reviews. All bookmarks will be restored on the next startup.

highlight BookmarkSign ctermbg=NONE ctermfg=160
highlight BookmarkLine ctermbg=194 ctermfg=NONE
let g:bookmark_sign = '♥'
let g:bookmark_highlight_lines = 1

• Toggle bookmarks per line ⚑
• Add annotations per line ☰
• Navigate all bookmarks with quickfix window
• Bookmarks will be restored on next startup
• Bookmarks per working directory (optional)
• Fully customisable (signs, sign column, highlights, mappings)
• Integrates with Unite's quickfix source if installed
• Works independently from vim marks

Before installation, please check your Vim supports signs by running :echo has('signs'). 1 means you're all set; 0 means you need to install a Vim with signs support. If you're compiling Vim yourself you need the 'big' or 'huge' feature set. MacVim supports signs.

Use your favorite plugin manager:

• Pathogen
  • git clone https://github.com/MattesGroeger/vim-bookmarks.git ~/.vim/bundle/vim-bookmarks
• Vundle
  1. Add Plugin 'MattesGroeger/vim-bookmarks' to .vimrc
  2. Run :PluginInstall
• NeoBundle
  1. Add NeoBundle 'MattesGroeger/vim-bookmarks' to .vimrc
  2. Run :NeoBundleInstall
• vim-plug
  1. Add Plug 'MattesGroeger/vim-bookmarks' to .vimrc
  2. Run :PlugInstall

After installation you can directly start using it. You can do this by either using the default shortcuts or the commands:

You can change the shortcuts as you like, just read on...

You can overwrite any of the default mappings. Just put the following into your ~/.vimrc and adjust as you like:

nmap <Leader><Leader> <Plug>BookmarkToggle
nmap <Leader>i <Plug>BookmarkAnnotate
nmap <Leader>a <Plug>BookmarkShowAll
nmap <Leader>j <Plug>BookmarkNext
nmap <Leader>k <Plug>BookmarkPrev
nmap <Leader>c <Plug>BookmarkClear
nmap <Leader>x <Plug>BookmarkClearAll

Overwrite the default hightlight groups by adding this to your colorscheme or .vimrc:

highlight BookmarkSign ctermbg=whatever ctermfg=whatever
highlight BookmarkAnnotationSign ctermbg=whatever ctermfg=whatever
highlight BookmarkLine ctermbg=whatever ctermfg=whatever
highlight BookmarkAnnotationLine ctermbg=whatever ctermfg=whatever

Put any of the following options into your ~/.vimrc in order to overwrite the default behaviour.

This feature allows the grouping of bookmarks per root directory. This way bookmarks from other projects are not interfering. This is done by saving a file called .vim-bookmarks into the current working directory (the folder you opened vim from).

Whenever a vim instance is opened from the same root folder the bookmarks from that folder will be loaded. Note, that you can place your bookmarks in any file underneath the working directory, though.

In order to use this feature, put this into your .vimrc:

let g:bookmark_save_per_working_dir = 1
let g:bookmark_auto_save = 1

You should add the filename .vim-bookmarks to your (global) .gitignore file so it doesn't get checked into version control.

If you want to customize the location or filename you can define the following function in your .vimrc. The return value will be used to retrieve and save the bookmark positions. This way you can implement you custom strategy for determining the work dir location (e.g. inside the .git directory):

" Finds the Git super-project directory.
function! g:BMWorkDirFileLocation()
    let filename = 'bookmarks'
    let location = ''
    if isdirectory('.git')
        " Current work dir is git's work tree
        let location = getcwd().'/.git'
    else
        " Look upwards (at parents) for a directory named '.git'
        let location = finddir('.git', '.;')
    endif
    if len(location) > 0
        return location.'/'.filename
    else
        return getcwd().'/.'.filename
    endif
endfunction

Call functions BookmarkSave, BookmarkLoad and BookmarkClearAll with the last argument set to 0 to perform these operations silently. You may use this to manage your bookmark list transparently from within your custom script.

Unite is a multi-purpose user-interface plugin platform. If it's part of your workflow, make sure you have a 'quickfix' source, a good one can be found here. When showing all your bookmarks, Unite is detected and the plugin will open :Unite quickfix instead of Vim's quickfix window. Note that g:bookmark_auto_close is no longer applied, once opened, the window is managed by Unite.

To set a global per-source context setting, that will apply to Unite's quickfix source everytime it's opened, you can add this to your vimrc:

call unite#custom#profile('source/quickfix,source/location_list', 'context', {
	\   'winheight': 13,
	\   'direction': 'botright',
	\   'start_insert': 0,
	\   'keep_focus': 1,
	\   'no_quit': 1,
	\ })

For more information about Unite, start reading :help Unite.

Why are the colours in the sign column weird?

Your colorscheme is configuring the SignColumn highlight group weirdly. To change that add this to your .vimrc: highlight SignColumn ctermbg=whatever.

What happens if I also use another plugin which uses signs (e.g. Syntastic)?

Vim only allows one sign per line. Therefore bookmarks will override any existing sign. When removing the bookmark the original sign will show up again. In other words vim-bookmarks won't remove another plugin's signs.

Why aren't any signs showing at all?

Make sure your vim supports signs: :echo has('signs') should give 1

See the release page for all changes.

This plugin was developed by Mattes Groeger under the MIT License. Pull requests are very welcome.

The following plugins were a great inspiration to me:

• vmark.vim by Michael Zhou
• vim-gitgutter by Andrew Stewart