Merge branch 'master' into debug

1 files changed, 97 insertions, 85 deletions

diff --git a/book/src/keymap.md b/book/src/keymap.md
index 861e46ac..78bac0cf 100644
--- a/book/src/keymap.md
+++ b/book/src/keymap.md
@@ -4,40 +4,40 @@
 
 ### Movement
 
-> NOTE: `f`, `F`, `t` and `T` are not confined to the current line.
-
-| Key          | Description                                                                | Command                     |
-| -----        | -----------                                                                | -------                     |
-| `h`, `Left`  | Move left                                                                  | `move_char_left`            |
-| `j`, `Down`  | Move down                                                                  | `move_char_right`           |
-| `k`, `Up`    | Move up                                                                    | `move_line_up`              |
-| `l`, `Right` | Move right                                                                 | `move_line_down`            |
-| `w`          | Move next word start                                                       | `move_next_word_start`      |
-| `b`          | Move previous word start                                                   | `move_prev_word_start`      |
-| `e`          | Move next word end                                                         | `move_next_word_end`        |
-| `W`          | Move next WORD start                                                       | `move_next_long_word_start` |
-| `B`          | Move previous WORD start                                                   | `move_prev_long_word_start` |
-| `E`          | Move next WORD end                                                         | `move_next_long_word_end`   |
-| `t`          | Find 'till next char                                                       | `find_till_char`            |
-| `f`          | Find next char                                                             | `find_next_char`            |
-| `T`          | Find 'till previous char                                                   | `till_prev_char`            |
-| `F`          | Find previous char                                                         | `find_prev_char`            |
-| `Home`       | Move to the start of the line                                              | `goto_line_start`           |
-| `End`        | Move to the end of the line                                                | `goto_line_end`             |
-| `PageUp`     | Move page up                                                               | `page_up`                   |
-| `PageDown`   | Move page down                                                             | `page_down`                 |
-| `Ctrl-u`     | Move half page up                                                          | `half_page_up`              |
-| `Ctrl-d`     | Move half page down                                                        | `half_page_down`            |
-| `Ctrl-i`     | Jump forward on the jumplist TODO: conflicts tab                           | `jump_forward`              |
-| `Ctrl-o`     | Jump backward on the jumplist                                              | `jump_backward`             |
-| `v`          | Enter [select (extend) mode](#select--extend-mode)                         | `select_mode`               |
-| `g`          | Enter [goto mode](#goto-mode)                                              | N/A                         |
-| `m`          | Enter [match mode](#match-mode)                                            | N/A                         |
-| `:`          | Enter command mode                                                         | `command_mode`              |
-| `z`          | Enter [view mode](#view-mode)                                              | N/A                         |
-| `Ctrl-w`     | Enter [window mode](#window-mode) (maybe will be remove for spc w w later) | N/A                         |
-| `Space`      | Enter [space mode](#space-mode)                                            | N/A                         |
-| `K`          | Show documentation for the item under the cursor                           | `hover`                     |
+> NOTE: Unlike vim, `f`, `F`, `t` and `T` are not confined to the current line.
+
+| Key          | Description                                        | Command                     |
+| -----        | -----------                                        | -------                     |
+| `h`, `Left`  | Move left                                          | `move_char_left`            |
+| `j`, `Down`  | Move down                                          | `move_char_right`           |
+| `k`, `Up`    | Move up                                            | `move_line_up`              |
+| `l`, `Right` | Move right                                         | `move_line_down`            |
+| `w`          | Move next word start                               | `move_next_word_start`      |
+| `b`          | Move previous word start                           | `move_prev_word_start`      |
+| `e`          | Move next word end                                 | `move_next_word_end`        |
+| `W`          | Move next WORD start                               | `move_next_long_word_start` |
+| `B`          | Move previous WORD start                           | `move_prev_long_word_start` |
+| `E`          | Move next WORD end                                 | `move_next_long_word_end`   |
+| `t`          | Find 'till next char                               | `find_till_char`            |
+| `f`          | Find next char                                     | `find_next_char`            |
+| `T`          | Find 'till previous char                           | `till_prev_char`            |
+| `F`          | Find previous char                                 | `find_prev_char`            |
+| `Home`       | Move to the start of the line                      | `goto_line_start`           |
+| `End`        | Move to the end of the line                        | `goto_line_end`             |
+| `PageUp`     | Move page up                                       | `page_up`                   |
+| `PageDown`   | Move page down                                     | `page_down`                 |
+| `Ctrl-u`     | Move half page up                                  | `half_page_up`              |
+| `Ctrl-d`     | Move half page down                                | `half_page_down`            |
+| `Ctrl-i`     | Jump forward on the jumplist                       | `jump_forward`              |
+| `Ctrl-o`     | Jump backward on the jumplist                      | `jump_backward`             |
+| `v`          | Enter [select (extend) mode](#select--extend-mode) | `select_mode`               |
+| `g`          | Enter [goto mode](#goto-mode)                      | N/A                         |
+| `m`          | Enter [match mode](#match-mode)                    | N/A                         |
+| `:`          | Enter command mode                                 | `command_mode`              |
+| `z`          | Enter [view mode](#view-mode)                      | N/A                         |
+| `Z`          | Enter sticky [view mode](#view-mode)               | N/A                         |
+| `Ctrl-w`     | Enter [window mode](#window-mode)                  | N/A                         |
+| `Space`      | Enter [space mode](#space-mode)                    | N/A                         |
 
 ### Changes
 
@@ -66,6 +66,16 @@
 | `d`         | Delete selection                                | `delete_selection`    |
 | `c`         | Change selection (delete and enter insert mode) | `change_selection`    |
 
+#### Shell
+
+| Key                   | Description                                                                      | Command               |
+| ------                | -----------                                                                      | -------               |
+| <code>&#124;</code>   | Pipe each selection through shell command, replacing with output                 | `shell_pipe`          |
+| <code>A-&#124;</code> | Pipe each selection into shell command, ignoring output                          | `shell_pipe_to`       |
+| `!`                   | Run shell command, inserting output before each selection                        | `shell_insert_output` |
+| `A-!`                 | Run shell command, appending output after each selection                         | `shell_append_output` |
+
+
 ### Selection manipulation
 
 | Key      | Description                                                       | Command                              |
@@ -75,6 +85,7 @@
 | `Alt-s`  | Split selection on newlines                                       | `split_selection_on_newline`         |
 | `;`      | Collapse selection onto a single cursor                           | `collapse_selection`                 |
 | `Alt-;`  | Flip selection cursor and anchor                                  | `flip_selections`                    |
+| `,`      | Keep only the primary selection                                   | `keep_primary_selection`             |
 | `C`      | Copy selection onto the next line                                 | `copy_selection_on_next_line`        |
 | `Alt-C`  | Copy selection onto the previous line                             | `copy_selection_on_prev_line`        |
 | `(`      | Rotate main selection forward                                     | `rotate_selections_backward`         |
@@ -86,22 +97,13 @@
 | `X`      | Extend selection to line bounds (line-wise selection)             | `extend_to_line_bounds`              |
 |          | Expand selection to parent syntax node TODO: pick a key           | `expand_selection`                   |
 | `J`      | Join lines inside selection                                       | `join_selections`                    |
-| `K`      | Keep selections matching the regex TODO: overlapped by hover help | `keep_selections`                    |
-| `Space`  | Keep only the primary selection TODO: overlapped by space mode    | `keep_primary_selection`             |
+| `K`      | Keep selections matching the regex                                | `keep_selections`                    |
+| `$`      | Pipe each selection into shell command, keep selections where command returned 0 | `shell_keep_pipe`     |
 | `Ctrl-c` | Comment/uncomment the selections                                  | `toggle_comments`                    |
 
-### Insert Mode
-
-| Key      | Description           | Command                |
-| -----    | -----------           | -------                |
-| `Escape` | Switch to normal mode | `normal_mode`          |
-| `Ctrl-x` | Autocomplete          | `completion`           |
-| `Ctrl-w` | Delete previous word  | `delete_word_backward` |
-
 ### Search
 
-> TODO: The search implementation isn't ideal yet -- we don't support searching
-in reverse, or searching via smartcase.
+> TODO: The search implementation isn't ideal yet -- we don't support searching in reverse.
 
 | Key   | Description                                 | Command              |
 | ----- | -----------                                 | -------              |
@@ -110,41 +112,17 @@ in reverse, or searching via smartcase.
 | `N`   | Add next search match to selection          | `extend_search_next` |
 | `*`   | Use current selection as the search pattern | `search_selection`   |
 
-### Unimpaired
-
-Mappings in the style of [vim-unimpaired](https://github.com/tpope/vim-unimpaired)
-
-| Key       | Description                        | Command           |
-| -----     | -----------                        | -------           |
-| `[d`      | Go to previous diagnostic          | `goto_prev_diag`  |
-| `]d`      | Go to next diagnostic              | `goto_next_diag`  |
-| `[D`      | Go to first diagnostic in document | `goto_first_diag` |
-| `]D`      | Go to last diagnostic in document  | `goto_last_diag`  |
-| `[space`  | Add newline above                  | `add_newline_above` |
-| `]space`  | Add newline below                  | `add_newline_below` |
-
-### Shell
+### Minor modes
 
-| Key    | Description                                                                      | Command               |
-| ------ | -----------                                                                      | -------               |
-| `\|`   | Pipe each selection through shell command, replacing with output                 | `shell_pipe`          |
-| `A-\|` | Pipe each selection into shell command, ignoring output                          | `shell_pipe_to`       |
-| `!`    | Run shell command, inserting output before each selection                        | `shell_insert_output` |
-| `A-!`  | Run shell command, appending output after each selection                         | `shell_append_output` |
-| `$`    | Pipe each selection into shell command, keep selections where command returned 0 | `shell_keep_pipe`     |
-
-## Select / extend mode
-
-I'm still pondering whether to keep this mode or not. It changes movement
-commands to extend the existing selection instead of replacing it.
-
-> NOTE: It's a bit confusing at the moment because extend hasn't been
-> implemented for all movement commands yet.
+These sub-modes are accessible from normal mode and typically switch back to normal mode after a command.
 
-## View mode
+#### View mode
 
 View mode is intended for scrolling and manipulating the view without changing
-the selection.
+the selection. The "sticky" variant of this mode is persistent; use the Escape
+key to return to normal mode after usage (useful when you're simply looking
+over text and not actively editing it).
+
 
 | Key       | Description                                               | Command             |
 | -----     | -----------                                               | -------             |
@@ -154,8 +132,12 @@ the selection.
 | `m`       | Align the line to the middle of the screen (horizontally) | `align_view_middle` |
 | `j`       | Scroll the view downwards                                 | `scroll_down`       |
 | `k`       | Scroll the view upwards                                   | `scroll_up`         |
+| `f`       | Move page down                                            | `page_down`         |
+| `b`       | Move page up                                              | `page_up`           |
+| `d`       | Move half page down                                       | `half_page_down`    |
+| `u`       | Move half page up                                         | `half_page_up`      |
 
-## Goto mode
+#### Goto mode
 
 Jumps to various locations.
 
@@ -177,7 +159,7 @@ Jumps to various locations.
 | `i`   | Go to implementation                             | `goto_implementation`      |
 | `a`   | Go to the last accessed/alternate file           | `goto_last_accessed_file`  |
 
-## Match mode
+#### Match mode
 
 Enter this mode using `m` from normal mode. See the relavant section
 in [Usage](./usage.md) for an explanation about [surround](./usage.md#surround)
@@ -192,11 +174,9 @@ and [textobject](./usage.md#textobject) usage.
 | `a` `<object>`   | Select around textobject                        | `select_textobject_around` |
 | `i` `<object>`   | Select inside textobject                        | `select_textobject_inner`  |
 
-## Object mode
-
 TODO: Mappings for selecting syntax nodes (a superset of `[`).
 
-## Window mode
+#### Window mode
 
 This layer is similar to vim keybindings as kakoune does not support window.
 
@@ -207,24 +187,56 @@ This layer is similar to vim keybindings as kakoune does not support window.
 | `h`, `Ctrl-h` | Horizontal bottom split | `hsplit`      |
 | `q`, `Ctrl-q` | Close current window    | `wclose`      |
 
-## Space mode
+#### Space mode
 
-This layer is a kludge of mappings I had under leader key in neovim.
+This layer is a kludge of mappings, mostly pickers.
 
 | Key     | Description                                                           | Command                             |
 | -----   | -----------                                                           | -------                             |
+| `k`     | Show documentation for the item under the cursor                      | `hover`                             |
 | `f`     | Open file picker                                                      | `file_picker`                       |
 | `b`     | Open buffer picker                                                    | `buffer_picker`                     |
 | `s`     | Open symbol picker (current document)                                 | `symbol_picker`                     |
 | `a`     | Apply code action                                                     | `code_action`                       |
 | `'`     | Open last fuzzy picker                                                | `last_picker`                       |
 | `w`     | Enter [window mode](#window-mode)                                     | N/A                                 |
-| `space` | Keep primary selection TODO: it's here because space mode replaced it | `keep_primary_selection`            |
 | `p`     | Paste system clipboard after selections                               | `paste_clipboard_after`             |
 | `P`     | Paste system clipboard before selections                              | `paste_clipboard_before`            |
 | `y`     | Join and yank selections to clipboard                                 | `yank_joined_to_clipboard`          |
 | `Y`     | Yank main selection to clipboard                                      | `yank_main_selection_to_clipboard`  |
 | `R`     | Replace selections by clipboard contents                              | `replace_selections_with_clipboard` |
+| `/`     | Global search in workspace folder                                     | `global_search`                     |
+
+> NOTE: Global search display results in a fuzzy picker, use `space + '` to bring it back up after opening a file.
+ 
+#### Unimpaired
+
+Mappings in the style of [vim-unimpaired](https://github.com/tpope/vim-unimpaired).
+
+| Key       | Description                        | Command           |
+| -----     | -----------                        | -------           |
+| `[d`      | Go to previous diagnostic          | `goto_prev_diag`  |
+| `]d`      | Go to next diagnostic              | `goto_next_diag`  |
+| `[D`      | Go to first diagnostic in document | `goto_first_diag` |
+| `]D`      | Go to last diagnostic in document  | `goto_last_diag`  |
+| `[space`  | Add newline above                  | `add_newline_above` |
+| `]space`  | Add newline below                  | `add_newline_below` |
+
+## Insert Mode
+
+| Key      | Description           | Command                |
+| -----    | -----------           | -------                |
+| `Escape` | Switch to normal mode | `normal_mode`          |
+| `Ctrl-x` | Autocomplete          | `completion`           |
+| `Ctrl-w` | Delete previous word  | `delete_word_backward` |
+
+## Select / extend mode
+
+I'm still pondering whether to keep this mode or not. It changes movement
+commands (including goto) to extend the existing selection instead of replacing it.
+
+> NOTE: It's a bit confusing at the moment because extend hasn't been
+> implemented for all movement commands yet.
 
 # Picker