Lua API

astrolsp API documentation

astrolsp

AstroNvim LSP Utilities

Various utility functions to use within AstroNvim for the LSP engine

This module can be loaded with local astro = require "astrolsp"

add_on_attach

function astrolsp.add_on_attach(on_attach: fun(client: vim.lsp.Client, bufnr: integer), opts?: { client_name: string?, autocmd: (vim.api.keyset.create_autocmd)? })
  -> autocmd_id: integer

Set up a given on_attach function to run when language servers are attached

param on_attach — the on_attach function to run

param opts — options for configuring the on_attach

return autocmd_id — The id for the created LspAttach autocommand

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_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.file_operations

AstroNvim LSP File Operation Utilities

Utilities for working with LSP based file operations

This module is heavily inspired by nvim-lsp-file-operations https://github.com/antosha417/nvim-lsp-file-operations/tree/master

This module can be loaded with local astrolsp_fileops = require "astrolsp.file_operations"

didCreateFiles

function astrolsp.file_operations.didCreateFiles(fnames: string|string[])

Notify LSP clients that file(s) were created

param fnames — a file or list of files that were created

didDeleteFiles

function astrolsp.file_operations.didDeleteFiles(fnames: string|string[])

Notify LSP clients that file(s) were deleted

param fnames — a file or list of files that were deleted

didRenameFiles

function astrolsp.file_operations.didRenameFiles(renames: AstroLSPFileOperationsRename|AstroLSPFileOperationsRename[])

Notify LSP clients that file(s) were renamed

param renames — a table or list of tables of files that were renamed

willCreateFiles

function astrolsp.file_operations.willCreateFiles(fnames: string|string[])

Notify LSP clients that file(s) are going to be created

param fnames — a file or list of files that will be created

willDeleteFiles

function astrolsp.file_operations.willDeleteFiles(fnames: string|string[])

Notify LSP clients that file(s) are going to be deleted

param fnames — a file or list of files that will be deleted

willRenameFiles

function astrolsp.file_operations.willRenameFiles(renames: AstroLSPFileOperationsRename|AstroLSPFileOperationsRename[])

Notify LSP clients that file(s) are going to be renamed

param renames — a table or list of tables of files that will be renamed

astrolsp.toggles

AstroNvim LSP Toggles

Utility functions for easy LSP toggles

This module can be loaded with local ui = require("astrolsp.toggles")