Enhancing the Clojure experience

Enhance the clojure layer by adding automatic linting (clj-kondo), refactoring (clj-refactor) and recommended CIDER options. Complement the Clojure layer with general development tools including a git client (Magit), markdown and org-mode support.

practicalli/spacemacs.d provides a documented configuration of the layers for Clojure development and many useful customization's for Spacemacs.

Layer name Description
auto-completion complete names of functions and symbol names, also list snippets.
clojure CIDER, optionally with clj-refactor and clj-kondo linter
elisp edit .spacemacs configuration and any Emacs elisp code
git git version control with Magit in full screen, with fringe highlighting of changes in buffers
github GitHub API for remote repositories and gists
helm completion and selection narrowing framework
markdown writing project descriptions in README.md and other markdown files
multiple-cursors multiple concurrent edits with more than one cursor g r
org write documentation, organize tasks with org-mode
spell-checking spell check as you type using your Operating System spell checker SPC S s
syntax-checking syntax checking / linting as you type (flycheckk with clj-kondo for Clojure)
treemacs visual file system browser (file explorer) SPC p t
version-control 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

SPC f e d opens the .spacemacs configuration file (M-m f e d holy mode)

Use SPC s s and start typing configuration-layers to search for the dotspacemacs-configuration-layers section. RTN to jump to the highlighted line, C-j to move down the matching lines, C-k to move up.

Add the following layers to dotspacemacs-configuration-layers ensuring there are no duplicates

     (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-toplevel-inside-comment-form t
              cider-overlays-use-font-lock t
              cider-preferred-build-tool 'clojure-cli
              clojure-enable-linters 'clj-kondo
              clojure-enable-clj-refactor t)
     emacs-lisp
     (git :variables
          git-magit-status-fullscreen t
          magit-diff-refine-hunk 'all)
     github
     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.

SPC q r to restart Spacemacs which will load and configure all the new layers and their Emacs packages.

Optional layer features with :variables

Using the :variables directive on layers allows you to include optional features and packages for a particular layer.

clojure layer: set the variable clojure-enable-clj-refactor to true to include the clj-refactor package which provides additional refactor commands.

version-control layer: set the variables git-gutter-use-fringe to true, displaying changed lines in your working file in the fringe (margin) of the current buffer.

I have not included the sayid debug in this enhanced setup for Clojure as I find the cider-debug tool, 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-clj-refactor t
              clojure-enable-linters 'clj-kondo
              clojure-enable-sayid t)

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.

Available Layers

SPC h l (or M-m h l 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.

Helm layers

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 mnemonic 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 SPC b.

The keybindings to open the file of the emacs dotfile (.spacemacs) are therefore: SPC f e d

results matching ""

    No results matching ""