TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Revert "[clojure] Add sesman keybindings" 

This breaks Spacemacs convention:
https://github.com/syl20bnr/spacemacs/blob/develop/doc/CONVENTIONS.org#repls

Need to add session management under an unused prefix, I suggest SPC m S

This reverts commit e47494229b.
This commit is contained in:
syl20bnr 2020-01-25 10:17:08 -05:00
parent 96e7621f8a
commit 52d1b0f323
6 changed files with 160 additions and 323 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
CHANGELOG.develop
View File

@ -1462,56 +1462,6 @@ 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)
- Moved evaluation sent to repl keybindings to ~SPC m e s~ menu
~esb~ 'spacemacs/cider-send-buffer-in-repl-and-focus
~esc~ 'cider-repl-clear-buffer
~esC~ 'cider-find-and-clear-repl-output
~ese~ 'spacemacs/cider-send-last-sexp-to-repl
~esE~ 'spacemacs/cider-send-last-sexp-to-repl-focus
~esf~ 'spacemacs/cider-send-function-to-repl
~esF~ 'spacemacs/cider-send-function-to-repl-focus
~esn~ 'spacemacs/cider-send-ns-form-to-repl
~esN~ 'spacemacs/cider-send-ns-form-to-repl-focus
~eso~ 'cider-repl-switch-to-other
~esr~ 'spacemacs/cider-send-region-to-repl
~esR~ 'spacemacs/cider-send-region-to-repl-focus
- ~eU~ 'cider-repl-require-repl-utils
(thanks to John Stevenson)
- changed clear repl buffer of evaluation to match terminal clear key
~el~ 'cider-repl-clear-buffer
~eL~ 'cider-find-and-clear-repl-output
(thanks to John Stevenson)
- Add sesman session management keybindings and refactor
jack-in and connect keybindings
~'~ 'sesman-start
~sb~ 'sesman-browser
~scj~ 'cider-connect-clj ;; Java
~scm~ 'cider-connect-clj&cljs ;; Multiple repl
~scs~ 'cider-connect-cljs ;; javaScript
~si~ 'sesman-start ;; convention to use ~i~ to start repl in many Spacemacs
layers
~sI~ 'sesman-info
~sjj~ 'cider-jack-in-clj ;; Java
~sjm~ 'cider-jack-in-clj&cljs ;; Multiple repl - match cider keybinding
~sjs~ 'cider-jack-in-cljs ;; javaScript
~slb~ 'sesman-link-with-buffer
~sld~ 'sesman-link-with-directory
~slp~ 'sesman-link-with-project
~slu~ 'sesman-unlink
~ssj~ 'cider-connect-sibling-clj ;; sibling Java
~sss~ 'cider-connect-sibling-cljs ;; sibling javaScript
~sr~ 'cider-restart
~sR~ 'sesman-restart
~sq~ 'cider-quit
~sQ~ 'sesman-quit
~sx~ 'cider-ns-refresh
(thanks to John Stevenson)
- changed toggle between source and repl to match key for toggle between code
and test
~sa~ (if (eq m 'cider-repl-mode)
'cider-switch-to-last-clojure-buffer
'cider-switch-to-repl-buffer)
(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

339
layers/+lang/clojure/README.org
View File

@ -7,26 +7,20 @@
* Table of Contents :TOC_5_gh:noexport: * Table of Contents :TOC_5_gh:noexport:
- [[#description][Description]] - [[#description][Description]]
- [[#features][Features:]] - [[#features][Features:]]
- [[#recommended-optional-features][Recommended optional features]]
- [[#other-optional-features][Other optional features]]
- [[#install][Install]] - [[#install][Install]]
- [[#add-the-clojure-layer][Add the Clojure Layer]] - [[#layer][Layer]]
- [[#optional-features][Optional features]] - [[#pretty-symbols][Pretty Symbols]]
- [[#enabling-automatic-linting][Enabling Automatic Linting]] - [[#enabling-sayid-or-clj-refactor][Enabling sayid or clj-refactor]]
- [[#enable-clj-kondo-linter][Enable clj-kondo linter]] - [[#enabling-automatic-linting][Enabling Automatic Linting]]
- [[#enable-joker-linter][Enable joker linter]] - [[#enable-clj-kondo-linter][Enable clj-kondo linter]]
- [[#enable-squiggly-linter][Enable Squiggly linter]] - [[#enable-joker-linter][Enable joker linter]]
- [[#enable-multiple-linters][Enable multiple linters]] - [[#enable-squiggly-linter][Enable Squiggly linter]]
- [[#enable-clojure-fancify-symbols][Enable Clojure fancify Symbols]] - [[#enable-multiple-linters][Enable multiple linters]]
- [[#enabling-sayid-or-clj-refactor][Enabling sayid or clj-refactor]] - [[#starting-clojure-manually-outside-of-emacs][Starting Clojure manually (outside of Emacs)]]
- [[#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]]
- [[#managing-repl-connections][Managing REPL connections]] - [[#usage][Usage]]
- [[#cheatsheet][Cheatsheet]] - [[#cheatsheet][Cheatsheet]]
- [[#structuraly-safe-editing][Structuraly safe editing]] - [[#structuraly-safe-editing][Structuraly safe editing]]
- [[#key-bindings][Key bindings]] - [[#key-bindings][Key bindings]]
@ -35,7 +29,7 @@
- [[#documentation][Documentation]] - [[#documentation][Documentation]]
- [[#evaluation][Evaluation]] - [[#evaluation][Evaluation]]
- [[#goto][Goto]] - [[#goto][Goto]]
- [[#repl-sessions][REPL Sessions]] - [[#repl][REPL]]
- [[#tests][Tests]] - [[#tests][Tests]]
- [[#toggles][Toggles]] - [[#toggles][Toggles]]
- [[#debugging][Debugging]] - [[#debugging][Debugging]]
@ -59,51 +53,78 @@ This layer adds support for [[https://clojure.org/][Clojure]] language using [[h
** Features: ** Features:
- REPL via [[https://github.com/clojure-emacs/cider][CIDER]] - REPL via [[https://github.com/clojure-emacs/cider][CIDER]]
- REPL session management via Sesman
- Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]] - Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]]
- Aligning of code forms via [[https://github.com/clojure-emacs/clojure-mode][clojure-mode]]
- Debugging with CIDER debug
- Clojure cheatsheet
*** Recommended optional features
- 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)
*** Other optional features
- Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]] - Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]] (beta) - Linting via [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]], [[https://github.com/borkdude/clj-kondo][clj-kondo]] or [[https://github.com/candid82/joker][joker]]
- Aligning of code forms via [[https://github.com/clojure-emacs/clojure-mode][clojure-mode]]
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]]
- Clojure cheatsheet
- Structuraly safe editing using optional [[https://github.com/luxbock/evil-cleverparens][evil-cleverparens]]
* Install * Install
** Add the Clojure Layer ** Layer
Edit the =~/.spacemacs= file and add the word =clojure= to the existing To use this configuration layer, add it to your =~/.spacemacs=. You will need to
=dotspacemacs-configuration-layers= list. add =clojure= to the existing =dotspacemacs-configuration-layers= list in this
file.
Reload the Spacemacs configuration, ~SPC f e R~ or restart Spacemacs ~SPC q r~. ** Pretty Symbols
Pretty symbols for anonymous functions, set literals and partial, like =(λ [a]
(+ a 5))=, =ƒ(+ % 5)=, =∈{2 4 6}= and =Ƥ=.
The latest snapshot packages from the CIDER orchard will automatically download. To enable this feature, add the following snippet to the
=dotspacemacs/user-config= section of your =~/.spacemacs= file:
** Optional features #+BEGIN_SRC emacs-lisp
There are several optional features available for the Clojure layer. (setq clojure-enable-fancify-symbols t)
#+END_SRC
[[https://github.com/borkdude/clj-kondo][clj-kondo]] and automatic linting is recommended, as this provides immediate feedback on the Or set this variable when loading the configuration layer:
correctness of your code as you write it.
Fancify symbols replaces fn, #{} and partial with representative characters =λ= =ƒ= and =Ƥ= #+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers
'((clojure :variables clojure-enable-fancify-symbols t)))
#+END_SRC
clj-refactor provides Clojure specific refactor commands. The refactor commands are being ** Enabling sayid or clj-refactor
migrated into CIDER clojure-mode. clj-refactor is not actively maintained, so use with caution. 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.
sayid is a comprehensive debugger that analyses an entire project. Projects need to compile In your Spacemacs configuration:
fully or issues may occur. sayid is not as actively maintained as CIDER and may cause issues.
*** Enabling Automatic Linting #+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
[[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
to be installed locally. to be installed locally.
[[https://github.com/borkdude/clj-kondo][clj-kondo]] is the recommended linter, as it is the most actively developed. The recommended linter is to use [[https://github.com/borkdude/clj-kondo][clj-kondo]] in combination with [[https://github.com/candid82/joker][joker]]. Together they catch the most issues while both running extremely quickly.
**** Enable clj-kondo linter squiggly reloads your code on every change which gives unexpected results if
your code is not re-loadable. squiggly also requires =org.clojure/core.typed= be
added to the development dependencies of your projects or build tool when using
=cider-connect=.
*** Enable clj-kondo linter
This linter based on static syntax checking and requires the [[https://github.com/borkdude/clj-kondo][clj-kondo]] binary This linter based on static syntax checking and requires the [[https://github.com/borkdude/clj-kondo][clj-kondo]] binary
installed on the system PATH that =spacemacs.env= includes. Please read the installed on the system PATH that =spacemacs.env= includes. Please read the
[[https://github.com/borkdude/clj-kondo/blob/master/doc/install.md][clj-kondo binary installation instructions]] [[https://github.com/borkdude/clj-kondo/blob/master/doc/install.md][clj-kondo binary installation instructions]]
@ -127,7 +148,7 @@ to your Spacemacs configuration:
) )
#+END_SRC #+END_SRC
**** Enable joker linter *** Enable joker linter
This linter is based on static syntax checking and requires the [[https://github.com/candid82/joker][joker]] binary This linter is based on static syntax checking and requires the [[https://github.com/candid82/joker][joker]] binary
installed on the system PATH that =spacemacs.env= includes. Please read the installed on the system PATH that =spacemacs.env= includes. Please read the
[[https://github.com/candid82/joker#installation][joker binary installation instructions]] [[https://github.com/candid82/joker#installation][joker binary installation instructions]]
@ -151,12 +172,11 @@ to your Spacemacs configuration:
) )
#+END_SRC #+END_SRC
**** Enable Squiggly linter *** Enable Squiggly linter
[[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]] uses [[https://github.com/jonase/eastwood][Eastwood]] and [[https://github.com/jonase/kibit][Kibit]] for linting. Please install these projects [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]] uses [[https://github.com/jonase/eastwood][Eastwood]] and [[https://github.com/jonase/kibit][Kibit]] for linting. Please install these projects
before configuring Spacemacs with =squiggly=. before configuring Spacemacs with =squiggly=.
Make sure to read the [[https://github.com/clojure-emacs/squiggly-clojure#warnings][squiggly-clojure warnings section]] as squiggly reloads Make sure to read the [[https://github.com/clojure-emacs/squiggly-clojure#warnings][squiggly-clojure warnings section]].
all code on every change, often giving unexpected results.
Please read the section on [[https://github.com/clojure-emacs/squiggly-clojure#dependencies-in-clojure][squiggly dependencies]] if you are using =cider-connect= Please read the section on [[https://github.com/clojure-emacs/squiggly-clojure#dependencies-in-clojure][squiggly dependencies]] if you are using =cider-connect=
@ -181,15 +201,12 @@ Enable the squiggly (eastwood, kibit and core.typed) automatic linter in Spacema
Troubleshooting: please read [[https://github.com/clojure-emacs/squiggly-clojure#debugging-and-bug-reporting][debugging and bug reporting]] and try to reproduce using the [[https://github.com/clojure-emacs/squiggly-clojure/tree/master/sample-project][sample project]]. Troubleshooting: please read [[https://github.com/clojure-emacs/squiggly-clojure#debugging-and-bug-reporting][debugging and bug reporting]] and try to reproduce using the [[https://github.com/clojure-emacs/squiggly-clojure/tree/master/sample-project][sample project]].
**** Enable multiple linters *** Enable multiple linters
Multiple linters can all run together, potentially giving greater coverage. You can choose to enable multiple linters and have them all run together. This gives you better linting coverage, as they don't catch all the same issues.
However, you also increase the number of false positives you have to resolve.
Follow the install instructions for each linter first, ensuring the binaries You will need to follow their individual install instructions first, to get all their necessary binaries and configs on the system PATH that =spacemacs.env= includes. Please refer to their individual Enable ... linter section respectively.
are available on the system PATH that =spacemacs.env= includes.
Then add each linter name to the ~clojure-enable-linters~ =:variables= option Once all the linters you want to enable are installed, you simply need to specify a list of them in the =:variables= option to your Spacemacs configuration:
in your Spacemacs configuration:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
;; Witout any variables your configuration would just include clojure ;; Witout any variables your configuration would just include clojure
@ -207,108 +224,21 @@ in your Spacemacs configuration:
) )
#+END_SRC #+END_SRC
*** Enable Clojure fancify Symbols ** Starting Clojure manually (outside of Emacs)
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:
#+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 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:
#+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 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 [[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 CIDER communicates with your Clojure process through nREPL, and for CIDER to
function correctly extra nREPL middleware needs to be present function correctly extra nREPL middleware needs to be present
(cider/cider-nrepl). The same is true for clj-refactor (refactor-nrepl), and for (cider/cider-nrepl). The same is true for clj-refactor (refactor-nrepl), and for
sayid (com.billpiel/sayid). sayid (com.billpiel/sayid).
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
~SPC m s i~ to connect to the CIDER REPL and skip the rest of this section.
If you are running an older version of CIDER (0.10 or older), or if you are
starting the Clojure process yourself outside of Emacs, then you need to make
sure the necessary dependencies are present, and the necessary nREPL middlewares
are enabled.
*** Quick Start with boot *** Quick Start with boot
- Install =boot= 2.8.2 or newer (see [[https://github.com/boot-clj/boot#user-content-install]]) - 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: - Create a file =~/.boot/profile.boot= with the following content:
@ -364,14 +294,7 @@ 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]]
** Managing REPL connections * Usage
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
Files, directories and projects can be linked to an existing session.
See the REPL connections 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.
@ -426,33 +349,21 @@ As this state works the same for all files, the documentation is in global
*** Evaluation *** Evaluation
| 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~ | send and eval buffer and switch to REPL in =insert state= | | ~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 l~ | clear REPL buffer (cider-repl-clear-buffer) | | ~SPC m e m~ | cider macroexpand 1 |
| ~SPC m e L~ | clear REPL buffer (cider-find-and-clear-repl-output) | | ~SPC m e M~ | cider macroexpand all |
| ~SPC m e m~ | cider macroexpand 1 | | ~SPC m e p~ | print last sexp (clojure interaction mode only) |
| ~SPC m e M~ | cider macroexpand all | | ~SPC m e P~ | eval last sexp and pretty print result in separate buffer |
| ~SPC m e p~ | print last sexp (clojure interaction mode only) | | ~SPC m e u~ | Undefine a symbol from the current namespace |
| ~SPC m e P~ | eval last sexp and 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 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 *** Goto
@ -467,34 +378,32 @@ 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 Sessions *** REPL
| Key binding | Description | | Key binding | Description |
|---------------+---------------------------------------------------------------------------------| |---------------+--------------------------------------------------------------------------------|
| ~SPC m ,~ | command menu in REPL buffer (cider-repl-handle-shortcut) | | ~SPC m ,~ | handle shortcut (cider-repl-handle-shortcut) |
| ~SPC m '~ | start a REPL connection (helm selection of REPL type) | | ~SPC m s b~ | send and eval buffer in REPL |
| ~SPC m s a~ | switch between REPL and last Clojure source code buffer (cider-repl) | | ~SPC m s B~ | send and eval buffer and switch to REPL in =insert state= |
| ~SPC m s b~ | browse REPL session (sesman-browser) | | ~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 i~ | start a REPL connection (helm selection of REPL type) | | ~SPC m s f~ | send and eval function in REPL |
| ~SPC m s I~ | current REPL session information, prefix ~SPC u~ for all sessions (sesman-info) | | ~SPC m s F~ | send and eval function and switch to REPL in =insert state= |
| ~SPC m s j j~ | start Clojure REPL (=cider-jack-in-clj=) | | ~SPC m s j c~ | start Clojure REPL (=cider-jack-in-clj=) |
| ~SPC m s j m~ | start Clojure REPL (=cider-jack-in-clj&cljs=) | | ~SPC m s j f~ | start Clojure REPL (=cider-jack-in-clj&cljs=) |
| ~SPC m s j s~ | start ClojureScript REPL (=cider-jack-in-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 n~ | send and eval ns form in REPL |
| ~SPC m s l d~ | link directory to REPL session (seman-link-with-directory) | | ~SPC m s N~ | send and eval ns form and switch to REPL in =insert state= |
| ~SPC m s l p~ | link project to REPL session (seman-link-with-project) | | ~SPC m s q~ | kill REPL (cider-quit) |
| ~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 o~ | switch to other repl instance (cider-repl-switch-to-other) | | ~SPC m s r~ | send and eval region in REPL |
| ~SPC m s s j~ | connect as sibling to existing Clojure REPL | | ~SPC m s R~ | send and eval region and switch to REPL in =insert state= |
| ~SPC m s s s~ | connect as sibling to existing ClojureScript REPL | | ~SPC m s s~ | switch to REPL or jump to last file or last clj buffer from repl (cider-repl) |
| ~SPC m s r~ | restart REPL (cider-restart) | | ~SPC m s u~ | require Clojure utils into current namespace - i.e. functions =doc= =source= |
| ~SPC m s R~ | restart REPL Session (sesman-restart) | | ~SPC m s x~ | refresh REPL |
| ~SPC m s q~ | quit REPL (cider-quit) | | ~SPC m s X~ | restart REPL |
| ~SPC m s Q~ | quit REPL session (sesman-quit) |
| ~SPC m s x~ | refresh REPL (cider-ns-refresh) |
*** Tests *** Tests

65
layers/+lang/clojure/packages.el
View File

@ -64,18 +64,13 @@
;; 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") '(("md" . "debug")
("msc" . "connect repl")
("me" . "evaluation") ("me" . "evaluation")
("mes" . "send-to-repl-buffer")
("mf" . "format") ("mf" . "format")
("mg" . "goto") ("mg" . "goto")
("mh" . "documentation") ("mh" . "documentation")
("mp" . "profile") ("mp" . "profile")
("ms" . "repl") ("ms" . "repl")
("msj" . "jack-in") ("msj" . "jack-in")
("ms" . "repl sessions")
("msl" . "link session")
("mss" . "sibling sessions")
("mt" . "test") ("mt" . "test")
("mT" . "toggle") ("mT" . "toggle")
))) )))
@ -94,27 +89,15 @@
"hN" 'cider-browse-ns-all "hN" 'cider-browse-ns-all
"e;" 'cider-eval-defun-to-comment "e;" 'cider-eval-defun-to-comment
"eB" 'spacemacs/cider-send-buffer-in-repl-and-focus
"eb" 'cider-eval-buffer "eb" 'cider-eval-buffer
"ee" 'cider-eval-last-sexp "ee" 'cider-eval-last-sexp
"ef" 'cider-eval-defun-at-point "ef" 'cider-eval-defun-at-point
"ei" 'cider-interrupt "ei" 'cider-interrupt
"el" 'cider-repl-clear-buffer
"eL" 'cider-find-and-clear-repl-output
"em" 'cider-macroexpand-1 "em" 'cider-macroexpand-1
"eM" 'cider-macroexpand-all "eM" 'cider-macroexpand-all
"eP" 'cider-pprint-eval-last-sexp "eP" 'cider-pprint-eval-last-sexp
"er" 'cider-eval-region "er" 'cider-eval-region
"ese" 'spacemacs/cider-send-last-sexp-to-repl
"esE" 'spacemacs/cider-send-last-sexp-to-repl-focus
"esf" 'spacemacs/cider-send-function-to-repl
"esF" 'spacemacs/cider-send-function-to-repl-focus
"esn" 'spacemacs/cider-send-ns-form-to-repl
"esN" 'spacemacs/cider-send-ns-form-to-repl-focus
"esr" 'spacemacs/cider-send-region-to-repl
"esR" 'spacemacs/cider-send-region-to-repl-focus
"eu" 'cider-undef "eu" 'cider-undef
"eU" 'cider-repl-require-repl-utils
"ev" 'cider-eval-sexp-at-point "ev" 'cider-eval-sexp-at-point
"ew" 'cider-eval-last-sexp-and-replace "ew" 'cider-eval-last-sexp-and-replace
@ -130,31 +113,35 @@
"gs" 'cider-browse-spec "gs" 'cider-browse-spec
"gS" 'cider-browse-spec-all "gS" 'cider-browse-spec-all
"'" 'sesman-start "'" 'cider-jack-in-clj
"sa" (if (eq m 'cider-repl-mode) "\"" 'cider-jack-in-cljs
"\&" 'cider-jack-in-clj&cljs
"sb" 'cider-load-buffer
"sB" 'spacemacs/cider-send-buffer-in-repl-and-focus
"sc" (if (eq m 'cider-repl-mode)
'cider-repl-clear-buffer
'cider-connect)
"sC" 'cider-find-and-clear-repl-output
"se" 'spacemacs/cider-send-last-sexp-to-repl
"sE" 'spacemacs/cider-send-last-sexp-to-repl-focus
"sf" 'spacemacs/cider-send-function-to-repl
"sF" 'spacemacs/cider-send-function-to-repl-focus
"si" 'cider-jack-in-clj
"sjc" 'cider-jack-in-clj
"sjf" 'cider-jack-in-clj&cljs
"sjs" 'cider-jack-in-cljs
"sn" 'spacemacs/cider-send-ns-form-to-repl
"sN" 'spacemacs/cider-send-ns-form-to-repl-focus
"so" 'cider-repl-switch-to-other
"sq" 'cider-quit
"sr" 'spacemacs/cider-send-region-to-repl
"sR" 'spacemacs/cider-send-region-to-repl-focus
"ss" (if (eq m 'cider-repl-mode)
'cider-switch-to-last-clojure-buffer 'cider-switch-to-last-clojure-buffer
'cider-switch-to-repl-buffer) 'cider-switch-to-repl-buffer)
"sb" 'sesman-browser "su" 'cider-repl-require-repl-utils
"scj" 'cider-connect-clj
"scm" 'cider-connect-clj&cljs
"scs" 'cider-connect-cljs
"si" 'sesman-start
"sI" 'sesman-info
"sjj" 'cider-jack-in-clj
"sjm" 'cider-jack-in-clj&cljs
"sjs" 'cider-jack-in-cljs
"slb" 'sesman-link-with-buffer
"sld" 'sesman-link-with-directory
"slp" 'sesman-link-with-project
"slu" 'sesman-unlink
"so" 'cider-repl-switch-to-other
"ssj" 'cider-connect-sibling-clj
"sss" 'cider-connect-sibling-cljs
"sr" 'cider-restart
"sR" 'sesman-restart
"sq" 'cider-quit
"sQ" 'sesman-quit
"sx" 'cider-ns-refresh "sx" 'cider-ns-refresh
"sX" 'cider-restart
"Te" 'cider-enlighten-mode "Te" 'cider-enlighten-mode
"Tf" 'spacemacs/cider-toggle-repl-font-locking "Tf" 'spacemacs/cider-toggle-repl-font-locking

1
layers/+lang/rust/README.org
View File

@ -70,7 +70,6 @@ Consult the installation command for the desired language server found at [[http
The default LSP server for Rust is [[https://github.com/rust-lang/rls][rls]], i.e. rust language server. The default LSP server for Rust is [[https://github.com/rust-lang/rls][rls]], i.e. rust language server.
To choose the experimental [[https://github.com/rust-analyzer/rust-analyzer][rust-analyzer]], you need to set the layer variable =lsp-rust-server= of =lsp= layer: To choose the experimental [[https://github.com/rust-analyzer/rust-analyzer][rust-analyzer]], you need to set the layer variable =lsp-rust-server= of =lsp= layer:
#+BEGIN_SRC elisp #+BEGIN_SRC elisp
(lsp :variables lsp-rust-server 'rust-analyzer) (lsp :variables lsp-rust-server 'rust-analyzer)

4
layers/+os/nixos/README.org
View File

@ -31,8 +31,8 @@ file.
Toggle whether =company-nixos-options= completion is enabled (defaults to =t=). Toggle whether =company-nixos-options= completion is enabled (defaults to =t=).
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers (setq-default dotspacemacs-configuration-layers
'((nixos :variables nixos-enable-company t))) '((nixos :variables nixos-enable-company t)))
#+END_SRC #+END_SRC
* Key bindings * Key bindings

24
layers/LAYERS.org
View File

@ -180,7 +180,7 @@
- [[#speed-reading][Speed reading]] - [[#speed-reading][Speed reading]]
- [[#source-control][Source control]] - [[#source-control][Source control]]
- [[#git][Git]] - [[#git][Git]]
- [[#github][Github]] - [[#github][GitHub]]
- [[#perforce][Perforce]] - [[#perforce][Perforce]]
- [[#version-control][Version-control]] - [[#version-control][Version-control]]
- [[#spacemacs][Spacemacs]] - [[#spacemacs][Spacemacs]]
@ -1208,21 +1208,13 @@ This layer adds support for [[https://clojure.org/][Clojure]] language using [[h
Features: Features:
- REPL via [[https://github.com/clojure-emacs/cider][CIDER]] - REPL via [[https://github.com/clojure-emacs/cider][CIDER]]
- REPL session management via Sesman
- Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]] - Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]]
- Aligning of code forms via [[https://github.com/clojure-emacs/clojure-mode][clojure-mode]]
- Debugging with CIDER debug
- Clojure cheatsheet
Recommended optional features
- 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)
Other optional features
- Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]] - Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]] (beta) - Linting via [[https://github.com/clojure-emacs/squiggly-clojure][squiggly-clojure]], [[https://github.com/borkdude/clj-kondo][clj-kondo]] or [[https://github.com/candid82/joker][joker]]
- Aligning of code forms via [[https://github.com/clojure-emacs/clojure-mode][clojure-mode]]
- Debugging with [[https://github.com/clojure-emacs/sayid][sayid]]
- Clojure cheatsheet
- Structuraly safe editing using optional [[https://github.com/luxbock/evil-cleverparens][evil-cleverparens]]
**** Common lisp **** Common lisp
[[file:+lang/common-lisp/README.org][+lang/common-lisp/README.org]] [[file:+lang/common-lisp/README.org][+lang/common-lisp/README.org]]
@ -2046,7 +2038,7 @@ Features:
This layer supports [[https://www.rust-lang.org][Rust]] development in Spacemacs. This layer supports [[https://www.rust-lang.org][Rust]] development in Spacemacs.
Features: Features:
- Auto-completion and navigation support through [[https://github.com/emacs-lsp/lsp-mode][lsp-mode]] or [[https://github.com/phildawes/racer][Racer]] - Auto-completion and navigation support through [[https://github.com/emacs-lsp/lsp-rust][lsp]] or [[https://github.com/phildawes/racer][Racer]]
- Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]] - Interactive debugger using [[https://github.com/emacs-lsp/dap-mode][dap-mode]]
- support for the Rust package manager [[http://doc.crates.io/index.html][Cargo]] - support for the Rust package manager [[http://doc.crates.io/index.html][Cargo]]
@ -2353,7 +2345,7 @@ Features:
New to Magit? Checkout the [[https://magit.vc/about/][official intro]]. New to Magit? Checkout the [[https://magit.vc/about/][official intro]].
** Github ** GitHub
[[file:+source-control/github/README.org][+source-control/github/README.org]] [[file:+source-control/github/README.org][+source-control/github/README.org]]
This layers adds support for [[http://github.com][GitHub]]. This layers adds support for [[http://github.com][GitHub]].