/clojure-lsp

Language Server (LSP) for Clojure

Primary LanguageClojureMIT LicenseMIT

CI Slack community Github starts

clojure-lsp

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

homepage • installation • settings • clients • capabilities • troubleshooting • support 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)

Installation

Manually

  • You need java on your $PATH.
  • Grab the latest clojure-lsp from github LATEST
  • Place it in your $PATH with a chmod 755
  • Follow the documentation for your editor's language client. See Clients.

Nix

clojure-lsp is available in the nixpkgs:

nix-shell -p clojure-lsp

Building manually

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

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, 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 final tests.
  • For debugging purposes, there is two custom commands server-info and cursor-info.

Contribution

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

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