Why?

Getting Started

Requirements

Installation

Lazy

{"j-hui/fidget.nvim",opts= {-- options  },}

vim-plug

Plug'j-hui/fidget.nvim'" Make sure the plugin is installed using :PlugInstall. Then, somewhere after plug#end():lua <<EOFrequire("fidget").setup {--options}EOF

rocks.nvim

:Rocks install fidget.nvim

Versioning

{"j-hui/fidget.nvim",version="*",-- alternatively, pin this to a specific version, e.g., "1.6.1"opts= {-- options  },}

Options

{-- Options related to LSP progress subsystemprogress= {poll_rate=0,-- How and when to poll for progress messagessuppress_on_insert=false,-- Suppress new messages while in insert modeignore_done_already=false,-- Ignore new tasks that are already completeignore_empty_message=false,-- Ignore new tasks that don't contain a messageclear_on_detach=-- Clear notification group when LSP server detachesfunction(client_id)localclient=vim.lsp.get_client_by_id(client_id)returnclientandclient.nameornilend,notification_group=-- How to get a progress message's notification group keyfunction(msg)returnmsg.lsp_client.nameend,ignore= {},-- List of LSP servers to ignore-- Options related to how LSP progress messages are displayed as notificationsdisplay= {render_limit=16,-- How many LSP messages to show at oncedone_ttl=3,-- How long a message should persist after completiondone_icon="✔",-- Icon shown when all LSP progress tasks are completedone_style="Constant",-- Highlight group for completed LSP tasksprogress_ttl=math.huge,-- How long a message should persist when in progressprogress_icon=-- Icon shown when LSP progress tasks are in progress        {"dots"},progress_style=-- Highlight group for in-progress LSP tasks"WarningMsg",group_style="Title",-- Highlight group for group name (LSP server name)icon_style="Question",-- Highlight group for group iconspriority=30,-- Ordering priority for LSP notification groupskip_history=true,-- Whether progress notifications should be omitted from historyformat_message=-- How to format a progress messagerequire("fidget.progress.display").default_format_message,format_annote=-- How to format a progress annotationfunction(msg)returnmsg.titleend,format_group_name=-- How to format a progress notification group's namefunction(group)returntostring(group)end,overrides= {-- Override options from the default notification configrust_analyzer= {name="rust-analyzer"},      },    },-- Options related to Neovim's built-in LSP clientlsp= {progress_ringbuf_size=0,-- Configure the nvim's LSP progress ring buffer sizelog_handler=false,-- Log `$/progress` handler invocations (for debugging)    },  },-- Options related to notification subsystemnotification= {poll_rate=10,-- How frequently to update and render notificationsfilter=vim.log.levels.INFO,-- Minimum notifications levelhistory_size=128,-- Number of removed messages to retain in historyoverride_vim_notify=false,-- Automatically override vim.notify() with Fidgetconfigs=-- How to configure notification groups when instantiated      {default=require("fidget.notification").default_config },redirect=-- Conditionally redirect notifications to another backendfunction(msg,level,opts)ifoptsandopts.on_openthenreturnrequire("fidget.integration.nvim-notify").delegate(msg,level,opts)endend,-- Options related to how notifications are rendered as textview= {stack_upwards=true,-- Display notification items from bottom to topalign="message",-- Indent messages longer than a single linereflow=false,-- Reflow (wrap) messages wider than notification windowicon_separator="",-- Separator between group name and icongroup_separator="---",-- Separator between notification groupsgroup_separator_hl=-- Highlight group used for group separator"Comment",line_margin=1,-- Spaces to pad both sides of each non-empty linerender_message=-- How to render notification messagesfunction(msg,cnt)returncnt==1andmsgorstring.format("(%dx) %s",cnt,msg)end,    },-- Options related to the notification window and bufferwindow= {normal_hl="Comment",-- Base highlight group in the notification windowwinblend=100,-- Background color opacity in the notification windowborder="none",-- Border around the notification windowzindex=45,-- Stacking priority of the notification windowmax_width=0,-- Maximum width of the notification windowmax_height=0,-- Maximum height of the notification windowx_padding=1,-- Padding from right edge of window boundaryy_padding=0,-- Padding from bottom edge of window boundaryalign="bottom",-- How to align the notification windowrelative="editor",-- What the notification window position is relative totabstop=8,-- Width of each tab character in the notification windowavoid= {}-- Filetypes the notification window should avoid-- e.g., { "aerial", "NvimTree", "neotest-summary" }    },  },-- Options related to integrating with other pluginsintegration= {    ["nvim-tree"]= {enable=true,-- Integrate with nvim-tree/nvim-tree.lua (if installed)-- DEPRECATED; use notification.window.avoid = { "NvimTree" }    },    ["xcodebuild-nvim"]= {enable=true,-- Integrate with wojciech-kulik/xcodebuild.nvim (if installed)-- DEPRECATED; use notification.window.avoid = { "TestExplorer" }    },  },-- Options related to logginglogger= {level=vim.log.levels.WARN,-- Minimum logging levelmax_size=10000,-- Maximum log file size, in KBfloat_precision=0.01,-- Limit the number of decimals displayed for floatspath=-- Where Fidget writes its logs tostring.format("%s/fidget.nvim.log",vim.fn.stdpath("cache")),  },}

Lua API

Commands

:Fidget sub-commands

:Fidget clear

:Fidget clear_history

:Fidget history

:Fidget lsp_suppress

:Fidget suppress

Telescope

require("telescope").load_extension("fidget")

require("telescope").extensions.fidget.fidget()

Highlights

Related Work

Acknowledgements