summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArtur Malabarba <bruce.connor.am@gmail.com>2015-03-28 11:10:20 +0000
committerArtur Malabarba <bruce.connor.am@gmail.com>2015-03-28 12:59:46 +0000
commitd6b6d7758383f395852f73e674a7659d7103263b (patch)
tree9eab16b11a4267a82e36c51579e15ea2991b45a2 /README.md
parentf0145830ebe921a4f6b2a7f56434788b67c9ec56 (diff)
Add cider-debug.el: Interactive debugger similar to edebug
Add cider-debug-defun-at-point to the menu-bar. Bind cider-debug-defun-at-point to cider-eval-defun-at-point with a prefix. This needs debug.clj at cider-nrepl to work. Invoke M-x cider-debug-defun-at-point to see it in action.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5539a508..d5ebdf73 100644
--- a/README.md
+++ b/README.md
@@ -724,7 +724,8 @@ Keyboard shortcut | Description
<kbd>C-c M-p</kbd> | Load the form preceding point in the REPL buffer.
<kbd>C-c C-p</kbd> | Evaluate the form preceding point and pretty-print the result in a popup buffer.
<kbd>C-c C-f</kbd> | Evaluate the top level form under point and pretty-print the result in a popup buffer.
-<kbd>C-M-x</kbd> <kbd>C-c C-c</kbd> | Evaluate the top level form under point and display the result in the echo area. If invoked with a prefix argument, insert the result into the current buffer.
+<kbd>C-M-x</kbd> <kbd>C-c C-c</kbd> | Evaluate the top level form under point and display the result in the echo area.
+<kbd>C-u C-M-x</kbd> <kbd>C-u C-c C-c</kbd> | Debug the top level form under point and walk through its evaluation
<kbd>C-c C-r</kbd> | Evaluate the region and display the result in the echo area.
<kbd>C-c C-b</kbd> | Interrupt any pending evaluations.
<kbd>C-c C-m</kbd> | Invoke `macroexpand-1` on the form at point and display the result in a macroexpansion buffer. If invoked with a prefix argument, `macroexpand` is used instead of `macroexpand-1`.
@@ -844,6 +845,19 @@ Keyboard shortcut | Description
<kbd>d</kbd> | toggle display of duplicate frames
<kbd>a</kbd> | toggle display of all frames
+### cider-debug
+<!-- Technically this is not a mode (yet), but let's not burden the user with that knowledge. -->
+
+cider-debug (invoked with <kbd>C-u C-M-x</kbd>) tries to be consistent with
+Edebug. So it makes available the following bindings while stepping through
+code.
+
+Keyboard shortcut | Description
+--------------------------------|-------------------------------
+<kbd>n</kbd> | Next step
+<kbd>c</kbd> | Continue without stopping
+<kbd>i</kbd> | Inject a value into running code
+
### Managing multiple sessions
You can connect to multiple nREPL servers using <kbd>M-x