AckslD/nvim-gfold.lua

github github
git
star 20
stars
alert-circle 2
open issues
users 1
subscribers
git-branch 3
forks
CREATED

2022-02-24

UPDATED

17 days ago


nvim-gfold.lua

nvim plugin for gfold currently providing:

  • A picker to change cwd. This uses vim.ui.select. To have a nice ui for example dressing.nvim can be used.
  • A function to get a summary that can be used in statuslines, eg lualine.nvim.

Pictures

Picker

gscreenshot_2022-02-25-095346

Statusline

gscreenshot_2022-02-26-140848

Install

use {
  "AckslD/nvim-gfold.lua",
  config = function()
    require('gfold').setup()
  end,
}

Config

Pass a table to require('gfold').setup(). The following are the default values:

{
  -- base directory to look for repos
  -- defaults to home
  cwd = vim.fn.getenv('HOME'),

  -- What symbols to use, for both picker and status
  status_symbols = {
    clean = '✔',
    unclean = '✘',
    unpushed = '',
    bare = '',
  },

  -- settings specific to the picker
  picker = {
    -- how to format an entry in the picker
    -- default will be something like:
    --   ✔ nvim-gfold.lua (/home/path/to/nvim-gfold.lua)
    format_item = function(repo)
      return string.format(
      '%s %s (%s)',
      require('gfold.settings').status_symbols[repo.status],
      repo.name,
      repo.path
      )
    end,

    -- what to do when selecting a repo
    -- by default changes cwd
    on_select = require('gfold.actions').change_cwd,
  },

  -- settings specific to the status(line)
  status = {
    -- if we should continuously update the summary
    enable = true,

    -- how long to wait in between querying repo statuses
    -- NOTE this is the time from the last process ran until starting it again
    -- so the interval will be whatever time it takes to run gfold plus this setting
    -- Default is 5 seconds but if for some reason you want this to be updated more frequently
    -- you can always make this value smaller.
    update_delay = 5000,

    -- What color of highlights to use
    -- Values are either:
    --   * string: a highlight group
    --   * table: eg `{fg = '#b8bb26'}`
    colors = {
      clean = {fg = '#b8bb26'},
      unclean = {fg = '#fb4934'},
      unpushed = {fg = '#fe8019'},
      bare = {fg = '#fabd2f'},
    },

    -- In which order to show the components of the summary
    order = {
      'clean',
      'unclean',
      'unpushed',
      'bare',
    },
  },
}

Usage

Picker

To pick a repo:

:lua require('gfold').pick_repo()

Statusline

Lualine

To use lualine you can simply do eg:

require('lualine').setup({
  ...
  sections = {
    ...
    lualine_x = {
      ...
      'gfold',
      ...
    },
    ...
  },
  ...
})

Others

For other statuslines you can call require('gfold').get_summary which returns a table of the form:

{
  unclean = <int>,
  clean = <int>,
  bare = <int>,
  unpushed = <int>,
}

which you can use to format a summary to your liking.

NOTE that get_summary does not update the current summary (ie does not trigger gfold), it just looks up the current known information. This means get_summary is a quick function and you can easily call it often. Instead, nvim-gfold will continuously update this information in the background, see settings for more information.