File explorer and tree helper (v3)

book/src/configuration.md

@@ -175,6 +175,8 @@ auto-pairs = false # defaults to `true`
 The default pairs are <code>(){}[]''""``</code>, but these can be customized by
 setting `auto-pairs` to a TOML table:
 
+Example
+
 ```toml
 [editor.auto-pairs]
 '(' = ')'
@@ -332,3 +334,11 @@ max-wrap = 25 # increase value to reduce forced mid-word wrapping
 max-indent-retain = 0
 wrap-indicator = ""  # set wrap-indicator to "" to hide it
 ```
+
+### `[editor.explorer]` Section
+Sets explorer side width and style.
+
+ | Key            | Description                                                                              | Default |
+ | ---            | -----------                                                                              | ------- |
+ | `column-width` | explorer side width                                                                      | 30      |
+ | `position`     | explorer widget position, `overlay`, `right`, or `left`                                  | `left`  |

book/src/keymap.md

@@ -290,6 +290,8 @@ This layer is a kludge of mappings, mostly pickers.
 | `R`     | Replace selections by clipboard contents                                | `replace_selections_with_clipboard` |
 | `/`     | Global search in workspace folder                                       | `global_search`                     |
 | `?`     | Open command palette                                                    | `command_palette`                   |
+| `e`     | Open or focus explorer                                                  | `toggle_or_focus_explorer`          |
+| `E`     | Reveal current file in explorer                                         | `reveal_current_file`               |
 
 > TIP: Global search displays results in a fuzzy picker, use `Space + '` to bring it back up after opening a file.
 
@@ -440,3 +442,7 @@ Keys to use within prompt, Remapping currently not supported.
 | `Tab`                                       | Select next completion item                                             |
 | `BackTab`                                   | Select previous completion item                                         |
 | `Enter`                                     | Open selected                                                           |
+
+# File explorer
+Press `?` to see keymaps. Remapping currently not supported.
+

changes

@@ -0,0 +1,58 @@
+- [x] "h" moves to parent instead of scrolling to left
+- [x] "l" steps into current folder instead of scrolling to right 
+
+
+TODO
+- [x] make focus current file works
+- [x] test all explorer functionality (e.g. "/" etc)
+- [x] Go to parent directory
+- [x] add help
+- [x] highlight ancestors of current selection
+- [x] search "N" will hang
+- [x] implement rename
+- [x] implement close (refer how overlay works)
+- [x] implement refresh
+- [x] bug: delete file collapsed whole tree
+- [x] update documentation
+- [x] fix list view
+- [x] -/+ to increase or decrease width
+- [x] help page overflow 
+- [x] preview not showing in small screen
+- [x] fix (-/+) overflow
+- [x] improve filter UI/UX (should only apply to child not parent)
+- [x] bug: "h" does not realign preview
+- [x] bug: reveal file does not realign preview
+- [] "l" goes back to previous child if any history
+- [x] Merge conflicts
+- [x] Remove comments
+- [x] fix warnings
+- [x] refactor, add tree.expand_children() method
+
+New:
+- [x] increase indentation
+- [x] Change '[' to "go to previous root"
+- [x] Change 'B' to "go to parent"
+- [x] Use C-o/C-i for jump backward/forward
+- [x] on focus indication
+- [x] support creating files and folder and the same time (`mkdir -p`)
+- [x] Ctrl-o should work for 'h', 'gg', 'ge', etc
+- [x] add unit test for TreeView
+- [x] explorer(help): overflow
+- [x] n/N wrap around
+- [x] fix(filter): crash
+- [x] fix(explorer/preview): panic if not tall enough
+- [x] explorer(preview): content not sorted
+- [x] add integration test for Explorer
+- [x] bind "o" to open/close file/folder
+- [x] bind "C-n/C-p" to up/down
+- [x] bind "="/"_" to zoom-in/zoom-out
+- [x] Sticky ancestors
+- [x] remove unwrap and expect
+- [x] bug(tree): zb does not work, because clash with explorer 'b'
+- [x] Toggle preview
+- [] search highlight matching word
+- [] Error didn't clear
+- [] should preview be there by default?
+- [] Fix panic bugs (see github comments)
+- [] explorer(preview): overflow where bufferline is there
+- [] symlink not showing

helix-term/.gitignore

@@ -1 +1,2 @@
 /target
+test-explorer

helix-term/Cargo.toml

@@ -80,3 +80,5 @@ helix-loader = { version = "0.6", path = "../helix-loader" }
 smallvec = "1.10"
 indoc = "2.0.0"
 tempfile = "3.3.0"
+pretty_assertions = "1.3.0"
+build-fs-tree = "0.4.1"

helix-term/src/commands.rs

@@ -455,7 +455,10 @@ impl MappableCommand {
         decrement, "Decrement item under cursor",
         record_macro, "Record macro",
         replay_macro, "Replay macro",
-        command_palette, "Open command palette",
+        command_palette, "Open command pallete",
+        open_or_focus_explorer, "Open or focus explorer",
+        reveal_current_file, "Reveal current file in explorer",
+        close_explorer, "close explorer",
     );
 }
 
@@ -2431,6 +2434,48 @@ fn file_picker_in_current_directory(cx: &mut Context) {
     cx.push_layer(Box::new(overlayed(picker)));
 }
 
+fn open_or_focus_explorer(cx: &mut Context) {
+    cx.callback = Some(Box::new(
+        |compositor: &mut Compositor, cx: &mut compositor::Context| {
+            if let Some(editor) = compositor.find::<ui::EditorView>() {
+                match editor.explorer.as_mut() {
+                    Some(explore) => explore.content.focus(),
+                    None => match ui::Explorer::new(cx) {
+                        Ok(explore) => editor.explorer = Some(overlayed(explore)),
+                        Err(err) => cx.editor.set_error(format!("{}", err)),
+                    },
+                }
+            }
+        },
+    ));
+}
+
+fn reveal_current_file(cx: &mut Context) {
+    cx.callback = Some(Box::new(
+        |compositor: &mut Compositor, cx: &mut compositor::Context| {
+            if let Some(editor) = compositor.find::<ui::EditorView>() {
+                (|| match editor.explorer.as_mut() {
+                    Some(explore) => explore.content.reveal_current_file(cx),
+                    None => {
+                        editor.explorer = Some(overlayed(ui::Explorer::new(cx)?));
+                        let explorer = editor.explorer.as_mut().unwrap();
+                        explorer.content.reveal_current_file(cx)
+                    }
+                })()
+                .unwrap_or_else(|err| cx.editor.set_error(err.to_string()))
+            }
+        },
+    ));
+}
+
+fn close_explorer(cx: &mut Context) {
+    cx.callback = Some(Box::new(|compositor: &mut Compositor, _| {
+        if let Some(editor) = compositor.find::<ui::EditorView>() {
+            editor.explorer.take();
+        }
+    }));
+}
+
 fn buffer_picker(cx: &mut Context) {
     let current = view!(cx.editor).doc;
 

helix-term/src/keymap/default.rs

@@ -273,6 +273,8 @@ pub fn default() -> HashMap<Mode, Keymap> {
             "r" => rename_symbol,
             "h" => select_references_to_symbol_under_cursor,
             "?" => command_palette,
+            "e" => reveal_current_file,
+            "E" => open_or_focus_explorer,
         },
         "z" => { "View"
             "z" | "c" => align_view_center,