Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/WhoIsSethDaniel/lualine-lsp-progress.nvim

LSP progress lualine component
https://github.com/WhoIsSethDaniel/lualine-lsp-progress.nvim

lua lualine neovim neovim-plugin nvim nvim-plugin

Last synced: 4 days ago
JSON representation

LSP progress lualine component

Host: GitHub
URL: https://github.com/WhoIsSethDaniel/lualine-lsp-progress.nvim
Owner: WhoIsSethDaniel
License: mit
Archived: true
Created: 2022-08-11T19:26:45.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-03-05T19:21:03.000Z (9 months ago)
Last Synced: 2024-08-02T13:33:13.323Z (4 months ago)
Topics: lua, lualine, neovim, neovim-plugin, nvim, nvim-plugin
Language: Lua
Homepage:
Size: 51.8 KB
Stars: 62
Watchers: 1
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # ARCHIVED

This repository is archived and no longer being updated. For a similar plugin please see

[lsp-progress.nvim](https://github.com/linrongbin16/lsp-progress.nvim).

# lualine-lsp-progress

Information provided by active lsp clients from the `$/progress` endpoint as a statusline component for

[lualine.nvim](https://github.com/nvim-lualine/lualine.nvim).

This is a fork of the excellent, but currently unmaintained [lualine-lsp-progress](https://github.com/arkav/lualine-lsp-progress).

## Why?

Some LSP servers take a while to initialize. This provides a nice visual indicator to show which clients are ready to use.

## Screenshot

![example](https://user-images.githubusercontent.com/56053130/115862312-b4b12c80-a3cf-11eb-9a0f-3cd67160d732.PNG)

## Use

Add the component `lsp_progress` to one of your lualine sections.

```lua

require'lualine'.setup{

  ...

  sections = {

    lualine_c = {

      ...,

      'lsp_progress'

    }

  }

}

```

## Installation

### [vim-plug](https://github.com/junegunn/vim-plug)

```vim

Plug 'WhoIsSethDaniel/lualine-lsp-progress.nvim'

```

### [packer.nvim](https://github.com/wbthomason/packer.nvim)

```lua

use 'WhoIsSethDaniel/lualine-lsp-progress.nvim'

```

## Configuration

### Configurable items

-   Items to display and order

    -   Lsp client name e.g. Rust

    -   Spinner

    -   Progress (individual actions undertaken by the LSP)

        -   Title of action undertaken by LSP e.g. Indexing

        -   Message from Lsp

        -   Percentage complete

-   pre and post items - before each specific lsp item display text

-   Spinner

    -   Symbols

    -   Time between symbol update

-   Color of items

-   Last Message delay

    -   After we receive a progress message saying an action is complete **delay** removing it from lualine so we can read that

        it's finished.

    -   After the final progress message is displayed **delay** before no longer showing the lsp client name.

### Decked out configuration

```lua

-- Color for highlights

local colors = {

  yellow = '#ECBE7B',

  cyan = '#008080',

  darkblue = '#081633',

  green = '#98be65',

  orange = '#FF8800',

  violet = '#a9a1e1',

  magenta = '#c678dd',

  blue = '#51afef',

  red = '#ec5f67',

}

local config = {

  options = {

    icons_enabled = true,

    theme = 'gruvbox',

    component_separators = { '', '' },

    section_separators = { '', '' },

    disabled_filetypes = {},

  },

  sections = {

    lualine_a = { 'mode' },

    lualine_b = { 'filename' },

    lualine_c = {},

    lualine_x = {},

    lualine_y = { 'encoding', 'fileformat', 'filetype' },

    lualine_z = { 'branch' },

  },

  inactive_sections = {

    lualine_a = {},

    lualine_b = {},

    lualine_c = { 'filename' },

    lualine_x = { 'location' },

    lualine_y = {},

    lualine_z = {},

  },

  tabline = {},

  extensions = {},

}

-- Inserts a component in lualine_c in left section

local function ins_left(component)

  table.insert(config.sections.lualine_c, component)

end

-- Inserts a component in lualine_x in right section

local function ins_right(component)

  table.insert(config.sections.lualine_x, component)

end

ins_left {

  'lsp_progress',

  colors = {

    percentage = colors.cyan,

    title = colors.cyan,

    message = colors.cyan,

    spinner = colors.cyan,

    lsp_client_name = colors.magenta,

    use = true,

  },

  separators = {

    component = ' ',

    progress = ' | ',

    message = { pre = '(', post = ')' },

    percentage = { pre = '', post = '%% ' },

    title = { pre = '', post = ': ' },

    lsp_client_name = { pre = '[', post = ']' },

    spinner = { pre = '', post = '' },

  },

  -- never show status for this list of servers;

  -- can be useful if your LSP server does not emit

  -- status messages

  hide = { 'null-ls', 'pyright' },

  -- by default this is false. If set to true will

  -- only show the status of LSP servers attached

  -- to the currently active buffer

  only_show_attached = true,

  display_components = { 'lsp_client_name', 'spinner', { 'title', 'percentage', 'message' } },

  timer = {

    progress_enddelay = 500,

    spinner = 1000,

    lsp_client_name_enddelay = 1000,

    attached_delay = 3000,

  },

  spinner_symbols = { '🌑 ', '🌒 ', '🌓 ', '🌔 ', '🌕 ', '🌖 ', '🌗 ', '🌘 ' },

  message = { initializing = 'Initializing…', commenced = 'In Progress', completed = 'Completed' },

  max_message_length = 30,

}

```