Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/AckslD/nvim-gfold.lua

nvim plugin using gfold to switch repo and have statusline component
https://github.com/AckslD/nvim-gfold.lua

Last synced: about 2 months ago
JSON representation

nvim plugin using gfold to switch repo and have statusline component

Lists

README 

        
# nvim-gfold.lua



`nvim` plugin for [gfold](https://github.com/nickgerace/gfold) currently providing:

* A picker to change `cwd`.

  This uses `vim.ui.select`.

  To have a nice ui for example [dressing.nvim](https://github.com/stevearc/dressing.nvim) can be used.

* A function to get a summary that can be used in statuslines, eg [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim).



## Pictures

### Picker



![gscreenshot_2022-02-25-095346](https://user-images.githubusercontent.com/23341710/155687823-947535c8-e271-4e8f-a924-be2b7bc29708.png)



### Statusline



![gscreenshot_2022-02-26-140848](https://user-images.githubusercontent.com/23341710/155844731-13a82e4e-f74e-47a9-a677-7c696c731169.png)



## Install

```lua

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:

```lua

{

  -- base directory to look for repos

  -- defaults to home

  cwd = vim.fn.getenv('HOME'),



  -- if true, no error is shown if the call to gfold fails

  no_error = false,



  -- 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:

```vim

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

```



Optionally you can filter the repos you want to show by including a condition callback.

For example:

```lua

require('gfold').pick_repo(function(repo)

  return repo.status ~= 'clean'

end)

```

which would only include non-clean repos in the picker. `repo` is a table with the keys:

* `status`

* `path`

* `remote`

* `user`



### Statusline

#### Lualine

To use `lualine` you can simply do eg:

```lua

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:

```lua

{

  unclean = ,

  clean = ,

  bare = ,

  unpushed = ,

}

```

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](https://github.com/AckslD/nvim-gfold.lua/tree/main/lua/gfold/settings.lua) for more information.