Skip to content

Commit 88d84fe

Browse files
migration complete
1 parent c0c1148 commit 88d84fe

34 files changed

+4647
-287
lines changed

README.md

Lines changed: 228 additions & 206 deletions
Large diffs are not rendered by default.

archive/CONSISTENCY.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Keymap Consistency Guide
2+
3+
> **Last Updated:** November 1, 2025
4+
> **Purpose:** Document consistent keymaps across Telescope and Neo-tree
5+
6+
## 🎯 Consistent Actions
7+
8+
The following keymaps work **identically** in both Telescope and Neo-tree:
9+
10+
### File Opening Actions
11+
12+
| Key | Action | Telescope | Neo-tree |
13+
|-----|--------|-----------|----------|
14+
| `<CR>` or `o` | Open in current window |||
15+
| `<C-x>` | Open in horizontal split |||
16+
| `<C-v>` | Open in vertical split |||
17+
| `<C-t>` | Open in new tab |||
18+
19+
### Navigation
20+
21+
| Key | Action | Telescope | Neo-tree |
22+
|-----|--------|-----------|----------|
23+
| `<C-j>` | Next item/source |||
24+
| `<C-k>` | Previous item/source |||
25+
| `j/k` (normal mode) | Down/Up |||
26+
| `gg/G` (normal mode) | First/Last |||
27+
28+
### Utility
29+
30+
| Key | Action | Telescope | Neo-tree |
31+
|-----|--------|-----------|----------|
32+
| `?` | Show help |||
33+
| `<Esc>` or `q` | Close || ✅ (`\\` for Neo-tree) |
34+
35+
### Cross-Plugin Integration
36+
37+
| Key | Action | Context |
38+
|-----|--------|---------|
39+
| `<leader>sf` | Telescope find files | Works in both editor and Neo-tree |
40+
| `<leader>sg` | Telescope live grep | Works in both editor and Neo-tree |
41+
42+
When used in Neo-tree, these commands search from the currently selected directory!
43+
44+
## 📚 Complete Cheatsheet Access
45+
46+
Access the comprehensive cheatsheet with:
47+
48+
```
49+
<leader>sc - Complete cheatsheet (vim, plugins, language-specific)
50+
<leader>sk - Search keymaps (Telescope)
51+
<leader>sK - All keymaps (which-key)
52+
<leader>? - Quick keymap search
53+
```
54+
55+
## 🎨 Visual Consistency
56+
57+
Both Telescope and Neo-tree now follow the same pattern:
58+
- **Same keys** for same actions
59+
- **Predictable behavior** across interfaces
60+
- **Integrated workflows** (use Telescope from Neo-tree)
61+
- **Help always available** with `?`
62+
63+
## 📝 Quick Reference
64+
65+
### In Telescope:
66+
1. `<C-j/k>` to navigate
67+
2. `<C-x/v/t>` to open in split/vsplit/tab
68+
3. `<CR>` to open in current window
69+
4. `?` for help
70+
71+
### In Neo-tree:
72+
1. `<C-j/k>` to switch sources
73+
2. `<C-x/v/t>` to open in split/vsplit/tab
74+
3. `<CR>` or `o` to open file
75+
4. `?` for help
76+
5. `<leader>sf/sg` to launch Telescope from current directory
77+
78+
### Both Share:
79+
- Consistent split/tab opening
80+
- Same navigation philosophy
81+
- Integrated search capabilities
82+
- Help on demand

