https://github.com/davidosomething/everandever.nvim

Lua utilities for composing an LSP progress indicator.
https://github.com/davidosomething/everandever.nvim

lua neovim neovim-plugin

Last synced: 3 months ago
JSON representation

Lua utilities for composing an LSP progress indicator.

• Host: GitHub
• URL: https://github.com/davidosomething/everandever.nvim
• Owner: davidosomething
• License: mit
• Created: 2023-02-22T02:26:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-10T06:41:36.000Z (over 1 year ago)
• Last Synced: 2024-05-02T00:22:38.276Z (7 months ago)
• Topics: lua, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 10.7 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# everandever.nvim

Lua utilities for composing an LSP progress indicator.  

See a [demo video](https://user-images.githubusercontent.com/609213/220507323-635ef4c1-1089-432e-96e8-73b4493051f9.mp4)

![screenshot](https://user-images.githubusercontent.com/609213/220508168-83671d58-511b-4dc5-a586-334713898275.png)

## Installation

These are strictly lua modules, they do nothing unless specifically required

by your own config. Install by adding to your plugin manager, no lazy loading

required.

- lazy.nvim

    ```lua

    { "davidosomething/everandever.nvim" }

    ```

## Usage

Make sure your statusline (or tabline or winbar) updates on the following

autocmd events:

```lua

"LspAttach",

"LspDetach",

"User LspProgressUpdate",

"User LspRequest",

```

### Get progress messages for given buffer

```lua

local opts = { bufnr = 0 }

vim.pretty_print(

  require('everandever.lsp').get_progress_messages(opts)

)

```

`opts` is passed directly to `vim.lsp.get_active_clients(opts)`

### Get messages, lowest % of the messages, and a bar character like `▄`

```lua

vim.pretty_print(

  require('everandever.progress').status_progress({ bufnr = 0 })

)

```

### Convert a number percentage to a status bar character

```lua

local progress = require('everandever.progress')

vim.pretty_print(

  progress.character(progress.VERTICAL, 75)

)

vim.pretty_print(

  progress.character(progress.HORIZONTAL, 75)

)

```

### lualine example

```lua

local function lspprogress()

  local data = require('everandever.progress').status_progress({ bufnr = 0 })

  return " " .. data.bar .. " " .. data.lowest.name .. " "

end

...

sections = { lualine_c = { lspprogress } }

```

### heirline.nvim example

Can be found [here](./lua/everandever/heirline.lua) (very similar to lualine)

## License

MIT