Ruslan's Tech Blog

Vim Fugitive. :Glog - show a commit author

Sat, 06 Feb 2021 00:00:00 +0000

TL;DR

let g:fugitive_summary_format = "%<(16,trunc)%an || %s"

The path of figuring that line out

Vim-Fugitive is a great package. Recently I started to use :Glog command a lot to look at range of changes added to a branch after git pull.

:Glog <hash>..<another hash>

By default the command only shows a commit hash and its subject.

I really wanted to see how can I show a commit author name as well.

:h fugitive didn’t help much.

Inspecting the fugitive’s source code I came across not documented g:fugitive_summary_format variable. Initially it wasn’t clear how to use it what values I can assign to it but then I noticed that it is assigned with values like %s or %h %P\t%H.

These things looks familiar. man git-log - the place those control symbols can be found at. Searching by “author” gives us %an that we can use.

Let’s do let g:fugitive_summary_format = "%an" and see how does it look.

Nice… no commit message. By searching in man git-log I found %s which is a subject (first top line) part of a commit message.

Let’s do let g:fugitive_summary_format = "%an\t%s" (separate name and subject with a tab symbol)

Better but subject is not vertically aligned so let’s keep reading man git-log.

There is a subject Placeholders that affect formatting of later placeholders where you can find this scary expression - %<(<N>[,trunc|ltrunc|mtrunc])
The definition of this scary thing is - make the next placeholder take at least N columns, padding spaces on the right if necessary.

Exactly what we need. Let’s try to use it:

let g:fugitive_summary_format = "%<(16,trunc)%an || %s" - here I assume 16 chars in user name is enough for me to recognize an author. Adding || too as a separator between author and subject.

Much better!

Vim save file without AutoCmd

Thu, 08 Aug 2019 00:00:00 +0000

Vim’s autocmd is very powerful feature.

In my workflow I have many of them including autocmd for BufWrite.

There are rare cases when I want to save file and ignore any autocmd.

To do this you can just save it by:

:noa w

Of course there can be any command after :noa.

Check :h noa for more details.

Vim folding

Sun, 09 Dec 2018 00:00:00 +0000

Hi, I didn’t use folding functionality previously at all in any other editors, but after I watched this awesome video by Greg Hurrell I found this Vim feature super useful.

So to start getting all benefits from Vim folding just add this to your .vimrc:

set foldmethod=indent
set foldlevelstart=1

What these lines do is:

set foldmethod - setting the folding method. indent is actually works mostly for all programming languages. There are other options though (see :h fold-methods)
set foldlevelstart=1 - this is magic line. It kind of force you to use foldings. Using this line your files will be folded by default and you have to unfold functions/methods you want to look at. Value 1 in this case means “fold everything and then unfold it back by one level”.

So in case you have class defined then this class will be unfolded and fully visible but all methods inside will be folded.

Here is the example:

Please not, in this case I use `set foldlevelstart=2` because class is wrapped in module.

Here is keybindings to fold/unfold your code:

zo - open folded part
zO - open folded part with all sub-foldings
zc - fold the code
zM - fold everything
zR - unfold everything
zm - change fold level (fold everything by one step)
zr - unfold everything (unfold by one step)

Folding mechanism is great in Vim, and actually in every other editors, but I never used it mostly because I’m too lazy to fold the code. Since Vim does it for me (set foldlevelstart=1) I always have something folded and it’s easy to always remember and use this feature.

Try it!

Vim, dumb-jump

Sun, 02 Dec 2018 00:00:00 +0000

hi everyone,

I’m currently using Vim in my day to day work, and if you don’t know I migrated from another perfect editor called Emacs.

It was pretty easy to migrate since I used evil-mode in Emacs but the only library/plugin I miss is dumb-jump which is brilliant because allows you to jump to definition without any CTAGS/GTAGS.

There is brilliant guy Chris Paul who made dim-jump plugin which does the same as dumb-jump.

Moreover the plugin is using dumb-jump rules and download them at the first usage of the plugin.

Just add

Plug "bounceme/dim-jump"

to your .vimrc/init.vim and have fun.

The plugin currently just jumps to the first most relevant definition found which is not always correct for me.

In case you need a fixed version which shows you all possible founds add my fork to you .vimrc/init.vim file:

Plug 'KryDos/dim-jump', { 'branch': 'krydos-adaptation' }

I’ll update this post as soon as my changes will be accepted by Chris, otherwise choose between these two versions of plugin depending on your needs.

Vim, project specific settings

Tue, 20 Nov 2018 00:00:00 +0000

Hey, I’ve just been looking for a good plugin that can help me to configure some VIM variables per project.

For example I want set shiftwidth=2 for my JavaScript project and set shiftwidth=4 for PHP one.

Turned out no plugin needed.

Just put this to your .vimrc:

silent! so .vimlocal

Now if you put .vimlocal file to your project root, it will be sourced and “executed”.

silent! is using to supress warnings when there is no .vimlocal file in a directory.

vim-easygrep

Fri, 31 Aug 2018 00:00:00 +0000

I’m currently trying to use Vim instead of Emacs and one of important workflow I’ve used to is grepping things in a project.

There are few options:

use :vimgrep something **/*. It’s pretty long to type so I don’t really like it.
bind that vimgrep command to a key sequence. Which is better but still not ideal.
EasyGrep. The tool I chose.

My config looks like this:

let g:EasyGrepCommand="grep"
let g:EasyGrepRoot="repository"
let g:EasyGrepRecursive = 1
let g:EasyGrepFilesToExclude = "vendor,docker,node_modules"

By default EasyGrep use vimgrep which is not able to ignore folders as far as I got.

So setting grep as EasyGrepCommand makes EasyGrepFilesToExclude being considered.

Setting EasyGrepRoot to repository turns EasyGrep to “search from project root” mode.

Now I can just place my cursor to a word I want to search for, press <Leader>vv and that’s it.

Works like a charm.