[Clojure] Sesman and missing eval / format keybindings
Added keybindings for the Sesman REPL session management commands to the Clojure layer, following the Spacemacs keybinding conventions. https://docs.cider.mx/cider/0.23/usage/managing_connections.html Sesman has been a part of CIDER for many versions now and provides session management for nREPL connections (in fact any connections). Sesman keybinds are placed in the `SPC m c` menu, providing a cleaner separation between sending code to the repl and session management. See issue #12593 and PR #13140 which covers the background for the design of these additional keybindings. Formatting the region and defun keybinds have been added, along with formatting for edn files. Moved to `=` menu to match Spacemacs convention. Evaluation up to point keybinding has also been added. Documentation in the README has been updated to complete the description of the existing Clojure layer, as well as including details specific to the new keybindings.
This commit is contained in:
jr0cket
Sylvain Benner
parent
f553b3622d
commit
79842c89cf
|
|
@ -1470,6 +1470,44 @@ Other:
|
||||||
- Removed ~SPC m h g~ for =grimoire= as it is deprecated (thanks to Sam Hedin)
|
- Removed ~SPC m h g~ for =grimoire= as it is deprecated (thanks to Sam Hedin)
|
||||||
- ~C-return~ to =cider-repl-newline-and-indent= in REPL evil insert state
|
- ~C-return~ to =cider-repl-newline-and-indent= in REPL evil insert state
|
||||||
(thanks to Gia Thanh Vuong)
|
(thanks to Gia Thanh Vuong)
|
||||||
|
- changed clear repl buffer of evaluation to match terminal clear key
|
||||||
|
~SPC s s l~ 'cider-repl-clear-buffer
|
||||||
|
~SPC s s L~ 'cider-find-and-clear-repl-output
|
||||||
|
(thanks to John Stevenson)
|
||||||
|
- Add sesman session management keybindings to ~SPC m m~
|
||||||
|
~SPC m m b~ 'sesman-browser
|
||||||
|
~SPC m m i~ 'sesman-info
|
||||||
|
~SPC m m g~ 'sesman-goto
|
||||||
|
~SPC m m l b~ 'sesman-link-buffer
|
||||||
|
~SPC m m l d~ 'sesman-link-directory
|
||||||
|
~SPC m m l p~ 'sesman-link-project
|
||||||
|
~SPC m m l u~ 'sesman-unlink
|
||||||
|
~SPC m m q q~ 'sesman-quit
|
||||||
|
~SPC m m q r~ 'sesman-restart
|
||||||
|
~SPC m m s~ 'sesman-start
|
||||||
|
~SPC m m S j~ 'cider-connect-sibling-clj
|
||||||
|
~SPC m m S s~ 'cider-connect-sibling-cljs
|
||||||
|
(thanks to John Stevenson)
|
||||||
|
- updated repl shortcut to use sesman-start wrapper, selecting any repl type
|
||||||
|
~SPC m '~ 'sesman-start
|
||||||
|
- changed toggle between source and repl to match key for toggle between code
|
||||||
|
and test
|
||||||
|
~SPC m s a~ (if (eq m 'cider-repl-mode)
|
||||||
|
'cider-switch-to-last-clojure-buffer
|
||||||
|
'cider-switch-to-repl-buffer)
|
||||||
|
(thanks to John Stevenson)
|
||||||
|
- added formatting command not previously included
|
||||||
|
~SPC m = =~ 'cider-format-buffer
|
||||||
|
~SPC m = e b~ 'cider-format-edn-last-sexp
|
||||||
|
~SPC m = e e~ 'cider-format-edn-last-sexp
|
||||||
|
~SPC m = e r~ 'cider-format-edn-region
|
||||||
|
~SPC m = f~ 'cider-format-defun
|
||||||
|
~SPC m = l ~ 'cider-format-region
|
||||||
|
~SPC m = r~ 'cider-format-region
|
||||||
|
(thanks to John Stevenson)
|
||||||
|
- added evaluation keybinding - evaluate up to point
|
||||||
|
~SPC m e V~ 'cider-eval-sexp-up-to-point
|
||||||
|
(thanks to John Stevenson)
|
||||||
- Fixes:
|
- Fixes:
|
||||||
- Removed =cider.nrepl/cider-middleware= in lein quick start setting
|
- Removed =cider.nrepl/cider-middleware= in lein quick start setting
|
||||||
- Fixed =cider-inspector-prev-page= binding, also add ~p~ as another key
|
- Fixed =cider-inspector-prev-page= binding, also add ~p~ as another key
|
||||||
|
|
|
||||||
|
|
@ -7,29 +7,38 @@
|
||||||
* Table of Contents :TOC_5_gh:noexport:
|
* Table of Contents :TOC_5_gh:noexport:
|
||||||
- [[#description][Description]]
|
- [[#description][Description]]
|
||||||
- [[#features][Features:]]
|
- [[#features][Features:]]
|
||||||
|
- [[#related-layers][Related layers]]
|
||||||
|
- [[#other-optional-features][Other optional features]]
|
||||||
|
- [[#references][References]]
|
||||||
- [[#install][Install]]
|
- [[#install][Install]]
|
||||||
- [[#layer][Layer]]
|
- [[#add-the-clojure-layer-manually][Add the Clojure Layer manually]]
|
||||||
- [[#pretty-symbols][Pretty Symbols]]
|
- [[#pretty-symbols][Pretty Symbols]]
|
||||||
- [[#enabling-sayid-or-clj-refactor][Enabling sayid or clj-refactor]]
|
|
||||||
- [[#enabling-automatic-linting][Enabling Automatic Linting]]
|
- [[#enabling-automatic-linting][Enabling Automatic Linting]]
|
||||||
- [[#enable-clj-kondo-linter][Enable clj-kondo linter]]
|
- [[#enable-clj-kondo-linter][Enable clj-kondo linter]]
|
||||||
- [[#enable-joker-linter][Enable joker linter]]
|
- [[#enable-joker-linter][Enable joker linter]]
|
||||||
- [[#enable-squiggly-linter][Enable Squiggly linter]]
|
- [[#enable-squiggly-linter][Enable Squiggly linter]]
|
||||||
- [[#enable-multiple-linters][Enable multiple linters]]
|
- [[#enable-multiple-linters][Enable multiple linters]]
|
||||||
- [[#starting-clojure-manually-outside-of-emacs][Starting Clojure manually (outside of Emacs)]]
|
- [[#enable-clojure-fancify-symbols][Enable Clojure fancify Symbols]]
|
||||||
|
- [[#enabling-sayid-or-clj-refactor][Enabling sayid or clj-refactor]]
|
||||||
|
- [[#usage][Usage]]
|
||||||
|
- [[#starting-a-repl-from-spacemacs][Starting a REPL from Spacemacs]]
|
||||||
|
- [[#troubleshooting][Troubleshooting]]
|
||||||
|
- [[#connecting-to-a-clojure-repl-outside-of-emacs][Connecting to a Clojure REPL outside of Emacs]]
|
||||||
- [[#quick-start-with-boot][Quick Start with boot]]
|
- [[#quick-start-with-boot][Quick Start with boot]]
|
||||||
- [[#quick-start-with-lein][Quick Start with lein]]
|
- [[#quick-start-with-lein][Quick Start with lein]]
|
||||||
- [[#more-details][More details]]
|
- [[#more-details][More details]]
|
||||||
- [[#usage][Usage]]
|
- [[#managing-repl-connections][Managing REPL connections]]
|
||||||
- [[#cheatsheet][Cheatsheet]]
|
- [[#cheatsheet][Cheatsheet]]
|
||||||
- [[#structuraly-safe-editing][Structuraly safe editing]]
|
- [[#structuraly-safe-editing][Structuraly safe editing]]
|
||||||
- [[#key-bindings][Key bindings]]
|
- [[#key-bindings][Key bindings]]
|
||||||
- [[#working-with-clojure-files-barfage-slurpage--more][Working with clojure files (barfage, slurpage & more)]]
|
- [[#working-with-clojure-files-barfage-slurpage--more][Working with clojure files (barfage, slurpage & more)]]
|
||||||
- [[#leader][Leader]]
|
- [[#leader][Leader]]
|
||||||
|
- [[#shortcuts][Shortcuts]]
|
||||||
|
- [[#managing-repl-connections-1][Managing REPL connections]]
|
||||||
- [[#documentation][Documentation]]
|
- [[#documentation][Documentation]]
|
||||||
- [[#evaluation][Evaluation]]
|
- [[#evaluation][Evaluation]]
|
||||||
- [[#goto][Goto]]
|
- [[#goto][Goto]]
|
||||||
- [[#repl][REPL]]
|
- [[#send-code-to-repl][Send code to REPL]]
|
||||||
- [[#tests][Tests]]
|
- [[#tests][Tests]]
|
||||||
- [[#toggles][Toggles]]
|
- [[#toggles][Toggles]]
|
||||||
- [[#debugging][Debugging]]
|
- [[#debugging][Debugging]]
|
||||||
|
|
@ -49,7 +58,8 @@
|
||||||
- [[#indentation][Indentation]]
|
- [[#indentation][Indentation]]
|
||||||
|
|
||||||
* Description
|
* Description
|
||||||
This layer adds support for [[https://clojure.org/][Clojure]] language using [[https://github.com/clojure-emacs/cider][CIDER]].
|
This layer adds support for [[https://clojure.org/][Clojure]] language using [[https://github.com/clojure-emacs/cider][CIDER]], providing Clojure REPL management
|
||||||
|
and a full suite of tooling for Clojure development.
|
||||||
|
|
||||||
** Features:
|
** Features:
|
||||||
- REPL via [[https://github.com/clojure-emacs/cider][CIDER]]
|
- REPL via [[https://github.com/clojure-emacs/cider][CIDER]]
|
||||||
|
|
@ -60,12 +70,29 @@ This layer adds support for [[https://clojure.org/][Clojure]] language using [[h
|
||||||
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]]
|
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]]
|
||||||
- Clojure cheatsheet
|
- Clojure cheatsheet
|
||||||
- Structuraly safe editing using optional [[https://github.com/luxbock/evil-cleverparens][evil-cleverparens]]
|
- Structuraly safe editing using optional [[https://github.com/luxbock/evil-cleverparens][evil-cleverparens]]
|
||||||
|
- Linting via [[https://github.com/borkdude/clj-kondo][clj-kondo]] ([[https://github.com/candid82/joker][joker]] and [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]] also available)
|
||||||
|
|
||||||
|
*** Related layers
|
||||||
|
The following Spacemacs layers should also be added for a complete experience.
|
||||||
|
- auto-completion
|
||||||
|
- syntax-checking (provides flycheck for linter support)
|
||||||
|
|
||||||
|
*** Other optional features
|
||||||
|
- Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
|
||||||
|
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]] (beta)
|
||||||
|
|
||||||
|
*** References
|
||||||
|
- [[https://docs.cider.mx/cider/][CIDER documentation]]
|
||||||
|
- [[https://practicalli.github.io/spacemacs][Practicalli Spacemacs]]
|
||||||
|
|
||||||
* Install
|
* Install
|
||||||
** Layer
|
Spacemacs will prompt to install the Clojure layer automatically when opening a file ending in =.clj=
|
||||||
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
|
=.cljs=, =.cljc= or =.edn=. Replying ~y~ will download all the packages for the Clojure layer.
|
||||||
add =clojure= to the existing =dotspacemacs-configuration-layers= list in this
|
Restarting Spacemacs, ~SPC q r~, is recommended to ensure all changes are loaded.
|
||||||
file.
|
|
||||||
|
** Add the Clojure Layer manually
|
||||||
|
Edit the =~/.spacemacs= file and add the word =clojure= to the existing
|
||||||
|
=dotspacemacs-configuration-layers= list.
|
||||||
|
|
||||||
** Pretty Symbols
|
** Pretty Symbols
|
||||||
Pretty symbols for anonymous functions, set literals and partial, like =(λ [a]
|
Pretty symbols for anonymous functions, set literals and partial, like =(λ [a]
|
||||||
|
|
@ -85,33 +112,6 @@ Or set this variable when loading the configuration layer:
|
||||||
'((clojure :variables clojure-enable-fancify-symbols t)))
|
'((clojure :variables clojure-enable-fancify-symbols t)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
** Enabling sayid or clj-refactor
|
|
||||||
The packages sayid (Clojure debugger) and clj-refactor (automatic refactorings)
|
|
||||||
are disabled by default. 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:
|
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
|
||||||
;; before
|
|
||||||
dotspacemacs-configuration-layers
|
|
||||||
'(...
|
|
||||||
clojure
|
|
||||||
)
|
|
||||||
|
|
||||||
;; after
|
|
||||||
dotspacemacs-configuration-layers
|
|
||||||
'(...
|
|
||||||
(clojure :variables
|
|
||||||
clojure-enable-sayid t
|
|
||||||
clojure-enable-clj-refactor t)
|
|
||||||
)
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
Enabling either of these packages will cause extra nREPL middleware to be
|
|
||||||
injected when jacking in CIDER.
|
|
||||||
|
|
||||||
** Enabling Automatic Linting
|
** Enabling Automatic Linting
|
||||||
[[https://github.com/borkdude/clj-kondo][clj-kondo]], [[https://github.com/candid82/joker][joker]] and [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]] provide automated linting via =flycheck=.
|
[[https://github.com/borkdude/clj-kondo][clj-kondo]], [[https://github.com/candid82/joker][joker]] and [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]] provide automated linting via =flycheck=.
|
||||||
These packages are disabled by default as they require the relevant linter binaries
|
These packages are disabled by default as they require the relevant linter binaries
|
||||||
|
|
@ -224,11 +224,107 @@ Once all the linters you want to enable are installed, you simply need to specif
|
||||||
)
|
)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
** Starting Clojure manually (outside of Emacs)
|
*** Enable Clojure fancify Symbols
|
||||||
CIDER communicates with your Clojure process through nREPL, and for CIDER to
|
Fancify symbols re-writes your code and displays symbols for:
|
||||||
function correctly extra nREPL middleware needs to be present
|
- function definitions with fn =(λ [a] (+ a 5))= and its syntax shortcut =ƒ(+ % 5)=
|
||||||
(cider/cider-nrepl). The same is true for clj-refactor (refactor-nrepl), and for
|
- set literals =∈{2 4 6}=
|
||||||
sayid (com.billpiel/sayid).
|
- partial functions =Ƥ=.
|
||||||
|
|
||||||
|
To enable this feature, add the following snippet to the
|
||||||
|
=dotspacemacs/user-config= section of your =~/.spacemacs= file:
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(setq clojure-enable-fancify-symbols t)
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
Or set this variable when loading the configuration layer:
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(setq-default dotspacemacs-configuration-layers
|
||||||
|
'((clojure :variables clojure-enable-fancify-symbols t)))
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
*** Enabling sayid or clj-refactor
|
||||||
|
|
||||||
|
The packages sayid (Clojure debugger) and clj-refactor (automatic refactorings)
|
||||||
|
are disabled by default. These packages are less active that 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:
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
;; before
|
||||||
|
dotspacemacs-configuration-layers
|
||||||
|
'(...
|
||||||
|
clojure
|
||||||
|
)
|
||||||
|
|
||||||
|
;; after
|
||||||
|
dotspacemacs-configuration-layers
|
||||||
|
'(...
|
||||||
|
(clojure :variables
|
||||||
|
clojure-enable-sayid t
|
||||||
|
clojure-enable-clj-refactor t)
|
||||||
|
)
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
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 keybindings 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 [[https://clojurians.slack.com/messages/cider][#cider channel on Clojurians Slack community]] for help with CIDER,
|
||||||
|
and [[https://clojurians.slack.com/messages/spacemacs][#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 is needed (cider/cider-nrepl).
|
||||||
|
The same is true for clj-refactor (refactor-nrepl), and for sayid (com.billpiel/sayid).
|
||||||
|
|
||||||
When starting the Clojure process through cider (=cider-jack-in= and friends)
|
When starting the Clojure process through cider (=cider-jack-in= and friends)
|
||||||
this will be handled automatically, and so most users should be able to just run
|
this will be handled automatically, and so most users should be able to just run
|
||||||
|
|
@ -294,7 +390,16 @@ More info regarding installation of nREPL middleware can be found here:
|
||||||
- CIDER: [[https://cider.readthedocs.io/en/latest/installation/][CIDER installation (official docs)]]
|
- CIDER: [[https://cider.readthedocs.io/en/latest/installation/][CIDER installation (official docs)]]
|
||||||
- clj-refactor: [[https://github.com/clojure-emacs/refactor-nrepl][refactor-nrepl]]
|
- clj-refactor: [[https://github.com/clojure-emacs/refactor-nrepl][refactor-nrepl]]
|
||||||
|
|
||||||
* Usage
|
** Managing REPL connections
|
||||||
|
Sesman is used for [[https://docs.cider.mx/cider/usage/managing_connections.html][managing REPL connections]] when working simultaneously on
|
||||||
|
multiple projects or have multiple connections opened for the same project
|
||||||
|
|
||||||
|
~SPC m m i~ provides information about the current REPL.
|
||||||
|
~SPC m m b~ shows information about all REPLs currently active.
|
||||||
|
~SPC m m l~ menu links files, directories and projects to an existing session.
|
||||||
|
|
||||||
|
See REPL connections in the key bindings section for all the commands.
|
||||||
|
|
||||||
** Cheatsheet
|
** Cheatsheet
|
||||||
This layers installs the [[https://github.com/clojure-emacs/clojure-cheatsheet][clojure-cheatsheet]] package which embeds this useful
|
This layers installs the [[https://github.com/clojure-emacs/clojure-cheatsheet][clojure-cheatsheet]] package which embeds this useful
|
||||||
[[https://clojure.org/api/cheatsheet][cheatsheet]] into Emacs.
|
[[https://clojure.org/api/cheatsheet][cheatsheet]] into Emacs.
|
||||||
|
|
@ -304,26 +409,25 @@ separated) to narrow down the list. For example, try typing in sort map to see
|
||||||
some functions that deal with sorting maps.
|
some functions that deal with sorting maps.
|
||||||
|
|
||||||
** Structuraly safe editing
|
** Structuraly safe editing
|
||||||
This layer adds support for =evil-cleverparens= which allows to safely edit
|
The Clojure layer adds support for =evil-cleverparens= which allows to safely edit
|
||||||
lisp code by keeping the s-expressions balanced.
|
lisp code by keeping the s-expressions balanced.
|
||||||
|
|
||||||
By default this mode is not activated. You can turn it on locally on the active
|
~SPC m T s~ will toggle safe structured editing, off by default.
|
||||||
buffer with ~SPC m T s~ (=s= for safe).
|
|
||||||
|
|
||||||
To turn it on automatically for all =clojure= buffers call the following
|
Enable safe structural editing for all =clojure= buffers using the following
|
||||||
function in your =dotspacemacs/user-config= function:
|
in the =dotspacemacs/user-config= function of your .spacemacs file
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(spacemacs/toggle-evil-safe-lisp-structural-editing-on-register-hook-clojure-mode)
|
(spacemacs/toggle-evil-safe-lisp-structural-editing-on-register-hook-clojure-mode)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
or to enable it for all supported modes:
|
Or enable safe structural editing for all supported modes:
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(spacemacs/toggle-evil-safe-lisp-structural-editing-on-register-hooks)
|
(spacemacs/toggle-evil-safe-lisp-structural-editing-on-register-hooks)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
When enabled the symbol =🆂= should be displayed in the mode-line.
|
When enabled the symbol =🆂= will display in the mode-line.
|
||||||
|
|
||||||
* Key bindings
|
* Key bindings
|
||||||
** Working with clojure files (barfage, slurpage & more)
|
** Working with clojure files (barfage, slurpage & more)
|
||||||
|
|
@ -335,6 +439,32 @@ As this state works the same for all files, the documentation is in global
|
||||||
[[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state.
|
[[https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#lisp-key-bindings][DOCUMENTATION.org]]. In general, use ~SPC k~ to interact with the lisp-state.
|
||||||
|
|
||||||
** Leader
|
** Leader
|
||||||
|
*** Shortcuts
|
||||||
|
Shortcut keybindings for regularly used commands.
|
||||||
|
|
||||||
|
| Key binding | Description |
|
||||||
|
|-------------+----------------------------------------------------------|
|
||||||
|
| ~SPC m '~ | start a REPL - prompted for REPL type (sesman-start) |
|
||||||
|
| ~SPC m ,~ | command menu in REPL buffer (cider-repl-handle-shortcut) |
|
||||||
|
|
||||||
|
*** Managing REPL connections
|
||||||
|
Managing CIDER REPL connections and sessions
|
||||||
|
|
||||||
|
| Key binding | Description |
|
||||||
|
|---------------+------------------------------------------------------------------|
|
||||||
|
| ~SPC m m b~ | browse all REPL session (sesman-browser) |
|
||||||
|
| ~SPC m m i~ | current REPL information, ~SPC u~ for all sessions (sesman-info) |
|
||||||
|
| ~SPC m m g~ | go to most relevant REPL session (sesman-goto) |
|
||||||
|
| ~SPC m m l b~ | link buffer to REPL session (sesman-link-with-buffer) |
|
||||||
|
| ~SPC m m l d~ | link directory to REPL session (sesman-link-with-directory) |
|
||||||
|
| ~SPC m m l p~ | link project to REPL session (sesman-link-with-project) |
|
||||||
|
| ~SPC m m l u~ | unlink from REPL session (sesman-unlink) |
|
||||||
|
| ~SPC m m S j~ | connect as sibling to existing Clojure REPL |
|
||||||
|
| ~SPC m m S s~ | connect as sibling to existing ClojureScript REPL |
|
||||||
|
| ~SPC m m s~ | start a REPL - prompted for REPL type (sesman-start) |
|
||||||
|
| ~SPC m m q q~ | quit REPL session (sesman-quit) |
|
||||||
|
| ~SPC m m q r~ | restart REPL (sesman-restart) |
|
||||||
|
|
||||||
*** Documentation
|
*** Documentation
|
||||||
|
|
||||||
| Key binding | Description |
|
| Key binding | Description |
|
||||||
|
|
@ -348,22 +478,25 @@ As this state works the same for all files, the documentation is in global
|
||||||
| ~SPC m h N~ | cider browse all namespaces |
|
| ~SPC m h N~ | cider browse all namespaces |
|
||||||
|
|
||||||
*** Evaluation
|
*** Evaluation
|
||||||
|
Evaluate Clojure code in the source code buffer
|
||||||
|
|
||||||
| Key binding | Description |
|
| Key binding | Description |
|
||||||
|-------------+-----------------------------------------------------------|
|
|-------------+--------------------------------------------------------------------|
|
||||||
| ~SPC m e ;~ | eval sexp and show result as comment |
|
| ~SPC m e ;~ | eval sexp and show result as comment |
|
||||||
| ~SPC m e b~ | eval buffer |
|
| ~SPC m e b~ | eval buffer |
|
||||||
| ~SPC m e e~ | eval last sexp |
|
| ~SPC m e e~ | eval last sexp |
|
||||||
| ~SPC m e f~ | eval function at point |
|
| ~SPC m e f~ | eval function at point |
|
||||||
| ~SPC m e i~ | interrupt the current evaluation |
|
| ~SPC m e i~ | interrupt the current evaluation |
|
||||||
| ~SPC m e r~ | eval region |
|
| ~SPC m e m~ | cider macroexpand 1 |
|
||||||
| ~SPC m e m~ | cider macroexpand 1 |
|
| ~SPC m e M~ | cider macroexpand all |
|
||||||
| ~SPC m e M~ | cider macroexpand all |
|
| ~SPC m e n~ | refresh namespace (cider-ns-refresh) |
|
||||||
| ~SPC m e p~ | print last sexp (clojure interaction mode only) |
|
| ~SPC m e N~ | reload namespace (cider-ns-reload), ~SPC u~ (cider-ns-reload-all) |
|
||||||
| ~SPC m e P~ | eval last sexp and pretty print result in separate buffer |
|
| ~SPC m e p~ | eval top-level sexp, pretty print result in separate buffer |
|
||||||
| ~SPC m e u~ | Undefine a symbol from the current namespace |
|
| ~SPC m e P~ | eval last sexp, pretty print result in separate buffer |
|
||||||
| ~SPC m e v~ | eval sexp around point |
|
| ~SPC m e r~ | eval region |
|
||||||
| ~SPC m e w~ | eval last sexp and replace with result |
|
| ~SPC m e u~ | Undefine a symbol from the current namespace |
|
||||||
|
| ~SPC m e v~ | eval sexp around point |
|
||||||
|
| ~SPC m e w~ | eval last sexp and replace with result |
|
||||||
|
|
||||||
*** Goto
|
*** Goto
|
||||||
|
|
||||||
|
|
@ -378,32 +511,39 @@ As this state works the same for all files, the documentation is in global
|
||||||
| ~SPC m g s~ | browse spec |
|
| ~SPC m g s~ | browse spec |
|
||||||
| ~SPC m g S~ | browse all specs |
|
| ~SPC m g S~ | browse all specs |
|
||||||
|
|
||||||
*** REPL
|
*** Send code to REPL
|
||||||
|
Use these keybindings when working directly with a REPL buffer.
|
||||||
|
Use the Evaluation keybindings when evaluating in source code buffer.
|
||||||
|
|
||||||
| Key binding | Description |
|
| Key binding | Description |
|
||||||
|---------------+--------------------------------------------------------------------------------|
|
|---------------+----------------------------------------------------------------------------|
|
||||||
| ~SPC m ,~ | handle shortcut (cider-repl-handle-shortcut) |
|
| ~SPC m s a~ | switch between REPL and last Clojure source code buffer (cider-repl) |
|
||||||
| ~SPC m s b~ | send and eval buffer in REPL |
|
| ~SPC m s b~ | send and eval buffer in REPL |
|
||||||
| ~SPC m s B~ | send and eval buffer and switch to REPL in =insert state= |
|
| ~SPC m s B~ | send and eval buffer and switch to REPL in =insert state= |
|
||||||
| ~SPC m s c~ | connect to REPL (cider-connect) or clear repl buffer (cider-repl-clear-buffer) |
|
| ~SPC m s c j~ | connect to a running Clojure REPL (cider-connect-clj) |
|
||||||
| ~SPC m s C~ | clear REPL (cider-find-and-clear-repl-output) |
|
| ~SPC m s c m~ | connect to a running Clojure & ClojureScript REPL (cider-connect-clj&cljs) |
|
||||||
| ~SPC m s e~ | send and eval last sexp in REPL |
|
| ~SPC m s c s~ | connect to a running ClojureScript REPL (cider-connect-cljs) |
|
||||||
| ~SPC m s E~ | send and eval last sexp and switch to REPL in =insert state= |
|
| ~SPC m s e~ | send and eval last sexp in REPL |
|
||||||
| ~SPC m s f~ | send and eval function in REPL |
|
| ~SPC m s E~ | send and eval last sexp and switch to REPL in =insert state= |
|
||||||
| ~SPC m s F~ | send and eval function and switch to REPL in =insert state= |
|
| ~SPC m s f~ | send and eval function in REPL |
|
||||||
| ~SPC m s j c~ | start Clojure REPL (=cider-jack-in-clj=) |
|
| ~SPC m s F~ | send and eval function and switch to REPL in =insert state= |
|
||||||
| ~SPC m s j f~ | start Clojure REPL (=cider-jack-in-clj&cljs=) |
|
| ~SPC m s i~ | start a REPL - prompt for REPL type (sesman-start) |
|
||||||
| ~SPC m s j s~ | start ClojureScript REPL (=cider-jack-in-cljs=) |
|
| ~SPC m s j j~ | start Clojure REPL (=cider-jack-in-clj=) |
|
||||||
| ~SPC m s n~ | send and eval ns form in REPL |
|
| ~SPC m s j m~ | start Clojure REPL (=cider-jack-in-clj&cljs=) |
|
||||||
| ~SPC m s N~ | send and eval ns form and switch to REPL in =insert state= |
|
| ~SPC m s j s~ | start ClojureScript REPL (=cider-jack-in-cljs=) |
|
||||||
| ~SPC m s q~ | kill REPL (cider-quit) |
|
| ~SPC m l~ | clear REPL buffer (cider-repl-clear-buffer) |
|
||||||
| ~SPC m s o~ | switch to other repl instance (cider-repl-switch-to-other) |
|
| ~SPC m L~ | clear and switch to REPL buffer (cider-find-and-clear-repl-output) |
|
||||||
| ~SPC m s r~ | send and eval region in REPL |
|
| ~SPC m s n~ | send and eval ns form in REPL |
|
||||||
| ~SPC m s R~ | send and eval region and switch to REPL in =insert state= |
|
| ~SPC m s N~ | send and eval ns form and switch to REPL in =insert state= |
|
||||||
| ~SPC m s s~ | switch to REPL or jump to last file or last clj buffer from repl (cider-repl) |
|
| ~SPC m s o~ | switch to other repl instance (cider-repl-switch-to-other) |
|
||||||
| ~SPC m s u~ | require Clojure utils into current namespace - i.e. functions =doc= =source= |
|
| ~SPC m s q n~ | reload namespace in REPL (cider-ns-reload) |
|
||||||
| ~SPC m s x~ | refresh REPL |
|
| ~SPC m s q N~ | reload all namespace in REPL (cider-ns-reload-all) |
|
||||||
| ~SPC m s X~ | restart REPL |
|
| ~SPC m s q q~ | quit REPL (cider-quit) |
|
||||||
|
| ~SPC m s q r~ | restart REPL (cider-restart) |
|
||||||
|
| ~SPC m s r~ | send and eval region in REPL |
|
||||||
|
| ~SPC m s R~ | send and eval region and switch to REPL in =insert state= |
|
||||||
|
| ~SPC m e u~ | require Clojure utils into current namespace - i.e. =doc= =source= |
|
||||||
|
| ~SPC m s p~ | print last sexp (clojure interaction mode only) |
|
||||||
|
|
||||||
*** Tests
|
*** Tests
|
||||||
|
|
||||||
|
|
@ -424,6 +564,7 @@ As this state works the same for all files, the documentation is in global
|
||||||
| ~SPC m T t~ | toggle auto test mode |
|
| ~SPC m T t~ | toggle auto test mode |
|
||||||
|
|
||||||
*** Debugging
|
*** Debugging
|
||||||
|
TODO: separate clojure-mode and sayid keybindings
|
||||||
|
|
||||||
| Key binding | Description |
|
| Key binding | Description |
|
||||||
|---------------+----------------------------------------------------|
|
|---------------+----------------------------------------------------|
|
||||||
|
|
@ -513,11 +654,15 @@ The following refactorings require cljr-refactor to be enabled and generally dep
|
||||||
|
|
||||||
*** Reformatting
|
*** Reformatting
|
||||||
|
|
||||||
| Key binding | Description |
|
| Key binding | Description |
|
||||||
|--------------------------+-------------------------|
|
|---------------+-------------------------|
|
||||||
| ~SPC m f b~ or ~SPC m =~ | reformat current buffer |
|
| ~SPC m = =~ | reformat current buffer |
|
||||||
| ~SPC m f l~ | realign current form |
|
| ~SPC m = e b~ | reformat edn buffer |
|
||||||
| | |
|
| ~SPC m = e e~ | reformat edn last sexp |
|
||||||
|
| ~SPC m = e r~ | reformat edn region |
|
||||||
|
| ~SPC m = f~ | reformat current sexp |
|
||||||
|
| ~SPC m = l~ | realign current form |
|
||||||
|
| ~SPC m = r~ | realign current region |
|
||||||
|
|
||||||
*** Profiling
|
*** Profiling
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -63,14 +63,21 @@
|
||||||
;; TODO: having this work for cider-macroexpansion-mode would be nice,
|
;; TODO: having this work for cider-macroexpansion-mode would be nice,
|
||||||
;; but the problem is that it uses clojure-mode as its major-mode
|
;; but the problem is that it uses clojure-mode as its major-mode
|
||||||
(let ((cider--key-binding-prefixes
|
(let ((cider--key-binding-prefixes
|
||||||
'(("md" . "debug")
|
'(("m=" . "format")
|
||||||
|
("m=e" . "edn")
|
||||||
|
("md" . "debug")
|
||||||
("me" . "evaluation")
|
("me" . "evaluation")
|
||||||
("mf" . "format")
|
|
||||||
("mg" . "goto")
|
("mg" . "goto")
|
||||||
("mh" . "documentation")
|
("mh" . "documentation")
|
||||||
|
("mm" . "manage repls")
|
||||||
|
("mml" . "link session")
|
||||||
|
("mmS" . "sibling sessions")
|
||||||
|
("mmq" . "quit/restart")
|
||||||
("mp" . "profile")
|
("mp" . "profile")
|
||||||
("ms" . "repl")
|
("ms" . "send to repl")
|
||||||
|
("msc" . "connect external repl")
|
||||||
("msj" . "jack-in")
|
("msj" . "jack-in")
|
||||||
|
("msq" . "quit/restart repl")
|
||||||
("mt" . "test")
|
("mt" . "test")
|
||||||
("mT" . "toggle")
|
("mT" . "toggle")
|
||||||
)))
|
)))
|
||||||
|
|
@ -80,6 +87,11 @@
|
||||||
cider--key-binding-prefixes)
|
cider--key-binding-prefixes)
|
||||||
|
|
||||||
(spacemacs/set-leader-keys-for-major-mode m
|
(spacemacs/set-leader-keys-for-major-mode m
|
||||||
|
|
||||||
|
;; shortcuts
|
||||||
|
"'" 'sesman-start
|
||||||
|
|
||||||
|
;; help / documentation
|
||||||
"ha" 'cider-apropos
|
"ha" 'cider-apropos
|
||||||
"hc" 'cider-cheatsheet
|
"hc" 'cider-cheatsheet
|
||||||
"hd" 'cider-clojuredocs
|
"hd" 'cider-clojuredocs
|
||||||
|
|
@ -88,6 +100,7 @@
|
||||||
"hn" 'cider-browse-ns
|
"hn" 'cider-browse-ns
|
||||||
"hN" 'cider-browse-ns-all
|
"hN" 'cider-browse-ns-all
|
||||||
|
|
||||||
|
;; evaluate in source code buffer
|
||||||
"e;" 'cider-eval-defun-to-comment
|
"e;" 'cider-eval-defun-to-comment
|
||||||
"eb" 'cider-eval-buffer
|
"eb" 'cider-eval-buffer
|
||||||
"ee" 'cider-eval-last-sexp
|
"ee" 'cider-eval-last-sexp
|
||||||
|
|
@ -95,15 +108,25 @@
|
||||||
"ei" 'cider-interrupt
|
"ei" 'cider-interrupt
|
||||||
"em" 'cider-macroexpand-1
|
"em" 'cider-macroexpand-1
|
||||||
"eM" 'cider-macroexpand-all
|
"eM" 'cider-macroexpand-all
|
||||||
|
"en" 'cider-ns-refresh
|
||||||
|
"eN" 'cider-ns-reload ;; SPC u for cider-ns-reload-all
|
||||||
|
"ep" 'cider-pprint-eval-defun-at-point
|
||||||
"eP" 'cider-pprint-eval-last-sexp
|
"eP" 'cider-pprint-eval-last-sexp
|
||||||
"er" 'cider-eval-region
|
"er" 'cider-eval-region
|
||||||
"eu" 'cider-undef
|
"eu" 'cider-undef
|
||||||
"ev" 'cider-eval-sexp-at-point
|
"ev" 'cider-eval-sexp-at-point
|
||||||
|
"eV" 'cider-eval-sexp-up-to-point
|
||||||
"ew" 'cider-eval-last-sexp-and-replace
|
"ew" 'cider-eval-last-sexp-and-replace
|
||||||
|
|
||||||
"=" 'cider-format-buffer
|
;; format code style
|
||||||
"fb" 'cider-format-buffer
|
"==" 'cider-format-buffer
|
||||||
|
"=eb" 'cider-format-edn-buffer
|
||||||
|
"=ee" 'cider-format-edn-last-sexp
|
||||||
|
"=er" 'cider-format-edn-region
|
||||||
|
"=f" 'cider-format-defun
|
||||||
|
"=r" 'cider-format-region
|
||||||
|
|
||||||
|
;; goto
|
||||||
"gb" 'cider-pop-back
|
"gb" 'cider-pop-back
|
||||||
"gc" 'cider-classpath
|
"gc" 'cider-classpath
|
||||||
"gg" 'spacemacs/clj-find-var
|
"gg" 'spacemacs/clj-find-var
|
||||||
|
|
@ -113,41 +136,57 @@
|
||||||
"gs" 'cider-browse-spec
|
"gs" 'cider-browse-spec
|
||||||
"gS" 'cider-browse-spec-all
|
"gS" 'cider-browse-spec-all
|
||||||
|
|
||||||
"'" 'cider-jack-in-clj
|
;; manage cider connections / sesman
|
||||||
"\"" 'cider-jack-in-cljs
|
"mb" 'sesman-browser
|
||||||
"\&" 'cider-jack-in-clj&cljs
|
"mi" 'sesman-info
|
||||||
|
"mg" 'sesman-goto
|
||||||
|
"mlb" 'sesman-link-with-buffer
|
||||||
|
"mld" 'sesman-link-with-directory
|
||||||
|
"mlu" 'sesman-unlink
|
||||||
|
"mqq" 'sesman-quit
|
||||||
|
"mqr" 'sesman-restart
|
||||||
|
"mlp" 'sesman-link-with-project
|
||||||
|
"mSj" 'cider-connect-sibling-clj
|
||||||
|
"mSs" 'cider-connect-sibling-cljs
|
||||||
|
"ms" 'sesman-start
|
||||||
|
|
||||||
|
;; send code - spacemacs convention
|
||||||
|
"sa" (if (eq m 'cider-repl-mode)
|
||||||
|
'cider-switch-to-last-clojure-buffer
|
||||||
|
'cider-switch-to-repl-buffer)
|
||||||
"sb" 'cider-load-buffer
|
"sb" 'cider-load-buffer
|
||||||
"sB" 'spacemacs/cider-send-buffer-in-repl-and-focus
|
"sB" 'spacemacs/cider-send-buffer-in-repl-and-focus
|
||||||
"sc" (if (eq m 'cider-repl-mode)
|
"scj" 'cider-connect-clj
|
||||||
'cider-repl-clear-buffer
|
"scm" 'cider-connect-clj&cljs
|
||||||
'cider-connect)
|
"scs" 'cider-connect-cljs
|
||||||
"sC" 'cider-find-and-clear-repl-output
|
|
||||||
"se" 'spacemacs/cider-send-last-sexp-to-repl
|
"se" 'spacemacs/cider-send-last-sexp-to-repl
|
||||||
"sE" 'spacemacs/cider-send-last-sexp-to-repl-focus
|
"sE" 'spacemacs/cider-send-last-sexp-to-repl-focus
|
||||||
"sf" 'spacemacs/cider-send-function-to-repl
|
"sf" 'spacemacs/cider-send-function-to-repl
|
||||||
"sF" 'spacemacs/cider-send-function-to-repl-focus
|
"sF" 'spacemacs/cider-send-function-to-repl-focus
|
||||||
"si" 'cider-jack-in-clj
|
"si" 'sesman-start
|
||||||
"sjc" 'cider-jack-in-clj
|
"sjj" 'cider-jack-in-clj
|
||||||
"sjf" 'cider-jack-in-clj&cljs
|
"sjm" 'cider-jack-in-clj&cljs
|
||||||
"sjs" 'cider-jack-in-cljs
|
"sjs" 'cider-jack-in-cljs
|
||||||
|
"sl" 'cider-repl-clear-buffer
|
||||||
|
"sL" 'cider-find-and-clear-repl-output
|
||||||
"sn" 'spacemacs/cider-send-ns-form-to-repl
|
"sn" 'spacemacs/cider-send-ns-form-to-repl
|
||||||
"sN" 'spacemacs/cider-send-ns-form-to-repl-focus
|
"sN" 'spacemacs/cider-send-ns-form-to-repl-focus
|
||||||
"so" 'cider-repl-switch-to-other
|
"so" 'cider-repl-switch-to-other
|
||||||
"sq" 'cider-quit
|
"sqq" 'cider-quit
|
||||||
|
"sqr" 'cider-restart
|
||||||
|
"sqn" 'cider-ns-reload
|
||||||
|
"sqN" 'cider-ns-reload-all
|
||||||
"sr" 'spacemacs/cider-send-region-to-repl
|
"sr" 'spacemacs/cider-send-region-to-repl
|
||||||
"sR" 'spacemacs/cider-send-region-to-repl-focus
|
"sR" 'spacemacs/cider-send-region-to-repl-focus
|
||||||
"ss" (if (eq m 'cider-repl-mode)
|
|
||||||
'cider-switch-to-last-clojure-buffer
|
|
||||||
'cider-switch-to-repl-buffer)
|
|
||||||
"su" 'cider-repl-require-repl-utils
|
"su" 'cider-repl-require-repl-utils
|
||||||
"sx" 'cider-ns-refresh
|
|
||||||
"sX" 'cider-restart
|
|
||||||
|
|
||||||
|
;; toggle options
|
||||||
"Te" 'cider-enlighten-mode
|
"Te" 'cider-enlighten-mode
|
||||||
"Tf" 'spacemacs/cider-toggle-repl-font-locking
|
"Tf" 'spacemacs/cider-toggle-repl-font-locking
|
||||||
"Tp" 'spacemacs/cider-toggle-repl-pretty-printing
|
"Tp" 'spacemacs/cider-toggle-repl-pretty-printing
|
||||||
"Tt" 'cider-auto-test-mode
|
"Tt" 'cider-auto-test-mode
|
||||||
|
|
||||||
|
;; cider-tests
|
||||||
"ta" 'spacemacs/cider-test-run-all-tests
|
"ta" 'spacemacs/cider-test-run-all-tests
|
||||||
"tb" 'cider-test-show-report
|
"tb" 'cider-test-show-report
|
||||||
"tl" 'spacemacs/cider-test-run-loaded-tests
|
"tl" 'spacemacs/cider-test-run-loaded-tests
|
||||||
|
|
@ -156,6 +195,7 @@
|
||||||
"tr" 'spacemacs/cider-test-rerun-failed-tests
|
"tr" 'spacemacs/cider-test-rerun-failed-tests
|
||||||
"tt" 'spacemacs/cider-test-run-focused-test
|
"tt" 'spacemacs/cider-test-run-focused-test
|
||||||
|
|
||||||
|
;; cider-debug
|
||||||
"db" 'cider-debug-defun-at-point
|
"db" 'cider-debug-defun-at-point
|
||||||
"de" 'spacemacs/cider-display-error-buffer
|
"de" 'spacemacs/cider-display-error-buffer
|
||||||
"dv" 'cider-inspect
|
"dv" 'cider-inspect
|
||||||
|
|
@ -303,7 +343,7 @@
|
||||||
m (car x) (cdr x)))
|
m (car x) (cdr x)))
|
||||||
clj-refactor--key-binding-prefixes)
|
clj-refactor--key-binding-prefixes)
|
||||||
(spacemacs/set-leader-keys-for-major-mode m
|
(spacemacs/set-leader-keys-for-major-mode m
|
||||||
"fl" 'clojure-align
|
"=l" 'clojure-align
|
||||||
"rci" 'clojure-cycle-if
|
"rci" 'clojure-cycle-if
|
||||||
"rcp" 'clojure-cycle-privacy
|
"rcp" 'clojure-cycle-privacy
|
||||||
"rc#" 'clojure-convert-collection-to-set
|
"rc#" 'clojure-convert-collection-to-set
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue