A Language Server for Clojure. Taking a Cursive-like approach of statically analyzing code.
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, and perform refactorings.
You will get:
- Autocomplete
- Jump to definition
- Find usages
- Renaming
- Errors
- Automatic ns management
- Refactorings
This is an early work in progress, contributions are very welcome.
- 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 below.
See troubleshooting.md.
capability | done | notes |
---|---|---|
completionProvider | √ | |
referencesProvider | √ | |
renameProvider | √ | |
definitionProvider | TODO: java classes | |
diagnostics | TODO: wrong arity, others? | |
hover | √ | |
formatting | √ |
It should be possible to introduce most of the refactorings here: https://github.com/clojure-emacs/clj-refactor.el/tree/master/examples
Calling executeCommand with the following commands and additional args will notify the client with applyEdit
.
All commands expect the first three args to be [document-uri, line, column]
(eg ["file:///home/snoe/file.clj", 13, 11]
)
done | command | args | notes |
---|---|---|---|
√ | cycle-coll | ||
√ | thread-first | ||
√ | thread-first-all | ||
√ | thread-last | ||
√ | thread-last-all | ||
√ | introduce-let | [document-uri, line, column, binding-name] |
|
√ | move-to-let | [document-uri, line, column, binding-name] |
|
√ | expand-let | ||
√ | add-missing-libspec | ||
- | clean-ns |
See Vim client section for an example.
Other clients might provide a higher level interface to workspace/executeCommand
you need to pass the path, line and column numbers.
It is possible to pass some options to clojure-lsp through clients' InitializationOptions
. Options are a map with keys:
source-paths
value is a vector of project-local directories to look for clj/cljc/cljs files. Default is ["src","test"]
.
dependency-scheme
by default, dependencies are linked with vim's zipfile://<zipfile>::<innerfile>
scheme, however you can use a scheme of jar
to get urls compatible with java's JarURLConnection. You can have the client make an lsp extension request of clojure/dependencyContents
with the jar uri and the server will return the jar entry's contents. Similar to java clients
cljfmt
json encoded configuration for https://github.com/weavejester/cljfmt
"cljfmt": {
"indents": {
"#.*": [["block", 0]],
"ns": [["inner", 0], ["inner", 1]],
"and": [["inner", 0]],
"or": [["inner", 0]],
"are": [["inner", 0]]
}},
macro-defs
value is a map of fully-qualified macros to a vector of definitions of those macros' forms.
Valid element definitions are:
{"element": "declaration", "tags", ["unused", "local"], "signature": ["next"]}
This marks a symbol or keyword as a definition.tags
are optional. Theunused
tag supresses the "unused declaration" diagnostic, useful fordeftest
vars. Thelocal
tag marks the var as private.signature
is optional - if the macro hasdefn
-like bindings this vector of movements should point to the parameter vector or the first var arg list form (onlynext
is supported right now).- e.g.
(my-defn- my-name "docstring" [& params] (count params))
=>{"my.ns/my-defn-" [{"element": "declaration", "tags", ["local"], "signature": ["next" "next"]}]}
- e.g.
bindings
This markslet
andfor
-like bindings.bound-elements
will have these bindings in their scope.- e.g.
(my-with-open [resource ()] ....)
=>{"my.ns/my-with-open" ["bindings", "bound-elements"]}
- e.g.
function-params-and-bodies
This will parse function like forms that support optional var-args likefn
.- e.g.
(myfn ([a] ...) ([b] ...)) (myfn [c] ...)
=>{"my.ns/myfn" ["function-params-and-bodies"]}
- e.g.
params
This marks adefn
like parameter vector.bound-elements
will have these parameters in their scope.- e.g.
(myfn [c] ...)
=>{"my.ns/myfn" ["params", "bound-elements"]}
- e.g.
param
This marks a singledefn
like parameter.bound-elements
will have these parameters in their scope.elements
This will parse the rest of the elements in the macro form with the usual rules.- e.g.
(myif-let [answer (expr)] answer (log "no answer") "no answer")
=>{"my.ns/myif-let" ["bindings", "bound-element", "elements"]}
- e.g.
element
This will parse a single element in the macro form with the usual rules.bound-elements
This will parse the rest of the elements in the macro form with the usual rules but with anybindings
orparams
in scope.bound-element
This will parse a single element in the macro form with the usual rules but with anybindings
orparams
in scope.
See https://github.com/snoe/clojure-lsp/blob/master/test/clojure_lsp/parser_test.clj for examples.
Clients are either editors with built in LSP support like Oni, or an appropriate plugin. Clients are responsible for launching the server, the server is a subprocess of your editor not a daemon.
In general, make sure to configure the client to use stdio and a server launch command like ['/usr/local/bin/clojure-lsp']
.
If that fails, you may need to have your client launch inside a shell, so use someting like ['bash', '-c', '/usr/local/bin/clojure-lsp']
.
In windows you probably need to rename to clojure-lsp.bat
.
I prefer https://github.com/neoclide/coc.nvim but both http://github.com/autozimu/LanguageClient-neovim and https://github.com/prabirshrestha/vim-lsp work well.
See my nvim/init.vim and coc-settings.json
LanguageClient-neovim can be configure with:
Refactorings:
function! Expand(exp) abort
let l:result = expand(a:exp)
return l:result ==# '' ? '' : "file://" . l:result
endfunction
nnoremap <silent> crcc :call LanguageClient#workspace_executeCommand('cycle-coll', [Expand('%:p'), line('.') - 1, col('.') - 1])<CR>
nnoremap <silent> crth :call LanguageClient#workspace_executeCommand('thread-first', [Expand('%:p'), line('.') - 1, col('.') - 1])<CR>
nnoremap <silent> crtt :call LanguageClient#workspace_executeCommand('thread-last', [Expand('%:p'), line('.') - 1, col('.') - 1])<CR>
nnoremap <silent> crtf :call LanguageClient#workspace_executeCommand('thread-first-all', [Expand('%:p'), line('.') - 1, col('.') - 1])<CR>
nnoremap <silent> crtl :call LanguageClient#workspace_executeCommand('thread-last-all', [Expand('%:p'), line('.') - 1, col('.') - 1])<CR>
nnoremap <silent> crml :call LanguageClient#workspace_executeCommand('move-to-let', [Expand('%:p'), line('.') - 1, col('.') - 1, input('Binding name: ')])<CR>
nnoremap <silent> cril :call LanguageClient#workspace_executeCommand('introduce-let', [Expand('%:p'), line('.') - 1, col('.') - 1, input('Binding name: ')])<CR>
nnoremap <silent> crel :call LanguageClient#workspace_executeCommand('expand-let', [Expand('%:p'), line('.') - 1, col('.') - 1])<CR>
nnoremap <silent> cram :call LanguageClient#workspace_executeCommand('add-missing-libspec', [Expand('%:p'), line('.') - 1, col('.') - 1])<CR>
InitializationOptions
can be sent by setting:
let g:LanguageClient_settingsPath=".lsp/settings.json"
Project-local .lsp/settings.json
would have content like:
{"initializationOptions": {
"source-paths": ["shared-src", "src", "test", "dashboard/src"],
"macro-defs": {"project.macros/dofor": ["bindings", "bound-elements"]}}}
Seems to work reasonably well but couldn't get rename to work reliably https://github.com/onivim/oni
https://github.com/gtache/intellij-lsp tested only briefly.
Proof of concept in the client-vscode directory in this repo.
I tried making a client but my hello world attempt didn't seem to work. If someone wants to take this on, I'd be willing to package it here too.
Using https://github.com/emacs-lsp the following works for registering clojure-lsp:
(require 'lsp-mode)
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection '("bash" "-c" "clojure-lsp"))
:major-modes '(clojure-mode clojurec-mode clojurescript-mode)
:server-id 'clojure-lsp))
(add-to-list 'lsp-language-id-configuration '(clojure-mode . "clojure-mode"))
(setq lsp-enable-indentation nil)
(add-hook 'clojure-mode-hook #'lsp)
(add-hook 'clojurec-mode-hook #'lsp)
(add-hook 'clojurescript-mode-hook #'lsp)
- configuration (see joker lint options)
- Better completion item kinds and auto require
- other lsp capabilities?