CarGDev/lua-nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Update documentation

Browse Source 
- Moved docs to docs/ - All documentation files moved:
  - docs/KEYMAPS.md - Complete keybinding reference(rewritten)
  - docs/PLUGINS.md - Plugin list
  - docs/NATIVE_AUTO_WRAPPER_GUIDE.md - Text wrapping guide
  - docs/TELESCOPE_TO_SNACKS_MIGRATION.md - Migration notes
  - docs/keyboard_mappings.md - QMK keyboard layout
  - docs/CHANGELOG_OLD.md - Previous changelog archived
- Rewrote docs/KEYMAPS.md - Based on the actual current keymap files. Removed references to deleted plugins (flash, harpoon, dial, screenkey, persistence, LSPSaga). Updated LSP keymaps to reflect fzf-lua, DAP keymaps to reflect plugin-side registration, and added CopilotChat and g keymaps.
- Updated README.md - Fixed all doc links to docs/, removed harpoon/flash/dial/screenkey/persistence references, updated essential keymaps to current reality (fzf-lua for LSP, Snacks for navigation, <leader>dcr for debug, <leader>jd for dynamic attach), added Bun debug support mention.
- Created CHANGELOG.md at root with:
  - 2026-02-10: Documentation restructure
  - 2026-02-08: hlchunk, lspconfig, lualine, ufo fixes
  - 2026-02-05: Major cleanup - 15+ plugins removed, core refactors, keymap rework, DAP/Copilot reorganization, fzf-lua migration for LSP
  - 2026-01-13/15: Bug fixes and version bumps
  - 2026-01-10: Previous changelog entries preserved
This commit is contained in:
Carlos
2026-02-10 12:49:09 -05:00
parent 1cb298b5d5
commit 2bf56c05dc
10 changed files with 964 additions and 986 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
README.md
View File

@@ -20,15 +20,17 @@ A modern, feature-rich Neovim configuration with 80+ plugins, optimized for full
## Features
- **VS Code-like UI** with file explorer on right, breadcrumbs, symbol outline
- **VS Code-like UI** with file explorer, breadcrumbs, symbol outline
- **80+ plugins** carefully configured and optimized
- **Full LSP support** for TypeScript, Python, Java, Go, Lua, and more
- **Debugging** with DAP for Node.js/NestJS, Python, Java
- **Debugging** with DAP for Node.js/NestJS, Python, Java, Bun
- **Git integration** with LazyGit, Neogit, Diffview, Octo (GitHub PRs)
- **AI assistance** with GitHub Copilot
- **AI assistance** with GitHub Copilot + CopilotChat
- **HTTP client** for API testing
- **Task runner** for build/run tasks
- **Multi-cursor** editing like VS Code
- **Snacks.nvim** for modern file navigation and pickers
- **fzf-lua** for LSP navigation
## Requirements
@@ -59,9 +61,12 @@ nvim
| Document | Description |
|----------|-------------|
| [KEYMAPS.md](./KEYMAPS.md) | **Complete keybinding reference** |
| [PLUGINS.md](./PLUGINS.md) | All plugins and their purposes |
| [CHANGELOG.md](./CHANGELOG.md) | Version history |
| [KEYMAPS.md](./docs/KEYMAPS.md) | **Complete keybinding reference** |
| [PLUGINS.md](./docs/PLUGINS.md) | All plugins and their purposes |
| [CHANGELOG.md](./CHANGELOG.md) | Version history and recent changes |
| [Native Auto Wrapper](./docs/NATIVE_AUTO_WRAPPER_GUIDE.md) | Text wrapping configuration |
| [Snacks Migration](./docs/TELESCOPE_TO_SNACKS_MIGRATION.md) | Telescope to Snacks migration notes |
| [Keyboard Mappings](./docs/keyboard_mappings.md) | QMK keyboard layout reference |
## Quick Start
@@ -71,65 +76,48 @@ nvim
| Key | Action |
|-----|--------|
| `<leader>ff` | Find files |
| `<leader>ff` | Find files (Snacks picker) |
| `<leader>fs` | Search text in project |
| `<leader>e` | Toggle file explorer (right side) |
| `<leader>e` | Toggle file explorer |
| `<leader>gg` | Open LazyGit |
| `s` | Flash jump (type chars to jump) |
| `<leader>ha` | Harpoon add file |
| `<leader>1-5` | Jump to harpooned file |
| `K` | Hover documentation |
| `gd` | Go to definition |
| `<leader>ca` | Code actions |
| `<leader>rn` | Rename symbol (live preview) |
| `K` | Peek fold or hover documentation |
| `gd` | Go to definition (fzf-lua) |
| `<leader>ca` | Code actions (fzf-lua) |
| `<leader>rn` | Rename symbol |
| `<C-d>` | Multi-cursor (select word) |
### Navigation
| Key | Action |
|-----|--------|
| `s` | Flash jump anywhere |
| `S` | Flash treesitter select |
| `<leader>nb` | Navbuddy (code structure popup) |
| `<leader>cs` | Symbol outline sidebar |
| `<leader>tu` | Undo tree |
| `<leader>ff` | Find files (Snacks) |
| `<leader>fs` | Live grep (Snacks) |
| `<leader>fr` | Recent files (Snacks) |
| `<leader>fb` | Find buffers (Snacks) |
| `<leader>fk` | Find keymaps (Snacks) |
### Git
| Key | Action |
|-----|--------|
| `<leader>gg` | LazyGit |
| `<leader>gn` | Neogit (magit-like) |
| `<leader>gd` | Diffview |
| `<leader>gh` | File history |
| `<leader>gB` | Toggle git blame |
| `<leader>oi` | GitHub issues (Octo) |
| `<leader>op` | GitHub PRs (Octo) |
### Editing
| Key | Action |
|-----|--------|
| `<C-d>` | Add cursor on word (VS Code style) |
| `<C-a>` / `<C-x>` | Smart increment/decrement |
| `<leader>tj` | Toggle split/join code blocks |
| `<leader>sr` | Search & replace (project-wide) |
| `<leader>sR` | Structural search/replace |
| `<leader>yh` | Yank history |
| `<C-p>` / `<C-n>` | Cycle yank history |
| `<leader>gs` | Git status |
| `]h` / `[h` | Next/prev hunk |
| `<leader>hs` | Stage hunk |
| `<leader>hb` | Blame line |
| `<leader>hd` | Diff this |
### LSP
| Key | Action |
|-----|--------|
| `K` | Hover documentation |
| `gd` | Peek definition |
| `gD` | Go to definition |
| `gr` | Rename |
| `gh` | LSP finder (refs, implementations) |
| `H` | Hover documentation |
| `gd` | Go to definition |
| `gi` | Go to implementation |
| `gr` | Show references |
| `<leader>ca` | Code actions |
| `<leader>rn` | Rename (live preview) |
| `<leader>sl` | Line diagnostics |
| `<leader>rn` | Rename |
| `<leader>dd` | Line diagnostics |
| `[d` / `]d` | Prev/next diagnostic |
### Debugging
@@ -137,11 +125,31 @@ nvim
| Key | Action |
|-----|--------|
| `<leader>db` | Toggle breakpoint |
| `<leader>dcc` | Start/continue debugging |
| `<leader>dcr` | Start/continue debugging |
| `<leader>di` | Step into |
| `<leader>do` | Step over |
| `<leader>dO` | Step out |
| `<leader>dot` | Step out |
| `<leader>du` | Toggle DAP UI |
| `<leader>jd` | Dynamic debug attach |
### Copilot & AI
| Key | Action |
|-----|--------|
| `<leader>cc` | Toggle CopilotChat |
| `<leader>ce` | Explain code |
| `<leader>cr` | Review code |
| `<leader>cf` | Fix code |
| `<leader>ct` | Generate tests |
### Editing
| Key | Action |
|-----|--------|
| `<C-d>` | Add cursor on word (VS Code style) |
| `<leader>/` | Toggle comment |
| `<leader>sub` | Substitute with motion |
| `<leader>mm` | Format with conform |
### Tasks & HTTP
@@ -152,45 +160,20 @@ nvim
| `<leader>kr` | Run HTTP request (in .http file) |
| `<leader>ka` | Run all HTTP requests |
### Productivity
| Key | Action |
|-----|--------|
| `<leader>zz` | Zen mode |
| `<leader>zt` | Twilight (dim inactive code) |
| `<leader>qs` | Restore session |
| `<leader>ht` | Toggle Hardtime (learn vim motions) |
| `<leader>vp` | Toggle Precognition (motion hints) |
| `<leader>sk` | Toggle Screenkey (show keypresses) |
### Python
### Language-Specific
| Key | Action |
|-----|--------|
| `<leader>vs` | Select Python venv |
| Debug configs | Django, FastAPI, Flask, Launch file |
### JavaScript/TypeScript
| Key | Action |
|-----|--------|
| `<leader>ns` | Show package versions (package.json) |
| `<leader>nu` | Update package |
| Debug configs | NestJS, ts-node, Attach |
### Rust
| Key | Action |
|-----|--------|
| `<leader>cv` | Show crate versions (Cargo.toml) |
| `<leader>cu` | Update crate |
## Plugin Categories
### Navigation & Search
- **telescope** - Fuzzy finder
- **flash.nvim** - Jump anywhere with minimal keystrokes
- **harpoon** - Quick file marks
- **snacks.nvim** - Modern file navigation, pickers, dashboard
- **telescope** - Fuzzy finder (git features, TODOs)
- **fzf-lua** - LSP navigation pickers
- **portal.nvim** - Jump through jumplist with preview
- **nvim-navbuddy** - Code structure navigation
@@ -198,14 +181,14 @@ nvim
- **lazygit** - Terminal UI for git
- **neogit** - Magit-like git interface
- **diffview** - Side-by-side diffs
- **gitsigns** - Git decorations
- **gitsigns** - Git decorations and hunk actions
- **git-blame** - Inline blame
- **octo.nvim** - GitHub issues/PRs
### LSP & Coding
- **nvim-lspconfig** + **mason** - LSP setup
- **lspsaga** - Pretty LSP UI
- **nvim-cmp** - Completion
- **nvim-cmp** - Completion (with Copilot source)
- **treesitter** - Syntax highlighting
- **outline.nvim** - Symbol sidebar
- **inc-rename** - Live rename preview
@@ -215,7 +198,6 @@ nvim
- **vim-visual-multi** - Multi-cursor
- **yanky.nvim** - Yank ring
- **treesj** - Split/join blocks
- **dial.nvim** - Smart increment
- **nvim-surround** - Surround text
- **nvim-autopairs** - Auto brackets
- **Comment.nvim** - Commenting
@@ -223,7 +205,7 @@ nvim
### UI
- **snacks.nvim** - Dashboard, notifier, picker
- **noice.nvim** - UI for messages, cmdline
- **lualine** - Statusline
- **lualine** - Statusline (with word count)
- **bufferline** - Buffer tabs
- **dropbar** - Breadcrumbs
- **satellite** - Scrollbar with markers
@@ -240,13 +222,11 @@ nvim
- **overseer** - Task runner
- **kulala** - HTTP client
- **zen-mode** - Distraction-free
- **persistence** - Session management
- **grug-far** - Search & replace
- **ssr.nvim** - Structural search/replace
### Eye Candy
- **cargdev-cyberpunk** - Custom theme
- **mini.animate** - Smooth animations
- **reactive** - Mode-based colors
- **hlchunk** - Scope highlighting
- **nvim-highlight-colors** - Color preview
@@ -266,7 +246,8 @@ nvim
| `:OverseerRun` | Run tasks |
| `:ZenMode` | Distraction-free mode |
| `:Hardtime toggle` | Toggle vim training |
| `:Screenkey` | Show keypresses |
| `:WordCount` | Show word count (excluding symbols) |
| `:RunProject` | Run project command |
## Debugging Setup
@@ -276,17 +257,17 @@ nvim
```
Configs: Launch File, Django, FastAPI, Flask, Attach Remote
### Node.js / TypeScript / NestJS
### Node.js / TypeScript / NestJS / Bun
```bash
:Mason # Install js-debug-adapter
```
Configs: Launch NestJS, Launch File, ts-node, Attach
Configs: Launch NestJS, Launch File, ts-node, Bun Launch, Dynamic Attach
### Java
```bash
:Mason # Install java-debug-adapter, java-test
```
Auto-configured via nvim-jdtls
Auto-configured via nvim-jdtls (JDK 25, mac_arm)
## HTTP Client (Kulala)
@@ -313,15 +294,9 @@ Use `<leader>kr` to run request under cursor.
### Learn Vim Motions
Enable Hardtime (`<leader>ht`) and Precognition (`<leader>vp`) to improve your vim skills.
### Quick File Switching
Use Harpoon to mark important files (`<leader>ha`), then jump instantly with `<leader>1-5`.
### Multi-Cursor Editing
Like VS Code: `<C-d>` to select word, keep pressing for more occurrences.
### Smart Increment
`<C-a>` on `true` → `false`, on `GET` → `POST`, on dates, colors, etc.
### Split/Join Code
`<leader>tj` on arrays, objects, function arguments to toggle between single/multi-line.