plugins.fidget.settings.progress.display.done_icon

Icon shown when all LSP progress tasks are complete.

  • When a string literal is given (e.g., "✔"), it is used as a static icon.
  • When a list or attrs (e.g., ["dots"] or {pattern = "clock"; period = 2;}) is given, it is used to generate an animation function.
  • When a function is specified (e.g., {__raw = "function(now) return now % 2 < 1 and '+' or '-' end";}), it is used as the animation function.

Type: null or string or raw lua code or list of string or attribute set of (string or (unsigned integer, meaning >=0))

Default: null

Plugin default: "✔"

Declared by:

plugins.fidget.settings.progress.display.done_style

Highlight group for completed LSP tasks.

Type: null or string or raw lua code

Default: null

Plugin default: "Constant"

Declared by:

plugins.fidget.settings.progress.display.done_ttl

How long a message should persist after completion.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 3

Declared by:

plugins.fidget.settings.progress.display.format_annote

How to format a progress annotation.

Type: null or lua function string or raw lua code

Default: null

Plugin default: "function(msg) return msg.title end"

Declared by:

plugins.fidget.settings.progress.display.format_group_name

How to format a progress notification’s group name.

Type: null or lua function string or raw lua code

Default: null

Plugin default: "function(group) tostring(group) end"

Declared by:

plugins.fidget.settings.progress.display.format_message

How to format a progress message.

Example:

  format_message = function(msg)
    if string.find(msg.title, "Indexing") then
      return nil -- Ignore "Indexing..." progress messages
    end
    if msg.message then
      return msg.message
    else
      return msg.done and "Completed" or "In progress..."
    end
  end

Type: null or lua code string or raw lua code

Default: null

Plugin default:

''
  require("fidget.progress.display").default_format_message
''

Declared by:

plugins.fidget.settings.progress.display.group_style

Highlight group for group name (LSP server name).

Type: null or string or raw lua code

Default: null

Plugin default: "Title"

Declared by:

plugins.fidget.settings.progress.display.icon_style

Highlight group for group icons.

Type: null or string or raw lua code

Default: null

Plugin default: "Question"

Declared by:

plugins.fidget.settings.progress.display.overrides

Override options from the default notification config. Keys of the table are each notification group’s key.

Type: null or (attribute set of ((attribute set of anything) or raw lua code)) or raw lua code

Default: null

Plugin default:

{
  rust_analyzer = {
    name = "rust-analyzer";
  };
}

Declared by:

plugins.fidget.settings.progress.display.priority

Ordering priority for LSP notification group.

Type: null or signed integer or floating point number or value false (singular enum) or raw lua code

Default: null

Plugin default: 30

Declared by:

plugins.fidget.settings.progress.display.progress_icon

Icon shown when an LSP progress task is in progress.

  • When a string literal is given (e.g., "✔"), it is used as a static icon.
  • When a list or attrs (e.g., ["dots"] or {pattern = "clock"; period = 2;}) is given, it is used to generate an animation function.
  • When a function is specified (e.g., {__raw = "function(now) return now % 2 < 1 and '+' or '-' end";}), it is used as the animation function.

Type: null or string or raw lua code or list of string or attribute set of (string or (unsigned integer, meaning >=0))

Default: null

Plugin default:

[
  "dots"
]

Declared by:

plugins.fidget.settings.progress.display.progress_style

Highlight group for in-progress LSP tasks.

Type: null or string or raw lua code

Default: null

Plugin default: "WarningMsg"

Declared by:

plugins.fidget.settings.progress.display.progress_ttl

How long a message should persist when in progress.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: lib.nixvim.mkRaw "math.huge"

Declared by:

plugins.fidget.settings.progress.display.render_limit

How many LSP messages to show at once.

If set to false, no limit will be enforced.

Type: null or signed integer or floating point number or value false (singular enum) or raw lua code

Default: null

Plugin default: 16

Declared by:

plugins.fidget.settings.progress.display.skip_history

Whether progress notifications should be omitted from history.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: