Skip to content

CI Slack community Github starts

clojure-lsp#

A Language Server for Clojure. Taking a Cursive-like approach of statically analyzing code.


homepagefeaturesinstallationsettingsclientstroubleshootingsupport us


Overview#

The goal of this project is to bring great editing tools for Clojure to all editors. It aims to work alongside you to help you navigate, identify and fix errors, perform refactors and much more!

You will get:

  • Autocomplete
  • Jump to definition
  • Find references
  • Renaming
  • Code actions
  • Errors
  • Automatic ns management
  • Refactorings
  • Code lens
  • Semantic tokens (syntax highlighting)
  • Call hierarchy

For all available features, check the features section.


Contribution#

Contributions to clojure-lsp are very welcome! You can open an issue or a PR and we'd love to help.


Building#

For building the jar manually, run lein bin to generate the embedded jar inside target folder or lein uberjar for building the standalone jar.

GraalVM#

Every release the native binaries (Windows, Linux and MacOS) are compiled with GraalVM and uploaded.

To build a native image with GraalVM:

  • Install the GraalVM 21.0.0 for Java 11 and set the GRAALVM_HOME to the installation dir
  • Install native-image with $GRAALVM_HOME/bin/gu install native-image
  • Run from clojure-lsp project root ./graalvm/native-unix-compile.sh or ./graalvm/native-windows-compile.bat.

The build may take some minutes and the result will be a ./clojure-lsp native binary.


Development#

For clojure-lsp development, there are 3 possible ways of finding a bug or implementing a new feature:

  • Create a test for your bug/feature, then implement the code following the test.
  • clojure-lsp starts a NREPL server if built with lein with-profile :debug bin, with that it's possible to change the code of a running instance and see the changes on your client in real time. To get the NREPL port, you can check the /tmp/clojure-lsp.*.out log, it will print the NREPL port on server startup or you can get it via server-info custom LSP command.
  • Build clojure-lsp with your changes and test it manually in your client, this is the slowest option, but it makes sense for final tests.
  • For debugging purposes, there is two custom commands server-info and cursor-info.

Support the project#

clojure-lsp has more than 8.000 lines of code, to keep all of this working, we need to help the community on a lot of issues and implement new features. As a LSP server, this project is the base for Clojure clients like Emacs(lsp-mode), VSCode(Calva) and vim.

You can help us keep going and improving it by supporting the project

Special thanks to Eccentric-J for the clojure-lsp logo


Last update: March 1, 2021