https://github.com/elisp-lsp/ellsp
Elisp Language Server
https://github.com/elisp-lsp/ellsp
elisp emacs language-server lsp
Last synced: 8 months ago
JSON representation
Elisp Language Server
- Host: GitHub
- URL: https://github.com/elisp-lsp/ellsp
- Owner: elisp-lsp
- License: gpl-3.0
- Created: 2023-11-08T08:37:23.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-22T22:45:20.000Z (9 months ago)
- Last Synced: 2025-04-22T23:35:00.764Z (9 months ago)
- Topics: elisp, emacs, language-server, lsp
- Language: Emacs Lisp
- Homepage:
- Size: 48.4 MB
- Stars: 27
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/elisp-lsp/ellsp/releases/latest)
[](https://jcs-emacs.github.io/jcs-elpa/#/ellsp)
# Ellsp
> Elisp Language Server
[](https://github.com/elisp-lsp/ellsp/actions/workflows/test-elisp.yml)
[](https://github.com/elisp-lsp/ellsp/actions/workflows/build-proxy.yml)
This software is designed to be used with editors other than Emacs. If you are
an Emacs user already, I prefer you use Emacs directly.
Here is the list of currently supported editors:
- [Emacs]() (`M-x ellsp-register`)
- [VSCode](https://marketplace.visualstudio.com/items?itemName=jcs090218.Ellsp)
## 🖼️ Gallery
### Completion
### Hover
### Signature Help
## 🔧 Prerequisites
Before installation, make sure you have all the following software installed!
- [Emacs](https://www.gnu.org/software/emacs/)
- [Eask](https://github.com/emacs-eask/cli)
## 💾 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:
```elisp
(source 'jcs-elpa)
(development
(depends-on "ellsp"))
```
Then install the language server:
```sh
# 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:
```sh
eask exec ellsp
```
If you see the following screen (no error), you successfully installed the language server! 🎉🥳
```sh
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:
```sh
# Add link to current package
eask link add ellsp ./
```
Then follow the same steps as installation:
```sh
# Install the proxy server.
eask exec install-ellsp
# Test the language server.
eask exec ellsp
```
## 🔗 References
- [Language Server Protocol Specification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/)
- [Elsa](https://github.com/emacs-elsa/Elsa)
## Contribute
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
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 .
See [`LICENSE`](./LICENSE) for details.