Skip to content

Commit 0a9b518

Browse files
committed
Rework the keybindings section
1 parent e8ab2b5 commit 0a9b518

File tree

1 file changed

+48
-19
lines changed

1 file changed

+48
-19
lines changed

README.md

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,12 @@ specific CIDER release.**
4848
- [Using cider-mode](#using-cider-mode)
4949
- [Using the REPL](#using-the-repl)
5050
- [ClojureScript usage](#clojurescript-usage)
51-
- [Keyboard shortcuts](#keyboard-shortcuts)
52-
- [cider-macroexpansion-mode](#cider-macroexpansion-mode)
53-
- [cider-inspector-mode](#cider-inspector-mode)
54-
- [cider-test-report-mode](#cider-test-report-mode)
55-
- [cider-stacktrace-mode](#cider-stacktrace-mode)
51+
- [Extended Workflow](#extended-workflow)
52+
- [Macroexpansion](#macroexpansion)
53+
- [Value Inspection](#value-inspection)
54+
- [Running Tests](#running-tests)
55+
- [Navigating Stacktraces](#navigating-stacktraces)
56+
- [Debugging](#debugging)
5657
- [Managing multiple connections](#managing-multiple-connections)
5758
- [Configuration](#configuration)
5859
- [Basic configuration](#basic-configuration)
@@ -527,9 +528,19 @@ presence of the `cider-nrepl` middleware. If the middleware is present then most
527528
other features of CIDER will also be enabled (including code completion,
528529
documentation lookup, the namespace browser, and macroexpansion).
529530

530-
## Keyboard shortcuts
531+
## Extended workflow
531532

532-
### cider-macroexpansion-mode
533+
CIDER packs a ton of extra functionality, besides basic Clojure code
534+
evaluation. Much of the functionality is centered around additional major modes,
535+
which provide you with convenient ways to get something done or inspect
536+
something.
537+
538+
### Macroexpansion
539+
540+
Pressing <kbd>C-c C-m</kbd> after some form in a source buffer or the REPL will
541+
result in a new buffer, showing the macroexpansion of form in question. You'll
542+
have access to additional keybindings in the macroexpansion buffer (which is
543+
internally using `cider-macroexpansion-mode`):
533544

534545
Keyboard shortcut | Description
535546
--------------------------------|-------------------------------
@@ -538,19 +549,31 @@ Keyboard shortcut | Description
538549
<kbd>g</kbd> | The prior macroexpansion is performed again and the current contents of the macroexpansion buffer are replaced with the new expansion.
539550
<kbd>C-/</kbd> <kbd>C-x u</kbd> | Undo the last inplace expansion performed in the macroexpansion buffer.
540551

541-
### cider-inspector-mode
552+
### Value inspection
542553

543-
Keyboard shortcut | Description
544-
--------------------------------|-------------------------------
554+
Pressing <kbd>C-c C-i</kbd> after some form in a source buffer or the REPL will
555+
result in a new buffer, showing the structure of the result of the form in question. You'll
556+
have access to additional keybindings in the inspector buffer (which is
557+
internally using `cider-inspector-mode`):
558+
559+
Keyboard shortcut | Description
560+
----------------------------------------|-------------------------------
545561
<kbd>Tab</kbd> and <kbd>Shift-Tab</kbd> | navigate inspectable sub-objects
546-
<kbd>Return</kbd> | inspect sub-objects
547-
<kbd>l</kbd> | pop to the parent object
548-
<kbd>g</kbd> | refresh the inspector (e.g. if viewing an atom/ref/agent)
549-
<kbd>SPC</kbd> | jump to next page in paginated view
550-
<kbd>M-SPC</kbd> | jump to previous page in paginated view
551-
<kbd>s</kbd> | set a new page size in paginated view
562+
<kbd>Return</kbd> | inspect sub-objects
563+
<kbd>l</kbd> | pop to the parent object
564+
<kbd>g</kbd> | refresh the inspector (e.g. if viewing an atom/ref/agent)
565+
<kbd>SPC</kbd> | jump to next page in paginated view
566+
<kbd>M-SPC</kbd> | jump to previous page in paginated view
567+
<kbd>s</kbd> | set a new page size in paginated view
552568

553-
### cider-test-report-mode
569+
### Running tests
570+
571+
You can run `clojure.test` tests pretty quickly in CIDER. Pressing <kbd>C-c
572+
,</kbd> in a source buffer will run the tests for the namespace you're currently
573+
in. CIDER is smart enough to figure out the namespace containing the tests.
574+
575+
In the buffer displaying the test execution results you'll have a bit of
576+
additional functionality at your disposal.
554577

555578
Keyboard shortcut | Description
556579
--------------------------------|-------------------------------
@@ -563,7 +586,13 @@ Keyboard shortcut | Description
563586
<kbd>d</kbd> | Display diff of actual vs expected.
564587
<kbd>e</kbd> | Display test error cause and stacktrace info.
565588

566-
### cider-stacktrace-mode
589+
### Navigating stacktraces
590+
591+
CIDER comes with a powerful solution to the problem of verbose Clojure
592+
stacktraces. Stacktraces are presented in a special major mode
593+
(`cider-stacktrace-mode`), which gives you the possibility to filter out certain
594+
stack frames and some handy ways to navigate causes. You'll also be able to go
595+
to the code in question with a single keystroke.
567596

568597
Keyboard shortcut | Description
569598
--------------------------------|-------------------------------
@@ -584,7 +613,7 @@ Keyboard shortcut | Description
584613
<kbd>d</kbd> | toggle display of duplicate frames
585614
<kbd>a</kbd> | toggle display of all frames
586615

587-
### cider-debug
616+
### Debugging
588617

589618
The debugger can be invoked in several ways, the simplest one is to type
590619
<kbd>C-u C-M-x</kbd>. This will take the current top-level form, place as many

0 commit comments

Comments
 (0)