34 KiB
Clojure layer
Description
This layer adds support for Clojure language using CIDER.
Features:
- REPL via CIDER
- REPL session management via Sesman
- Code formatting via CIDER using Cljfmt
- Aligning of code forms via clojure-mode
- Debugging with CIDER debug
- Clojure cheatsheet
Recommended optional features
- Structuraly safe editing using optional evil-cleverparens
- Linting via clj-kondo (joker and squiggly-clojure also available)
Other optional features
- Refactoring via clj-refactor
- Debugging with sayid (beta)
Install
Add the Clojure Layer
Edit the ~/.spacemacs
file and add the word clojure
to the existing
dotspacemacs-configuration-layers
list.
Reload the Spacemacs configuration, SPC f e R
or restart Spacemacs SPC q r
.
The latest snapshot packages from the CIDER orchard will automatically download.
Optional features
There are several optional features available for the Clojure layer.
clj-kondo and automatic linting is recommended, as this provides immediate feedback on the correctness of your code as you write it.
Fancify symbols replaces fn, #{} and partial with representative characters λ
ƒ
and Ƥ
clj-refactor provides Clojure specific refactor commands. The refactor commands are being migrated into CIDER clojure-mode. clj-refactor is not actively maintained, so use with caution.
sayid is a comprehensive debugger that analyses an entire project. Projects need to compile fully or issues may occur. sayid is not as actively maintained as CIDER and may cause issues.
Enabling Automatic Linting
clj-kondo, joker and squiggly-clojure provide automated linting via flycheck
.
These packages are disabled by default as they require the relevant linter binaries
to be installed locally.
clj-kondo is the recommended linter, as it is the most actively developed.
Enable clj-kondo linter
This linter based on static syntax checking and requires the clj-kondo binary
installed on the system PATH that spacemacs.env
includes. Please read the
clj-kondo binary installation instructions
Enable the clj-kondo automatic linter in Spacemacs by adding a :variables
option
to your Spacemacs configuration:
;; Witout any variables your configuration would just include clojure
dotspacemacs-configuration-layers
'(...
clojure
)
;; to use clj-kondo as a linter, add this variable to the clojure layer
;; wrapping the clojure layer in a list
dotspacemacs-configuration-layers
'(...
(clojure :variables
clojure-enable-linters 'clj-kondo)
)
Enable joker linter
This linter is based on static syntax checking and requires the joker binary
installed on the system PATH that spacemacs.env
includes. Please read the
joker binary installation instructions
Enable the joker automatic linter in Spacemacs by adding a :variables
option
to your Spacemacs configuration:
;; Witout any variables your configuration would just include clojure
dotspacemacs-configuration-layers
'(...
clojure
)
;; to use joker as a linter, add this variable to the clojure layer
;; wrapping the clojure layer in a list
dotspacemacs-configuration-layers
'(...
(clojure :variables
clojure-enable-linters 'joker)
)
Enable Squiggly linter
squiggly-clojure uses Eastwood and Kibit for linting. Please install these projects
before configuring Spacemacs with squiggly
.
Make sure to read the squiggly-clojure warnings section as squiggly reloads all code on every change, often giving unexpected results.
Please read the section on squiggly dependencies if you are using cider-connect
Enable the squiggly (eastwood, kibit and core.typed) automatic linter in Spacemacs by adding a :variables
option to your Spacemacs configuration:
;; Without any variables your configuration would just include Clojure
dotspacemacs-configuration-layers
'(...
clojure
)
;; to use squiggly as a linter, add this variable to the clojure layer
;; wrapping the clojure layer in a list
dotspacemacs-configuration-layers
'(...
(clojure :variables
clojure-enable-linters 'squiggly)
)
Troubleshooting: please read debugging and bug reporting and try to reproduce using the sample project.
Enable multiple linters
Multiple linters can all run together, potentially giving greater coverage. However, you also increase the number of false positives you have to resolve.
Follow the install instructions for each linter first, ensuring the binaries
are available on the system PATH that spacemacs.env
includes.
Then add each linter name to the clojure-enable-linters
:variables
option
in your Spacemacs configuration:
;; Witout any variables your configuration would just include clojure
dotspacemacs-configuration-layers
'(...
clojure
)
;; to enable multiple linters, say clj-kondo and joker, add a list variable to the clojure layer
;; listing each one in the order you want them running, wrapping the clojure layer in a list
dotspacemacs-configuration-layers
'(...
(clojure :variables
clojure-enable-linters '(clj-kondo joker))
)
Enable Clojure fancify Symbols
Fancify symbols re-writes your code and displays symbols for:
- function definitions with fn
(λ [a] (+ a 5))
and its syntax shortcutƒ(+ % 5)
- set literals
∈{2 4 6}
- partial functions
Ƥ
.
To enable this feature, add the following snippet to the
dotspacemacs/user-config
section of your ~/.spacemacs
file:
(setq clojure-enable-fancify-symbols t)
Or set this variable when loading the configuration layer:
(setq-default dotspacemacs-configuration-layers
'((clojure :variables clojure-enable-fancify-symbols t)))
Enabling sayid or clj-refactor
The packages sayid (Clojure debugger) and clj-refactor (automatic refactorings) are disabled by default. These packages are less active than the CIDER project and may cause issues when running CIDER.
To enable them, add a :variables
option when enabling the clojure
layer,
specifying clojure-enable-sayid
, or clojure-enable-clj-refactor
, or both.
In your Spacemacs configuration:
;; before
dotspacemacs-configuration-layers
'(...
clojure
)
;; after
dotspacemacs-configuration-layers
'(...
(clojure :variables
clojure-enable-sayid t
clojure-enable-clj-refactor t)
)
Enabling either of these packages will cause extra nREPL middleware to be injected when jacking in CIDER.
If you are experiencing issues when running a REPL, try disabling these packages first and restart Spacemacs to see if the error persists.
Usage
Read the key bindings section to see all the functionality available, or simply
use the ,
or SPC m
to open the which-key menu for the Clojure layer.
Starting a REPL from Spacemacs
Open a Clojure file (.clj, .cljs, .cljc, .edn) and start a Clojure REPL, choosing the REPL session type (Clojure, ClojureScript or both Clojure & ClojureScript).
, '
and , s i
calls the sesman-start
command, a wrapper for all the
jack-in
and connect
commands. A prompt appears allowing you to choose the
type of REPL session required.
, s j
opens the cider-jack-in menu, providing commands to start specific REPL sessions,
it is the same as using the sesman-start
command described previously.
Using the universal constant, SPC u
before any of the previous commands enables editing
of the command that starts the REPL. This is useful if you want to add a deps.edn
alias
or add your own dependencies to inject. The command is edited in the mini-buffer
Once the REPL starts, a confirmation message is displayed in the mini-buffer.
The REPL buffer does not open automatically (Clojure is typically evaluated in
the source code buffer). , s a
will switch between REPL and source code buffers,
opening the REPL buffer if not already shown.
Troubleshooting
If the REPL does not start, SPC b m
opens the message buffer and should show errors.
Also check the REPL buffer, , s a
for error messages.
Remove optional features from the Clojure layer, specifically sayid and clj-refactor. Restart Emacs and confirm the issue still occurs.
Visit #cider channel on Clojurians Slack community for help with CIDER, and #spacemacs channel for Spacemacs specific help
Connecting to a Clojure REPL outside of Emacs
Start a REPL outside of Emacs that includes an nREPL server. The IP address and port the nREPL runs on should be printed.
, '_
or SPC m s i
displays the sesman prompt, select the connect command relevant
to the type of REPL you wish to start.
, s c
opens the cider-connect menu, providing key bindings for connecting too the
different REPL session types.
CIDER communicates with your Clojure process through nREPL, and for CIDER to function correctly extra nREPL middleware needs to be present (cider/cider-nrepl). The same is true for clj-refactor (refactor-nrepl), and for sayid (com.billpiel/sayid).
Quick Start with boot
- Install
boot
2.8.2 or newer (see https://github.com/boot-clj/boot#user-content-install) -
Create a file
~/.boot/profile.boot
with the following content:(require 'boot.repl) (swap! boot.repl/*default-dependencies* conj ;; When running an older version of CIDER (pre 0.18), use the ;; version that best matches M-x cider-version. For versions since ;; 0.18.0 use whatever version is the most recent. '[cider/cider-nrepl "0.21.1"] ;; Only necessary when using clj-refactor '[refactor-nrepl "2.4.0"] ;; Only necessary when using sayid '[com.billpiel/sayid "0.0.17"]) (swap! boot.repl/*default-middleware* conj 'cider.nrepl/cider-middleware 'refactor-nrepl.middleware/wrap-refactor 'com.billpiel.sayid.nrepl-middleware/wrap-sayid)
Quick Start with lein
- Install
lein
version 2.9.0 or newer (see https://leiningen.org/#install) -
Create a file
~/.lein/profiles.clj
with the following content:{:repl {:plugins [;; When running an older version of CIDER (pre 0.18), use the ;; version that best matches M-x cider-version. For versions since ;; 0.18.0 use whatever version is the most recent. [cider/cider-nrepl "0.21.1"] ;; Only necessary when using clj-refactor [refactor-nrepl "2.4.0"] ;; Only necessary when using sayid [com.billpiel/sayid "0.0.17"]] :dependencies [[nrepl "0.4.5"]] :repl-options {:nrepl-middleware [refactor-nrepl.middleware/wrap-refactor ;; clj-refactor com.billpiel.sayid.nrepl-middleware/wrap-sayid ;; sayid ]}}}
More details
More info regarding installation of nREPL middleware can be found here:
- CIDER: CIDER installation (official docs)
- clj-refactor: refactor-nrepl
Managing REPL connections
Sesman is used for managing REPL connections when working simultaneously on multiple projects or have multiple connections opened for the same project
Files, directories and projects can be linked to an existing session.
See the REPL connections key bindings section for all the commands.
Cheatsheet
This layers installs the clojure-cheatsheet package which embeds this useful cheatsheet into Emacs.
Type SPC m h c
to display the cheatsheet then type in some terms (space
separated) to narrow down the list. For example, try typing in sort map to see
some functions that deal with sorting maps.
Structuraly safe editing
This layer adds support for evil-cleverparens
which allows to safely edit
lisp code by keeping the s-expressions balanced.
By default this mode is not activated. You can turn it on locally on the active
buffer with SPC m T s
(s
for safe).
To turn it on automatically for all clojure
buffers call the following
function in your dotspacemacs/user-config
function:
(spacemacs/toggle-evil-safe-lisp-structural-editing-on-register-hook-clojure-mode)
or to enable it for all supported modes:
(spacemacs/toggle-evil-safe-lisp-structural-editing-on-register-hooks)
When enabled the symbol 🆂
should be displayed in the mode-line.
Key bindings
Working with clojure files (barfage, slurpage & more)
Spacemacs comes with a special lisp-state
for working with lisp code that
supports slurpage, barfage and more tools you'll likely want when working with
lisp.
As this state works the same for all files, the documentation is in global
DOCUMENTATION.org. In general, use SPC k
to interact with the lisp-state.
Leader
Documentation
Key binding | Description |
---|---|
SPC m h a |
cider apropos |
SPC m h c |
clojure cheatsheet |
SPC m h d |
cider clojuredocs |
SPC m h h |
cider doc |
SPC m h j |
cider javadoc |
SPC m h n |
cider browse namespace |
SPC m h N |
cider browse all namespaces |
Evaluation
Key binding | Description |
---|---|
SPC m e ; |
eval sexp and show result as comment |
SPC m e B |
send and eval buffer and switch to REPL in insert state |
SPC m e b |
eval buffer |
SPC m e e |
eval last sexp |
SPC m e f |
eval function at point |
SPC m e i |
interrupt the current evaluation |
SPC m e l |
clear REPL buffer (cider-repl-clear-buffer) |
SPC m e L |
clear REPL buffer (cider-find-and-clear-repl-output) |
SPC m e m |
cider macroexpand 1 |
SPC m e M |
cider macroexpand all |
SPC m e p |
print last sexp (clojure interaction mode only) |
SPC m e P |
eval last sexp and pretty print result in separate buffer |
SPC m e r |
eval region |
SPC m e s e |
send and eval last sexp in REPL |
SPC m e s E |
send and eval last sexp and switch to REPL in insert state |
SPC m e s f |
send and eval function in REPL |
SPC m e s F |
send and eval function and switch to REPL in insert state |
SPC m e s n |
send and eval ns form in REPL |
SPC m e s N |
send and eval ns form and switch to REPL in insert state |
SPC m e s r |
send and eval region in REPL |
SPC m e s R |
send and eval region and switch to REPL in insert state |
SPC m e u |
Undefine a symbol from the current namespace |
SPC m e U |
require Clojure utils into current namespace - i.e. doc source |
SPC m e v |
eval sexp around point |
SPC m e w |
eval last sexp and replace with result |
Goto
Key binding | Description |
---|---|
SPC m g b |
go back |
SPC m g C |
browse classpath |
SPC m g g |
goto var definition spacemacs/clj-find-var |
SPC m g e |
goto error |
SPC m g n |
goto namespace |
SPC m g r |
goto resource |
SPC m g s |
browse spec |
SPC m g S |
browse all specs |
REPL Sessions
Key binding | Description |
---|---|
SPC m , |
command menu in REPL buffer (cider-repl-handle-shortcut) |
SPC m ' |
start a REPL connection (helm selection of REPL type) |
SPC m s a |
switch between REPL and last Clojure source code buffer (cider-repl) |
SPC m s b |
browse REPL session (sesman-browser) |
SPC m s c j |
connect to a running Clojure REPL (cider-connect-clj) |
SPC m s c m |
connect to a running Clojure & ClojureScript REPL (cider-connect-clj&cljs) |
SPC m s c s |
connect to a running ClojureScript REPL (cider-connect-cljs) |
SPC m s i |
start a REPL connection (helm selection of REPL type) |
SPC m s I |
current REPL session information, prefix SPC u for all sessions (sesman-info) |
SPC m s j j |
start Clojure REPL (cider-jack-in-clj ) |
SPC m s j m |
start Clojure REPL (cider-jack-in-clj&cljs ) |
SPC m s j s |
start ClojureScript REPL (cider-jack-in-cljs ) |
SPC m s l b |
link buffer to REPL session (seman-link-with-buffer) |
SPC m s l d |
link directory to REPL session (seman-link-with-directory) |
SPC m s l p |
link project to REPL session (seman-link-with-project) |
SPC m s l u |
unlink from REPL session (seman-unlink) |
SPC m s o |
switch to other repl instance (cider-repl-switch-to-other) |
SPC m s s j |
connect as sibling to existing Clojure REPL |
SPC m s s s |
connect as sibling to existing ClojureScript REPL |
SPC m s r |
restart REPL (cider-restart) |
SPC m s R |
restart REPL Session (sesman-restart) |
SPC m s q |
quit REPL (cider-quit) |
SPC m s Q |
quit REPL session (sesman-quit) |
SPC m s x |
refresh REPL (cider-ns-refresh) |
Tests
Key binding | Description |
---|---|
SPC m t a |
run all tests in namespace |
SPC m t r |
re-run test failures for namespace |
SPC m t t |
run test at point |
Toggles
Key binding | Description |
---|---|
SPC m T e |
toggle englighten mode |
SPC m T f |
toggle REPL font-locking |
SPC m T i |
toggle indentation style |
SPC m T p |
toggle REPL pretty-printing |
SPC m T t |
toggle auto test mode |
Debugging
Key binding | Description |
---|---|
SPC m d ! |
reload traces and clear sayid workspace |
SPC m d b |
instrument expression at point |
SPC m d c |
clear workspace trace log |
SPC m d e |
display last stacktrace |
SPC m d E |
one time display of value at cursor |
SPC m d f |
query form at point |
SPC m d h |
show sayid help (key bindings may not be accurate) |
SPC m d i |
inspect expression at point |
SPC m d r |
reload namespaces |
SPC m d s |
show what is currently traced |
SPC m d S |
show what is currently traced in current namespace |
SPC m d t b |
trace current file's namespace |
SPC m d t d |
disable existing trace on current function |
SPC m d t D |
disable existing trace on all functions |
SPC m d t e |
enable existing trace on current function |
SPC m d t E |
enable existing trace on all functions |
SPC m d t K |
remove all traces |
SPC m d t n |
create inner trace on function |
SPC m d t o |
create outer trace on function |
SPC m d t p |
trace namespaces by regex |
SPC m d t r |
remove trace on function |
SPC m d t y |
recursively trace every namespace in given dir |
SPC m d v |
inspect expression at point |
SPC m d V |
set the view |
SPC m d w |
open sayid workspace window |
SPC m d x |
clear workspace traces and log |
Refactoring
The following refactoring key bindings are enabled by default in clojure-mode:
Key binding | Description |
---|---|
SPC m r c i |
cycle between if and if-not forms |
SPC m r c p |
cycle privacy of defn and def forms |
SPC m r c ( |
convert coll to list |
SPC m r c ' |
convert coll to quoted list |
SPC m r c { |
convert coll to map |
SPC m r c # |
convert coll to set |
SPC m r c [ |
convert coll to vector |
SPC m r t f |
rewrite the following form to use the -> (thread first) macro. |
SPC m r t l |
rewrite the following form to use the ->> (thread last) macro. |
SPC m r t h |
thread another form into the surrounding threading macro |
SPC m r u a |
unwind all steps of surrounding threading macro |
SPC m r u w |
unwind threading macro one step at a time |
The following refactorings require cljr-refactor to be enabled and generally depend on a connected CIDER session.
Key binding | Description |
---|---|
SPC m r ? |
describe refactoring |
SPC m r a d |
add declaration |
SPC m r a i |
add import to ns |
SPC m r a m |
add missing libspec |
SPC m r a p |
add project dependency |
SPC m r a r |
add require to ns |
SPC m r a u |
add use to ns |
SPC m r c : |
toggle between keyword and string |
SPC m r c n |
clean ns |
SPC m r d k |
destructure keys |
SPC m r e c |
extract constant |
SPC m r e d |
extract definition |
SPC m r e f |
extract function |
SPC m r e l |
expand let |
SPC m r f u |
find usages |
SPC m r f e |
create fn from example |
SPC m r h d |
hotload dependency |
SPC m r i l |
introduce let |
SPC m r i s |
inline symbol |
SPC m r m f |
move form |
SPC m r m l |
move to let |
SPC m r p c |
project clean |
SPC m r p f |
promote function |
SPC m r r d |
remove debug fns |
SPC m r r f |
rename file |
SPC m r r l |
remove let |
SPC m r r r |
remove unused requires |
SPC m r r s |
rename symbol |
SPC m r r u |
replace use |
SPC m r s n |
sort ns |
SPC m r s p |
sort project dependencies |
SPC m r s r |
stop referring |
SPC m r s c |
show changelog |
SPC m r u p |
update project dependencies |
Reformatting
Key binding | Description |
---|---|
SPC m f b or SPC m = |
reformat current buffer |
SPC m f l |
realign current form |
Profiling
Key binding | Description |
---|---|
SPC m p + |
profile samples |
SPC m p c |
clear profile |
SPC m p n |
toggle profile ns |
SPC m p s |
profile summary |
SPC m p S |
summary for all |
SPC m p t |
toggle profile |
SPC m p v |
is variable profiled |
CIDER Buffers
In general, q
should always quit the popped up buffer.
cider-repl-mode
Key binding | Description |
---|---|
C-j |
next input |
C-k |
previous input |
stacktrace-mode
Key binding | Description |
---|---|
C-j |
next cause |
C-k |
previous cause |
TAB |
cycle current cause |
0 |
cycle all causes |
1 |
cycle cause 1 |
2 |
cycle cause 2 |
3 |
cycle cause 3 |
4 |
cycle cause 4 |
5 |
cycle cause 5 |
a |
toggle all |
c |
toggle clj |
d |
toggle duplicates |
J |
toggle java |
r |
toggle repl |
T |
toggle tooling |
inspector-mode
Key binding | Description |
---|---|
TAB |
next inspectable object |
Shift-TAB |
previous inspectable object |
RET |
inspect object |
L |
pop to the parent object |
n |
next page in paginated view |
N |
previous page in paginated view |
r |
refresh |
s |
set a new page size |
test-report-mode
Key binding | Description |
---|---|
C-j |
next result |
C-k |
previous result |
RET |
jump to test |
d |
ediff test result |
e |
show stacktrace |
r |
rerun failed tests |
t |
run test |
T |
run tests |
Sayid Buffers
sayid-mode
Key binding | Description |
---|---|
Shift-Backspace |
forward buffer state |
enter |
pop to function |
d |
def value to $s/* |
f |
query for calls to function |
F |
query to calls to function with modifier |
i |
show only this instance |
I |
show only this instance with modifier |
L or Backspace |
previous buffer state |
n |
jump to next call |
N |
jump to previous call |
P |
pretty print value |
C |
clear workspace trace log |
e |
generate instance expression and put in kill ring |
H |
display help (key bindings may not be accurate) |
w |
show full workspace trace |
C-s v |
toggle view |
C-s V |
set view |
sayid-traced-mode
Key binding | Description |
---|---|
backspace |
go back to trace overview |
enter |
drill into ns at point |
e |
enable trace |
E |
enable all traces |
d |
disable trace |
D |
disable all traces |
h |
display help (key bindings may not be accurate) |
i |
apply inner trace to function at point |
o |
apply outer trace to function at point |
r |
remove trace at point |
sayid-pprint
Key binding | Description |
---|---|
enter |
show path in minibuffer |
i |
enter child node |
o |
enter parent node |
n |
enter next sibling node |
p |
enter previous sibling node |
Development Notes
Indentation
With a Indentation spec functionality of Cider to read the custom indentation rules from the var's metadata, it is better for consistency reasons to not add the custom indentation rules to Spacemacs, but to add them to the metadata of those specific vars.