LanguageServer -- language server

Description

This package provides a language server for Macaulay2 implementing the Language Server Protocol (LSP). It is used via the M2-language-server script, which is distributed with Macaulay2 and starts the server with standard input and output as the communication channel.

The language server is supported out of the box by the following editors:

the Macaulay2 major mode for Emacs, using eglot or lsp-mode
the Macaulay2 extension for VS Code
the Macaulay2 plugin for Neovim

Author

Doug Torrance <dtorrance9@gatech.edu>

Version

This documentation describes version 0.1 of LanguageServer, released May 30, 2026.

Citation

If you have used this package in your research, please cite it as follows:

@misc{LanguageServerSource,
  title = {{LanguageServer: A \emph{Macaulay2} package. Version~0.1}},
  author = {Doug Torrance},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/stable/M2/Macaulay2/packages}}
}

Exports

Types
- LSPServer -- LSP server class
Functions and commands
- setLogger (missing documentation)
- start -- start the language server
Methods
- new LSPServer -- see LSPServer -- LSP server class
- setLogger(LSPServer,Function) -- set up logging for an LSP server
- start(LSPServer) -- see start -- start the language server

For the programmer

The object LanguageServer is a package, defined in LanguageServer.m2, with auxiliary files in LanguageServer/.

The source of this document is in /build/reproducible-path/macaulay2-1.26.06+ds/M2/Macaulay2/packages/LanguageServer/doc.m2:28:0.