v3 Help

[rbong]

The v3 release recently came out.
Feel free to leave feedback or ask questions here.

v2 Migration Instructions

• The :Floggit --focus flag has been replaced with :Floggit --blur, which has the opposite function.
  If you have any custom :Floggit commands, change :Floggit -f or :Floggit --focus to :Floggit.
  Change :Floggit commands that don't use these flags to :Floggit -b or :Floggit --blur.
• The flog#Exec() and flog#ExecTmp() functions now uses a dictionary for options.
  Change any references from flog#Exec(cmd, focus, static, tmp) to flog#Exec(cmd, { 'blur': !focus, 'static': static, 'tmp': tmp }).
• The focus option for flog#Exec() has been replaced with blur, which has the opposite function.
  Change flog#Exec(cmd) or flog#Exec(cmd, 0) to flog#Exec(cmd, { "blur": 1 }).
  Change flog#Exec(cmd, 1) to flog#Exec(cmd, { "blur": 0 }) or flog#Exec(cmd).
• If you use flog#Exec() with custom functions, be aware temporary windows no longer close dynamically.
  This means that previous temporary windows close if you set opts.tmp to true, whether you actually open windows or not.
  If your command opens temporary windows non-deterministically, please use lower-level functions.
• There are now only 8 branch highlight groups by default.
  If you previously had 9 custom branch highlight groups, you can set g:flog_num_branch_colors to 9.

New Option Configuration Tips

• To enable new branch drawing symbols, set g:flog_enable_extended_chars to 1.
  This currently requires the Kitty terminal or flog-symbols.
• To enable dynamic commit highlighting, set g:flog_enable_dynamic_commit_hl to 1.
• To disable dynamic branch highlighting, set g:flog_enable_dynamic_branch_hl to 0.
• If you plan to use auto updates on Linux, it can be useful to increase the maximum number of watched files:
  sudo sysctl fs.inotify.max_user_watches=524288
• To enable auto updates by default, set g:flog_permanent_default_opts.auto_update to 1. (Neovim only)
• If you are using Neovim and use the Flog API in your init.lua file, you may want to switch to the new Lua wrapper functions.
  For example, vim.fn['flog#ExecTmp']() is now available as require('flog').exec_tmp().
• You may wish use %P with flog#Format() if you have any commands that you would like to always use the current path.
  For example, if you would like a similar command that acts like <Tab> if a path is specified and <CR> otherwise:
  flog#Format('vertical belowright Floggit -b -s -t show %h %P')
• The new %(h'x,'y) item can be used with flog#Format() for any commands you want to get a range for.
  For example, to cherry-pick the visual range of commits from bottom to top:
  flog#Exec(flog#Format(\"Floggit cherry-pick %(h'>,'<)\"))

[rbong]

There appears to be an issue with disabling mini.trailspace in a new buffer, we're setting b:minitrailspace_disabled as soon as possible but it doesn't apply until switching windows.

See also #132 , #142

Workaround in init.lua:

vim.api.nvim_create_autocmd(
  "User",
  {
    pattern = { "FlogUpdate" },
    callback = function (ev)
      require("mini.trailspace").unhighlight()
    end,
  }
)