Skip to content

API#

clojure-lsp is commonly used in a text editor, but it has its own API featuring the main features that can be used as a library or via CLI. This is a new feature and it's experimental, so things can break at any moment, so please open an issue if find anything wrong.

Usages#

CLI#

clojure-lsp --help should show all available commands and options.

Library#

The namespace clojure-lsp.api should be used as the entrypoint for the same available features of the CLI, feel free to open a issue for missing features.

Below is an example using the clean-ns feature on a deps.edn project:

{:aliases 
  {:lint-ns {:replace-deps {com.github.clojure-lsp/clojure-lsp {:mvn/version "..."}}
             :exec-fn clojure-lsp.api/clean-ns!
             :exec-args {:dry? true}}}}

CI#

You can use setup-clojure-lsp GitHub action to install clojure-lsp in a CI.

Remember to install your build tool, like clojure or leiningen as well in your CI according to your project to clojure-lsp be able to scan the classpath correctly.

Leiningen#

To run clojure-lsp from leiningen easily, check lein-clojure-lsp plugin.

Usage#

  • clean-ns

Useful for cleaning the namespaces forms of your project, removing any unused required, import or refer, sorting and indenting correctly.

  • format

Useful for formatting the namespaces of your project, using cljfmt and following the rules from the :cljfmt clojure-lsp setting.

  • diagnostics

Bring all diagnostics/lint found by clojure-lsp (using clj-kondo under the hood).

  • rename

Rename a symbol and all its references across the project.

Settings#

clojure-lsp will check for .lsp/config.edn in the project or home dir, but it's possible to force override the settings via the :settings option of the API or --settings option of the CLI.

For all available settings, check the settings section documentation.


Last update: September 19, 2021