eglot 
- Description
- The Emacs Client for LSP servers
- Latest
- eglot-1.21.0.20260121.230919.tar (.sig), 2026-Jan-22, 530 KiB
- Maintainer
- João Távora <joaotavora@gmail.com>
- Website
- https://github.com/joaotavora/eglot
- Browse ELPA's repository
- CGit or Gitweb
- All Dependencies
- eldoc (.tar), external-completion (.tar), flymake (.tar), jsonrpc (.tar), project (.tar), seq (.tar), xref (.tar)
- Badge
- Manual
- eglot
To install this package from Emacs, use list-packages.
Full description
Eglot ("Emacs Polyglot") is an Emacs LSP client that stays out of
your way.
Typing M-x eglot in some source file is often enough to get you
started, if the language server you're looking to use is installed
in your system. Please refer to the manual, available from
https://joaotavora.github.io/eglot/ or from M-x info for more usage
instructions.
If you wish to contribute changes to Eglot, please do read the user
manual first. Additionally, take the following in consideration:
* Eglot's main job is to hook up the information that language
servers offer via LSP to Emacs's UI facilities: Xref for
definition-chasing, Flymake for diagnostics, Eldoc for at-point
documentation, etc. Eglot's job is generally *not* to provide
such a UI itself, though a small number of simple
counter-examples do exist, e.g. in the `eglot-rename' command or
the `eglot-inlay-hints-mode' minor mode. When a new UI is
evidently needed, consider adding a new package to Emacs, or
extending an existing one.
* Eglot was designed to function with just the UI facilities found
in the latest Emacs core, as long as those facilities are also
available as GNU ELPA :core packages. Historically, a number of
:core packages were added or reworked in Emacs to make this
possible. This principle should be upheld when adding new LSP
features or tweaking existing ones. Design any new facilities in
a way that they could work in the absence of LSP or using some
different protocol, then make sure Eglot can link up LSP
information to it.
* There are few Eglot configuration variables. This principle
should also be upheld. If Eglot had these variables, it could be
duplicating configuration found elsewhere, bloating itself up,
and making it generally hard to integrate with the ever growing
set of LSP features and Emacs packages. For instance, this is
why one finds a single variable
`eglot-ignored-server-capabilities' instead of a number of
capability-specific flags, or why customizing the display of
LSP-provided documentation is done via ElDoc's variables, not
Eglot's.
* Linking up LSP information to other libraries is generally done
in the `eglot--managed-mode' minor mode function, by
buffer-locally setting the other library's variables to
Eglot-specific versions. When deciding what to set the variable
to, the general idea is to choose a good default for beginners
that doesn't clash with Emacs's defaults. The settings are only
in place during Eglot's LSP-enriched tenure over a project. Even
so, some of those decisions will invariably aggravate a minority
of Emacs power users, but these users can use `eglot-stay-out-of'
and `eglot-managed-mode-hook' to adjust things to their
preferences.
* On occasion, to enable new features, Eglot can have soft
dependencies on popular libraries that are not in Emacs core.
"Soft" means that the dependency doesn't impair any other use of
Eglot beyond that feature. Such is the case of the snippet
functionality, via the Yasnippet package, Markdown formatting of
at-point documentation via the markdown-mode package, and nicer
looking completions when the Company package is used.
Old versions
| eglot-1.21.0.20260121.122624.tar | 2026-Jan-21 | 520 KiB |
| eglot-1.21.0.20260121.122624.tar.lz | 2026-Jan-21 | 104 KiB |
| eglot-1.21.0.20260117.150219.tar | 2026-Jan-17 | 510 KiB |
| eglot-1.21.0.20260111.182825.tar.lz | 2026-Jan-11 | 101 KiB |
| eglot-1.20.0.20260111.34201.tar.lz | 2026-Jan-11 | 101 KiB |
| eglot-1.19.0.20260108.83650.tar.lz | 2026-Jan-08 | 96.0 KiB |
| eglot-1.18.0.20251020.115903.tar.lz | 2025-Oct-20 | 91.6 KiB |
| eglot-1.9.0.20221216.20928.tar.lz | 2022-Dec-16 | 36.4 KiB |
| eglot-1.8.0.20221008.103138.tar.lz | 2022-Oct-08 | 62.3 KiB |
| eglot-1.6.0.20200416.93101.tar.lz | 2020-Dec-14 | 262 KiB |
News
Eglot NEWS -*- outline -*- Copyright (C) 2018-2026 Free Software Foundation, Inc. See the end of the file for license conditions. Please send Eglot bug reports to 'bug-gnu-emacs@gnu.org', and Cc (or X-Debbugs-CC) the maintainer 'joaotavora@gmail.com' as well. Please read the chapter titled "Troubleshooting" in the Eglot manual, available https://joaotavora.github.io/eglot/#Troubleshooting-Eglot This file is about changes in Eglot, the Emacs client for LSP (Language Server Protocol) distributed with GNU Emacs since Emacs version 29.1 and with GNU ELPA since 2018. Note: references to some Eglot issues are presented as "github#nnnn". This refers to https://github.com/joaotavora/eglot/issues/. That is, to look up issue github#1234, go to https://github.com/joaotavora/eglot/issues/1234. * Changes to upcoming Eglot ** File watch limits to prevent resource exhaustion (github#1568) The new variable 'eglot-max-file-watches' limits the number of file watches that can be created. Some language servers request watching for a very large number of directories (e.g. Python virtualenvs), which can exhaust system resources and cause slow startup. ** Support for complex workspace edits (create/rename/delete files) Eglot now advertises support for file resource operations in workspace edits and can handle create, rename, and delete file operations. The confirmation UI has been reworked to handle mixed operation types. The 'eglot-confirm-server-edits' defcustom has been overhauled and now also accepts file operation kinds as keys in the alist form, providing more fine-grained control over what confirmation mechanism to use. ** 'eglot-advertise-cancellation' now defaults to t The variable 'eglot-advertise-cancellation' now defaults to t, which means Eglot will send '$/cancelRequest' notifications to servers when it thinks responses to inflight requests are no longer useful. The current 2026 LSP landscape (especially gopls and ocamllsp) suggests this is beneficial and helps servers avoid costly useless work. ** Imenu setup is more predictable (github#1569) Eglot now sets 'imenu-create-index-function' using ':override' advice, making the integration cleaner and more predictable. ** Fixed textDocument/prepareRename support (github#1554) Eglot now properly checks server capabilities before sending prepareRename requests. * Changes in Eglot 1.21 (11/1/2026) This is a bugfix release with small fixes for semantic tokens and Emacs 26.3 compatibility. * Changes in Eglot 1.20 (11/1/2026) ** Dramatically faster handling of files with many diagnostics Diagnostic conversion between LSP and Flymake versions is now much faster. Previously, editing, e.g. a Python file with thousands of diagnostics was next to impossible to to periodic interruptions of diagnostic reports. Now it's practically unnoticeable. ** Support for LSP server multiplexers via Rassumfrassum Eglot can now leverage LSP server multiplexer programs like Rassumfrassum (invoked via the 'rass' command) to use multiple language servers in a single buffer. This enables combining spell-checkers with language servers, using multiple servers for the same language (e.g., 'ty' for type checking and 'ruff' for linting in Python), or handling multi-language files like Vue. Some invocations of 'rass' are offered as alternatives in the built-in 'eglot-server-programs' variable. The manual (readable with 'M-x eglot-manual') contains a comprehensive discussion of how to set up and use multiplexers in the new "Multi-server support" chapter. ** Support for pull diagnostics (github#1559, github#1290) For servers supporting the 'diagnosticProvider' capability, Eglot requests diagnostics explicitly rather than relying on sporadic 'publishDiagnostics' notifications, aka. "push diagnostics". The 'tsgo' server is known to support the "pull" variant exclusively, while the 'ty' server is known to support it alongside "push". ** New command 'eglot-momentary-inlay-hints' ... ...