Merge pull request #796 from wcerfgba/toggle-keybindings

Allow toggling keyboard shortcuts
BetterThanTomorrow · Sep 22, 2020 · 5d7a723 · 5d7a723
2 parents 5db8fed + 632c346
commit 5d7a723
Show file tree

Hide file tree

Showing 6 changed files with 166 additions and 123 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ Changes to Calva.
 - [Fix: evals should be ignored during parsing](https://github.com/BetterThanTomorrow/calva/issues/763)
 - Fix: [Test runner can't find tests under cursor when using a custom test macro](https://github.com/BetterThanTomorrow/calva/issues/786)
 - Fix: [Test runner output only partially commented](https://github.com/BetterThanTomorrow/calva/issues/787)
+- [Allow toggling keyboard shortcuts](https://github.com/BetterThanTomorrow/calva/issues/784)
 
 ## [2.0.124] - 2020-08-31
 - Re-fix: [Can't jack-in when no project file is open](https://github.com/BetterThanTomorrow/calva/issues/734)

diff --git a/docs/site/finding-commands.md b/docs/site/finding-commands.md
@@ -5,7 +5,7 @@ Calva relies a lot on that VS Code makes it really easy to find commands by open
 To leverage this, all Calva commands are prefixed with `Calva`. As an example, say you want to evaluate a form and pretty print it. Then you can do this:
 
 1. Open the command palette
-2. Type `calevpr` 
+2. Type `calevpr`
 
 VS Code will match `cal` to ”**Cal**va”, `ev` to ”**Ev**aluate”, and `pr` to ”**pr**etty” in ”**pr**etty print”. It looks like so:
 
@@ -17,6 +17,10 @@ Now might be a good time to see [Calva Top 10 Commands](commands-top10.md)
 
 ## All the Settings and Commands
 
-Did you know? There is a complete list of Calva settings and commands in the *Contributions* tab of the Calva entry in the *Extensions* pane in VS Code. 
+Did you know? There is a complete list of Calva settings and commands in the *Contributions* tab of the Calva entry in the *Extensions* pane in VS Code.
 
 ![The Calva Contributions Tab](https://user-images.githubusercontent.com/30010/66733740-c754b800-ee60-11e9-877b-962f6b920cd7.png)
+
+## Toggling Keyboard Shortcuts On/Off
+
+The command `calva.toggleKeybindingsEnabled` can be used to quickly enable and disable (almost) all keyboard shortcuts. By default it is bound to `ctrl+alt+c ctrl+alt+k`, and this shortcut is the only one which will not be disabled. This allows you to quickly toggle between Calva keybindings and other keybindings which would otherwise not be available when Calva is enabled. This is particularly useful with the Paredit keyboard shortcuts, whose default shortcuts conflict with the default VS Code shortcuts for textual (non-structural) editing.