spacemacs/layers/+lang/emacs-lisp/README.org

#+TITLE: Emacs Lisp contribution layer for Spacemacs

[[file:img/emacs-lisp.png]]

* Table of Contents                                                   :TOC@4:
 - [[#description][Description]]
 - [[#install][Install]]
 - [[#key-bindings][Key bindings]]
   - [[#working-with-lisp-files-barfage-slurpage--more][Working with lisp files (barfage, slurpage & more)]]
   - [[#leader][Leader]]
   - [[#srefactor][srefactor]]

* Description

This layer gathers all the configuration related to emacs-lisp. This should
always be in your dotfile, it is not recommended to uninstall it.

* Install

To use this contribution add it to your =~/.spacemacs=

#+BEGIN_SRC emacs-lisp
  (setq-default dotspacemacs-configuration-layers '(emacs-lisp))
#+END_SRC

* Key bindings
** Working with lisp 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 for all files the same, the documentation for it has been added into the 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.

** Leader

| Key Binding                | Description                                                |
|----------------------------+------------------------------------------------------------|
| ~SPC m g g~                | go to definition of symbol under point                     |
| ~SPC m h h~                | describe symbol at point                                   |
| ~SPC m e $~ or ~SPC m e l~ | go to end of current line and evaluate                     |
| ~SPC m e b~                | evaluate current buffer                                    |
| ~SPC m e c~                | evaluate current form (start with =defun=, =setq=, etc...) |
| ~SPC m e e~                | evaluate sexp before point                                 |
| ~SPC m e r~                | evaluate current region                                    |
| ~SPC m e f~                | evaluation current function                                |
| ~SPC m ,~                  | toggle =lisp state=                                        |
| ~SPC m t b~                | run tests of current buffer                                |
| ~SPC m t q~                | run =ert=                                                  |
| ~SPC m d m~                | open [[https://github.com/joddie/macrostep][macrostep]] micro-state                                 |

** srefactor

The [[file:../../semantic/README.org][semantic-layer]] should be installed for these key bindings
to become active.

| Key Binding | Description             |
|-------------+-------------------------|
| ~SPC m = b~ | format current buffer   |
| ~SPC m = f~ | format current function |
| ~SPC m = o~ | format all on one line  |
| ~SPC m = s~ | format current sexp     |