Lua API

astrolsp API documentation

astrolsp

attached_clients

table

A table of LSP clients that have been attached with AstroLSP

config

AstroLSPOpts

The configuration as set by the user through the setup() function

format_opts

unknown

Format options that are passed into the vim.lsp.buf.format (:h vim.lsp.buf.format())

lsp_opts

function astrolsp.lsp_opts(server_name: string)
  -> table

Get the server configuration for a given language server to be provided to the server's setup() call

param server_name — The name of the server

return — The table of LSP options used when setting up the given language server

lsp_progress

table

A table of lsp progress messages that can be used to display LSP progress in a statusline

lsp_setup

function astrolsp.lsp_setup(server: string)

Helper function to set up a given server with the Neovim LSP client

param server — The name of the server to be setup

on_attach

function astrolsp.on_attach(client: vim.lsp.Client, bufnr: integer)

The on_attach function used by AstroNvim

param client — The LSP client details when attaching

param bufnr — The buffer that the LSP client is attaching to

progress

function astrolsp.progress(data: { client_id: integer, params: lsp.ProgressParams })

Add a new LSP progress message to the message queue

setup

function astrolsp.setup(opts: AstroLSPOpts)

Setup and configure AstroLSP

param opts — options passed by the user to configure AstroLSP

astrolsp.toggles

autoformat

function astrolsp.toggles.autoformat(silent?: boolean)

Toggle auto format

param silent — if true then don't sent a notification

buffer_autoformat

function astrolsp.toggles.buffer_autoformat(bufnr?: integer, silent?: boolean)

Toggle buffer local auto format

param bufnr — The buffer to toggle the autoformatting of, default the current buffer

param silent — if true then don't sent a notification

buffer_inlay_hints

function astrolsp.toggles.buffer_inlay_hints(bufnr?: integer, silent?: boolean)

Toggle buffer LSP inlay hints

param bufnr — the buffer to toggle the clients on

param silent — if true then don't sent a notification

buffer_semantic_tokens

function astrolsp.toggles.buffer_semantic_tokens(bufnr?: integer, silent?: boolean)

Toggle buffer semantic token highlighting for all language servers that support it

param bufnr — the buffer to toggle the clients on

param silent — if true then don't sent a notification

buffer_signature_help

function astrolsp.toggles.buffer_signature_help(bufnr?: integer, silent?: boolean)

Toggle buffer local automatic signature help

param bufnr — The buffer to toggle the auto signature help of, default the current buffer

param silent — if true then don't sent a notification

codelens

function astrolsp.toggles.codelens(silent?: boolean)

Toggle codelens

param silent — if true then don't sent a notification

inlay_hints

function astrolsp.toggles.inlay_hints(silent?: boolean)

Toggle global LSP inlay hints

param silent — if true then don't sent a notification

signature_help

function astrolsp.toggles.signature_help(silent?: boolean)

Toggle automatic signature help

param silent — if true then don't sent a notification