Enhancing the Clojure experience
Enhance the clojure layer by adding automatic linting and additional refactoring and add several packages for general development features.
.spacemacs file provides a documented configuration of the layers currently recommended.
||to complete names of functions and symbol names, also list snippets.|
||CIDER with clj-refactor and clj-kondo linter|
||git version control with Magit in full screen, with fringe highlighting of changes in buffers|
||completion and selection narrowing framework|
||writing project descriptions in README.md and other markdown files|
||editing a buffer using multiple cursors|
||write project documentation, organise tasks withorg-mode|
||spell checking using your Operating System spell checker (
||spell checking words as you type using Fly Spell|
||visual file system browser (file explorer)|
||general version control features, eg. ediff, fringe highlights|
Install clj-kondo binary
clj-kondo automatic linting requires the binary of
clj-kondo installed on the operating system path in order to work.
Please read the clj-kondo install guide for details.
Edit .spacemacs and add layers
.spacemacs file via
SPC f e d (
M-m f e d holy mode)
/ and start typing
configuration-layers to search for the
RTN confirms the search text and
n jumps to the next occurance,
N jumps to the previous occurrence.
Add the following layers to
dotspacemacs-configuration-layers ensuring there are no duplicates
dotspacemacs-configuration-layers '( (auto-completion :variables auto-completion-enable-help-tooltip t auto-completion-enable-snippets-in-popup t auto-completion-enable-sort-by-usage t) (clojure :variables clojure-enable-clj-refactor t clojure-enable-linters 'clj-kondo) emacs-lisp (git :variables git-magit-status-fullscreen t git-enable-github-support t git-gutter-use-fringe t) helm markdown multiple-cursors org spell-checking syntax-checking treemacs (version-control :variables version-control-diff-tool 'diff-hl version-control-global-margin t) )
SPC f s to save the file.
Optional layer features with :variables
:variables directive on layers allows you to include optional features and packages for a particular layer.
In the Clojure layer the
clj-refactor package is included by setting the variable
clojure-enable-clj-refactor to true. This provides specific refactor commands for the Clojure language.
version-control layer The
git-gutter-use-fringe to display changed lines in your working file in the fringe (margin) of the current buffer.
I have not included the sayid debugger in this enhanced setup for Clojure as I find the
cider-debugger, d b` sufficient.
If you wish use extensive debugging for the whole project, then enable sayid by adding the variable
clojure-enable-sayid. So your layer definition for Clojure would look like:
(clojure :variables clojure-enable-sayid t clojure-enable-clj-refactor t clojure-enable-linters 'clj-kondo)
Reload Configuration or Restart Emacs
SPC q r to restart Emacs with the new configuration. This is the recommended approach when making a big change or adding layers to ensure all the new packages are installed and configured.
For smaller changes you can reload the
~/.spacemacs configuration using
SPC f e R.
SPC h SPC (or
M-m f e h in holy mode) displays a list of all layers available in Spacemacs. Type the layer name or scroll down (
C-j) to a layer name and press
TAB to preview the documentation for that layer or
RTN to open the docs for that layer in a buffer.
Create your own layers with
SPC SPC configuration-layer/create-layer. See the Spacemacs docs and Configuring Spacemacs, a tutorial for more information.
Spacemacs Clojure configuration example
Trying to use packages-list-packages to install packages directly is simply ignored by Spacemacs. See how to configure a package without a layer in the Spacemacs documentation.
The Spacemacs menu system use a nemonic system for organising its menus and commands. So to access a menu of file related commands, you press
SPC f and for a menu of buffer commands you would use
The keybindings to open the file of the emacs dotfile (.spacemacs) are therefore:
SPC f e d