Skip to content

elisp-lsp/ellsp

Repository files navigation

License: GPL v3 Release JCS-ELPA

Ellsp

Elisp Language Server

CI Elisp Build Proxy

This software is intended for use with editors other than Emacs. If you're already an Emacs user, we recommend using Emacs directly.

Here is the list of currently supported editors:

✒️ Rationale

This software is intended to support editors beyond Emacs, targeting users who wish to work with Emacs Lisp in a more performant and responsive environment. Due to its single-threaded architecture, Emacs can become unresponsive when executing computationally intensive tasks.

A strong reference implementation is Emacs Elsa, which utilizes the Language Server Protocol (LSP) to delegate static analysis and other heavy operations to a separate Emacs process. This decoupling not only improves responsiveness in the primary editor but also enables parallelism, making large-scale analysis more practical.

🖼️ Gallery

Completion

Hover

Signature Help

🔧 Prerequisites

Before installation, make sure you have all the following software installed!

💾 Installation

Important

Ellsp can only be used with projects that utilize Eask as their package manager. Ensure your project is properly set up with Eask before using Ellsp.

Add these lines to your Eask-file:

(source 'gnu)
(source 'melpa)
(source 'jcs-elpa)

(development
 (depends-on "ellsp"))

Then install the language server:

# Install ellsp package.
eask install-deps --dev

# Install the proxy server.
eask exec install-ellsp

To test to see if the server installed successfully, execute the following command:

eask exec ellsp

If you see the following screen (no error), you successfully installed the language server! 🎉🥳

Updating environment variables... done v
Exporting environment variables... done v
18:45:59 [INFO ] Starting the language server...

🔊 P.S. Nothing output afterward because the language server is waiting for the language client to connect!

🔬 Development

To test the language server locally:

# Add link to current package
eask link add ellsp ./

Then follow the same steps as installation:

# Install the proxy server.
eask exec install-ellsp

# Test the language server.
eask exec ellsp

🔗 References

Contribute

PRs Welcome Elisp styleguide Donate on paypal Become a patron

If you would like to contribute to this project, you may either clone or make pull requests to this repository. Or you can clone the project and establish your branch of this tool. Any methods are welcome!

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.