Flog v2

[rbong]

Requests for changes in v2 and feedback on planned changes welcome.

Major changes:

• Rewrite in vim9script, subsequent speed improvements
• Rewrite performance-sensitive portions of Flog in Lua
• Flog will draw the commit graph itself
• Flog will be able to position the cursor directly on the commit
• Better commit graph highlighting
• Better default format commit content highlighting
• API will be restructured
• "Command" wording will be changed to avoid naming confusion with "Vim commands"
  • "Command windows" will be renamed "side windows"
  • The "run_command()" function will be renamed "exec()"

Deprecations:

• AnsiEsc plugin is no longer required and will be removed
• Custom branch program is no longer required and will be removed
• Most of the now "public" API will be made private (still accessible, just no deprecation warnings)

Progress:

• [X] Restructure API
• [x] Implement parts in Lua
• [x] Branch drawing
• [X] Highlighting
• [x] Graph buffer commands
• [x] Exec format
• [x] Exec commands
• [x] Graph buffer settings
• [x] Side window buffer settings
• [x] Graph buffer syntax highlighting
• [x] Misc. fixes
• [x] PR for fugitive completion
• [x] Documentation
• [X] Neovim support added
• [x] Tests
  • [X] Framework
  • [x] Tests

Prerequisites for finalizing:

• [X] Vim9script finalized
• [X] Neovim vim9script support determined (not supported)

[kevinhwang91]

Thanks, look like the bottleneck is Git diff HEAD commit. It's not relate to flog.

[rbong]

@kevinhwang91 sorry I wasn't more clear, it's a little bit related to Flog, as :Git! causes the command to load instantly, and previously :Floggit had no way to use :Git!.

Fixing this had a cascading effect on changing the API. I wanted to make these changes anyways.

:Floggit has new flags:

• -f/--focus causes the window to keep focus
• -u/--update updates the graph buffer after the command is done
• -t/--tmp opens the command in a temporary window

:Floggit! no long opens the command in a temporary window, since there's now a flag for that. It now calls :Git! instead, which opens the command in the background.

flog#Exec()/flog#ExecTmp() no longer format commands. You can now do that with flog#Format().

So you can remap bindings now using this format:

nno ... :<C-U>exec flog#Format("Floggit -f -u -t ...")<CR>

Instead of this:

nno ... :<C-U>call flog#Exec("Floggit ...", 1, 1, 1)<CR>

However I wouldn't change your bindings to use Floggit!. I've noticed there are some window bugs in Fugitive. Also in long commands, it causes a lot of lag while the command is finishing, and it takes a lot longer than not using !.

At least it's possible now, and I got to make some changes I wanted to make.

[kevinhwang91]

exec flog#Format('vertical belowright Floggit -f -u -t diff HEAD %h') is also slow, does it mean the bottleneck is fugitive?

[rbong]

No, the problem is not Fugitive. The changes were not meant to fix the problem, just make :Git! and :Floggit! do the same thing.

[kevinhwang91]

Thanks, got it.

I found the culprit is my ftplugin/git.vim

setlocal foldmethod=expr
setlocal foldexpr=DiffFold()
setlocal foldlevel=1

function! DiffFold()
    let line = getline(v:lnum)
    if line =~# '^\(diff\|index\)' " file
        return '0'
    elseif line =~# '^--- .*$'
        return '>1'
    elseif line =~# '^==== .*$'
        return '>1'
    elseif line =~# '^@@' " hunk
        return '>2'
    elseif line =~# '^\*\*\* \d\+,\d\+ \*\*\*\*$' " context: file1
        return '>2'
    elseif line =~# '^--- \d\+,\d\+ ----$' " context: file2
        return '>2'
    else
        return '='
    endif
endfunction

It's slow for a large git file.

[rbong]

I don't know if I like that you now have to enter :Floggit -u to update the buffer. I might make it update the buffer by default and replace the option with one that doesn't update the buffer.

[rbong]

I changed it. Sorry if this is inconvenient.

Changes in arguments to :Floggit:

• --update/-u: removed. Updating is now the default behaviour
• --static/-s: new. Prevents the graph buffer from updating

Changes to flog#Exec/flog#ExecTmp:

• The third arg has been inverted (don't update the graph buffer instead of update it)

No deprecation warnings because it's still in alpha.

If you're having trouble keeping track of all the changes, I'm keeping the v2 Migration Guide up to date.

[bodograumann]

Great work on this tool and especially v2. Looking forward to diving ever deeper into the possibilities.

[rbong]

Flog v2 has been merged to the master branch and released.

Unfortunately GitHub has no ways to alias branches, so the v2 branch has been deleted. Please switch back to the master branch if you were already using it.

For other problems, see this issue or post a new issue.