archive/DUPLICATES.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Duplicate Keymaps Reference
2+
3+
This document lists all keymaps where the same action can be performed using multiple key combinations.
4+
5+
## Philosophy
6+
7+
Having duplicate keymaps is **intentional and beneficial**:
8+
- **Vim defaults + Modern alternatives**: Keep familiar vim keys while adding intuitive modern ones
9+
- **Consistency across plugins**: Same keys work the same way in Telescope and Neo-tree
10+
- **Ergonomics**: Function keys (F5-F12) AND leader keys for debugging
11+
- **Context switching**: Use what feels natural in different workflows
12+
13+
## Debug Actions
14+
15+
| Action | Keys | Notes |
16+
|--------|------|-------|
17+
| Continue | `F5` or `<Space>dc` | F5 is standard in many IDEs |
18+
| Step over | `F10` or `<Space>dO` | Uppercase O for over |
19+
| Step into | `F11` or `<Space>di` | |
20+
| Step out | `F12` or `<Space>do` | Lowercase o for out |
21+
22+
**Why duplicates?** Function keys are muscle memory from other IDEs. Leader keys are more discoverable via which-key and don't conflict with terminal function keys.
23+
24+
## Neo-tree vs Consistent Actions
25+
26+
| Action | Neo-tree Default | Consistent Alternative | Notes |
27+
|--------|------------------|------------------------|-------|
28+
| Vertical split | `s` | `Ctrl-v` | Matches Telescope |
29+
| Horizontal split | `S` | `Ctrl-x` | Matches Telescope |
30+
| New tab | `t` | `Ctrl-t` | Matches Telescope |
31+
| Next source | `>` | `Ctrl-j` | Matches Telescope navigation |
32+
| Previous source | `<` | `Ctrl-k` | Matches Telescope navigation |
33+
| Close window | `q` | `\` or `Esc` | Backslash mirrors toggle |
34+
| Open file | `<CR>` | `o` | Two ways to open |
35+
36+
**Why duplicates?** Neo-tree defaults are efficient single-key presses. Consistent alternatives (`Ctrl-x/v/t/j/k`) work the same way in Telescope, reducing cognitive load when switching between file finder and file tree.
37+
38+
## Flutter Code Actions
39+
40+
| Action | Keys | Notes |
41+
|--------|------|-------|
42+
| Code actions | `<Space>.` or `gra` | Period mimics Cmd+. in IDEs, gra is standard LSP |
43+
44+
**Why duplicates?** Flutter developers coming from IDEs expect `.` (like Cmd+.). `gra` is the standard LSP keymap used everywhere else.
45+
46+
## Telescope Navigation
47+
48+
| Action | Keys | Notes |
49+
|--------|------|-------|
50+
| Next/prev item | `Ctrl-j/k` or `j/k` (normal) | Insert mode uses Ctrl, normal mode uses plain |
51+
| Close | `Ctrl-c` or `Esc` or `q` (normal) | Three ways to exit |
52+
53+
**Why duplicates?** `Ctrl-j/k` work in insert mode without switching modes. In normal mode, plain `j/k` are more natural.
54+
55+
## Vim Defaults
56+
57+
| Action | Keys | Notes |
58+
|--------|------|-------|
59+
| Save and quit | `:wq` or `ZZ` | ZZ is faster |
60+
| Quit without save | `:q!` or `ZQ` | ZQ is faster |
61+
62+
**Why duplicates?** Both are vim defaults. ZZ/ZQ are faster but less discoverable.
63+
64+
## Summary of Duplicate Patterns
65+
66+
1. **Debug**: F-keys + Leader keys (muscle memory from IDEs + discoverability)
67+
2. **Splits/Tabs**: Single keys + Ctrl combos (efficiency + consistency)
68+
3. **Navigation**: Plain + Ctrl variants (context-dependent ergonomics)
69+
4. **Close/Exit**: Multiple keys (q, Esc, Ctrl-c, \\) (different mental models)
70+
71+
## Design Principles
72+
73+
1. **Never remove defaults** unless they conflict
74+
2. **Add consistent alternatives** that work across plugins
75+
3. **Document all options** so users can choose their preferred style
76+
4. **Optimize for discoverability** (leader keys show in which-key)
77+
5. **Respect muscle memory** (keep vim and IDE conventions)
78+
79+
## Quick Reference: Cross-Plugin Consistency
80+
81+
These keys work the same way in **both Telescope and Neo-tree**:
82+
83+
- `Ctrl-x` → Horizontal split
84+
- `Ctrl-v` → Vertical split
85+
- `Ctrl-t` → New tab
86+
- `Ctrl-j` → Next/down
87+
- `Ctrl-k` → Previous/up
88+
- `?` → Show help
89+
90+
This consistency means once you learn these in one plugin, they work the same everywhere.
File renamed without changes.

0 commit comments

Comments
 (0)