fix: docs (#20)

Author: RemoteRabbit

README.md

@@ -144,6 +144,9 @@ This configuration is released into the public domain under the [Unlicense](LICE
 
 
 
+
+
+
 
 
 

docs/KEYBINDINGS.md

@@ -1,188 +1,151 @@
-# Keybindings Documentation
+# Keybindings Reference
 
-This file is auto-generated by pre-commit hooks. Do not edit manually.
+*Auto-generated from configuration files*
 
-## Plugin Keybindings
+## Normal Mode
 
-- Add if err
-- Add JSON tags
-- Add YAML tags
-- Build task
-- Change word
-- Checkout PR
-- Clear cache
-- Close all folds
-- Close diffview
-- Close folds with
-- Close Tab
-- Continue/Start Debugging
-- Coverage browser
-- Coverage summary
-- Create Draft PR
-- Create PR with Template
-- Current file history
-- Decrement number
-- Delete buffers to the left
-- Delete buffers to the right
-- Delete non-pinned buffers
-- Delete other buffers
-- Delete window
-- Diagnostics (Trouble)
-- Exit insert mode with jk
-- File history
-- Fill struct
-- Find DB buffer
-- First Tab
-- Fork Repo
-- Hide coverage
-- Increment number
-- Inspect REST request
-- JQ query
-- JQ query list
-- Last query info
-- Last Tab
-- Lazy
-- LazyGit
-- List Issues
-- List Repos
-- Load coverage
-- Location List (Trouble)
-- LSP Rename
-lua/config/keymaps.lua:18:keymap.set("n", "x", '"_x')
-lua/plugins/gitlab.lua:104:    vim.keymap.set("n", "<leader>gPg", function()
-lua/plugins/gitlab.lua:123:    vim.keymap.set("n", "<leader>gPl", function()
-lua/plugins/gitlab.lua:131:    vim.keymap.set("n", "<leader>gPo", function()
-lua/plugins/gitlab.lua:139:    vim.keymap.set("n", "<leader>gPs", function()
-lua/plugins/gitlab.lua:147:    vim.keymap.set("n", "<leader>gPc", function()
-lua/plugins/gitlab.lua:156:    vim.keymap.set("n", "<leader>gPv", function()
-lua/plugins/gitlab.lua:164:    vim.keymap.set("n", "<leader>gPR", function()
-lua/plugins/gitlab.lua:172:    vim.keymap.set("n", "<leader>gPa", function()
-lua/plugins/gitlab.lua:180:    vim.keymap.set("n", "<leader>gPx", function()
-lua/plugins/gitlab.lua:188:    vim.keymap.set("n", "<leader>gPf", function()
-lua/plugins/gitlab.lua:197:    vim.keymap.set("n", "<leader>gPm", function()
-lua/plugins/gitlab.lua:207:    vim.keymap.set("n", "<leader>gIl", function()
-lua/plugins/gitlab.lua:216:    vim.keymap.set("n", "<leader>gIn", function()
-lua/plugins/gitlab.lua:227:    vim.keymap.set("n", "<leader>gRb", function()
-lua/plugins/gitlab.lua:238:    vim.keymap.set("n", "<leader>gPp", function()
-lua/plugins/gitlab.lua:243:    vim.keymap.set("n", "<leader>gPu", function()
-lua/plugins/gitlab.lua:248:    vim.keymap.set("n", "<leader>gPd", function()
-lua/plugins/gitlab.lua:253:    vim.keymap.set("n", "<leader>gPb", function()
-lua/plugins/gitlab.lua:69:    vim.keymap.set("n", "<leader>gPr", function()
-lua/plugins/harpoon.lua:12:    vim.keymap.set("n", "<leader>he", function()
-lua/plugins/harpoon.lua:16:    vim.keymap.set("n", "<leader>h1", function()
-lua/plugins/harpoon.lua:19:    vim.keymap.set("n", "<leader>h2", function()
-lua/plugins/harpoon.lua:22:    vim.keymap.set("n", "<leader>h3", function()
-lua/plugins/harpoon.lua:25:    vim.keymap.set("n", "<leader>h4", function()
-lua/plugins/harpoon.lua:29:    vim.keymap.set("n", "<C-S-P>", function()
-lua/plugins/harpoon.lua:32:    vim.keymap.set("n", "<C-S-N>", function()
-lua/plugins/harpoon.lua:9:    vim.keymap.set("n", "<leader>ha", function()
-lua/plugins/kulala.lua:15:      vim.keymap.set(
-lua/plugins/lspconfig.lua:80:          vim.keymap.set(mode, lhs, rhs, opts)
-lua/plugins/luasnip.lua:163:    vim.keymap.set({ "i" }, "<C-K>", function()
-lua/plugins/luasnip.lua:166:    vim.keymap.set({ "i", "s" }, "<C-L>", function()
-lua/plugins/luasnip.lua:169:    vim.keymap.set({ "i", "s" }, "<C-J>", function()
-lua/plugins/luasnip.lua:172:    vim.keymap.set({ "i", "s" }, "<C-E>", function()
-lua/plugins/mason-lspconfig.lua:37:              vim.keymap.set("n", "<leader>co", function()
-lua/plugins/mason-lspconfig.lua:82:              vim.keymap.set("n", "<leader>tV", function()
-lua/plugins/neotest.lua:146:    vim.keymap.set("n", "<leader>tn", function()
-lua/plugins/neotest.lua:149:    vim.keymap.set("n", "<leader>tF", function()
-lua/plugins/neotest.lua:152:    vim.keymap.set("n", "<leader>ta", function()
-lua/plugins/neotest.lua:155:    vim.keymap.set("n", "<leader>ts", function()
-lua/plugins/neotest.lua:158:    vim.keymap.set("n", "<leader>to", function()
-lua/plugins/neotest.lua:161:    vim.keymap.set("n", "<leader>tO", function()
-lua/plugins/neotest.lua:164:    vim.keymap.set("n", "<leader>tw", function()
-lua/plugins/neotest.lua:167:    vim.keymap.set("n", "<leader>td", function()
-lua/plugins/neovim-tips.lua:12:    local map = vim.keymap.set
-lua/plugins/nvim-dap-python.lua:37:      vim.keymap.set("n", "<leader>dpr", function()
-lua/plugins/nvim-lint.lua:28:      vim.keymap.set("n", "<leader>cl", function()
-lua/plugins/nvim-ufo.lua:39:    vim.keymap.set("n", "K", function()
-lua/plugins/octo.lua:665:    vim.keymap.set("n", "<leader>gPm", function()
-lua/plugins/octo.lua:726:    vim.keymap.set("n", "<leader>gPg", function()
-lua/plugins/package-info.lua:25:      vim.keymap.set(
-lua/plugins/package-info.lua:31:      vim.keymap.set(
-lua/plugins/package-info.lua:37:      vim.keymap.set(
-lua/plugins/package-info.lua:43:      vim.keymap.set(
-lua/plugins/package-info.lua:49:      vim.keymap.set(
-lua/plugins/package-info.lua:55:      vim.keymap.set(
-lua/plugins/package-info.lua:61:      vim.keymap.set(
-lua/plugins/refactoring.lua:111:    vim.keymap.set({ "n", "x" }, "<leader>rt", function()
-lua/plugins/smart-splits.lua:37:      vim.keymap.set("n", "<C-h>", require("smart-splits").move_cursor_left)
-lua/plugins/smart-splits.lua:38:      vim.keymap.set("n", "<C-j>", require("smart-splits").move_cursor_down)
-lua/plugins/smart-splits.lua:39:      vim.keymap.set("n", "<C-k>", require("smart-splits").move_cursor_up)
-lua/plugins/smart-splits.lua:40:      vim.keymap.set("n", "<C-l>", require("smart-splits").move_cursor_right)
-lua/plugins/smart-splits.lua:43:      vim.keymap.set("n", "<C-Up>", require("smart-splits").resize_up)
-lua/plugins/smart-splits.lua:44:      vim.keymap.set("n", "<C-Down>", require("smart-splits").resize_down)
-lua/plugins/smart-splits.lua:45:      vim.keymap.set("n", "<C-Left>", require("smart-splits").resize_left)
-lua/plugins/smart-splits.lua:46:      vim.keymap.set("n", "<C-Right>", require("smart-splits").resize_right)
-lua/plugins/smart-splits.lua:49:      vim.keymap.set("n", "<leader><leader>h", require("smart-splits").swap_buf_left)
-lua/plugins/smart-splits.lua:50:      vim.keymap.set("n", "<leader><leader>j", require("smart-splits").swap_buf_down)
-lua/plugins/smart-splits.lua:51:      vim.keymap.set("n", "<leader><leader>k", require("smart-splits").swap_buf_up)
-lua/plugins/smart-splits.lua:52:      vim.keymap.set("n", "<leader><leader>l", require("smart-splits").swap_buf_right)
-lua/plugins/telescope.lua:34:    vim.keymap.set("n", "<leader>ff", function()
-lua/plugins/telescope.lua:37:    vim.keymap.set("n", "<leader>fg", function()
-lua/plugins/telescope.lua:40:    vim.keymap.set("n", "<leader>fb", function()
-lua/plugins/telescope.lua:43:    vim.keymap.set("n", "<leader>fh", function()
-lua/plugins/telescope.lua:46:    vim.keymap.set("n", "<leader>fr", function()
-lua/plugins/telescope.lua:49:    vim.keymap.set("n", "<leader>fc", function()
-lua/plugins/telescope.lua:52:    vim.keymap.set("n", "<leader>fs", function()
-lua/plugins/telescope.lua:55:    vim.keymap.set("n", "<leader>fS", function()
-lua/plugins/terraform-local-modules.lua:238:        vim.keymap.set("n", "<leader>tm", function()
-lua/plugins/trouble.lua:59:      vim.keymap.set(
-lua/plugins/trouble.lua:66:      vim.keymap.set(
-lua/plugins/vim-illuminate.lua:31:      vim.keymap.set("n", "<A-n>", function()
-lua/plugins/vim-illuminate.lua:34:      vim.keymap.set("n", "<A-p>", function()
-- Mason
-- New Issue
-- New Tab
-- Next buffer
-- Next symbol
-- Next symbol (up level)
-- Next Tab
-- Open all folds
-- Open diffview
-- Open folds except kinds
-- Open Issue
-- Open Repo in Browser
-- Other window
-- Pin buffer
-- Prev buffer
-- Preview REST request
-- Previous symbol
-- Previous symbol (up level)
-- Previous Tab
-- Quick action
-- Quickfix List (Trouble)
-- Realign Table
-- Remove tags
-- Rename DB buffer
-- Run Last
-- Run REST request
-- Run task
-- Run tfsec Terraform scan
-- Run trivy security scan
-- Screenshot code
-- [S]earch [E]moji
-- Search Issues
-- Select cached environment
-- Select Python environment
-- Show coverage
-- Split window below
-- Split window right
-- Step Into
-- Step Out
-- Step Over
-- Symbols (Trouble)
-- Terminate
-- Test coverage
-- Toggle Breakpoint
-- Toggle coverage
-- Toggle DAP UI
-- Toggle DBUI
-- Toggle Markdown Rendering
-- Toggle Outline
-- Toggle Outline Navigation
-- Toggle profiling
-- Toggle REPL
-- Toggle Table Mode
-- Toggle task list
-- Toggle Undotree
+| Key | Description | Source |
+|-----|-------------|--------|
+| `<A-n>` | Next reference | vim-illuminate |
+| `<A-p>` | Previous reference | vim-illuminate |
+| `<C-S-N>` | Harpoon next | harpoon |
+| `<C-S-P>` | Harpoon prev | harpoon |
+| `<S-h>` | Prev buffer | bufferline |
+| `<S-l>` | Next buffer | bufferline |
+| `<leader>Df` | Find DB buffer | vim-dadbod-ui |
+| `<leader>Dq` | Last query info | vim-dadbod-ui |
+| `<leader>Dr` | Rename DB buffer | vim-dadbod-ui |
+| `<leader>Du` | Toggle DBUI | vim-dadbod-ui |
+| `<leader>Gcb` | Coverage browser | go-nvim |
+| `<leader>Gcc` | Toggle coverage | go-nvim |
+| `<leader>Gch` | Test coverage | go-nvim |
+| `<leader>Gse` | Add if err | go-nvim |
+| `<leader>Gsf` | Fill struct | go-nvim |
+| `<leader>Gsj` | Add JSON tags | go-nvim |
+| `<leader>Gsr` | Remove tags | go-nvim |
+| `<leader>Gsy` | Add YAML tags | go-nvim |
+| `<leader>O` | Toggle Outline Navigation | aerial |
+| `<leader>Ri` | Inspect REST request | kulala |
+| `<leader>Rl` | Replay last REST request | kulala |
+| `<leader>Rp` | Preview REST request | kulala |
+| `<leader>Rr` | Run REST request | kulala |
+| `<leader>U` | Toggle Undotree | undotree |
+| `<leader>bP` | Delete non-pinned buffers | bufferline |
+| `<leader>bl` | Delete buffers to the left | bufferline |
+| `<leader>bo` | Delete other buffers | bufferline |
+| `<leader>bp` | Pin buffer | bufferline |
+| `<leader>br` | Delete buffers to the right | bufferline |
+| `<leader>cl` | Run linting | nvim-lint |
+| `<leader>coh` | Hide coverage | nvim-coverage |
+| `<leader>col` | Load coverage | nvim-coverage |
+| `<leader>cos` | Coverage summary | nvim-coverage |
+| `<leader>cot` | Toggle coverage | nvim-coverage |
+| `<leader>cov` | Show coverage | nvim-coverage |
+| `<leader>dO` | Step Out | nvim-dap |
+| `<leader>db` | Toggle Breakpoint | nvim-dap |
+| `<leader>dc` | Continue/Start Debugging | nvim-dap |
+| `<leader>di` | Step Into | nvim-dap |
+| `<leader>dl` | Run Last | nvim-dap |
+| `<leader>do` | Step Over | nvim-dap |
+| `<leader>dpr` | Debug Python test method | nvim-dap-python |
+| `<leader>dr` | Toggle REPL | nvim-dap |
+| `<leader>dt` | Terminate | nvim-dap |
+| `<leader>du` | Toggle DAP UI | nvim-dap |
+| `<leader>fS` | Workspace Symbols | telescope |
+| `<leader>fr` | Recent Files | telescope |
+| `<leader>fs` | Document Symbols | telescope |
+| `<leader>gCo` | Checkout PR | octo |
+| `<leader>gD` | Close diffview | diffview |
+| `<leader>gH` | Current file history | diffview |
+| `<leader>gIl` | List Issues | octo |
+| `<leader>gIl` | List Issues (Browser) | gitlab |
+| `<leader>gIn` | New Issue | octo |
+| `<leader>gIn` | New Issue (Browser) | gitlab |
+| `<leader>gIo` | Open Issue | octo |
+| `<leader>gIs` | Search Issues | octo |
+| `<leader>gPR` | Resume Review | gitlab |
+| `<leader>gPa` | Approve PR/MR | gitlab |
+| `<leader>gPb` | Open in Browser | gitlab |
+| `<leader>gPc` | Checkout PR/MR | gitlab |
+| `<leader>gPd` | Create Draft PR | octo |
+| `<leader>gPd` | Toggle Discussions | gitlab |
+| `<leader>gPf` | View PR/MR Files | gitlab |
+| `<leader>gPl` | List PRs/MRs | gitlab |
+| `<leader>gPm` | Smart PR Creation with Conventional Commits | octo |
+| `<leader>gPm` | Merge PR/MR | gitlab |
+| `<leader>gPo` | Open Current PR/MR | gitlab |
+| `<leader>gPp` | View Pipeline | gitlab |
+| `<leader>gPs` | Search PRs/MRs | gitlab |
+| `<leader>gPt` | Create PR with Template | octo |
+| `<leader>gPu` | Upload File | gitlab |
+| `<leader>gPv` | Start Review | gitlab |
+| `<leader>gPx` | Request Changes/Revoke | gitlab |
+| `<leader>gRb` | Open Repo in Browser | octo |
+| `<leader>gRb` | Open Repo in Browser | gitlab |
+| `<leader>gRf` | Fork Repo | octo |
+| `<leader>gRl` | List Repos | octo |
+| `<leader>gd` | Open diffview | diffview |
+| `<leader>gh` | File history | diffview |
+| `<leader>h1` | Harpoon 1 | harpoon |
+| `<leader>h2` | Harpoon 2 | harpoon |
+| `<leader>h3` | Harpoon 3 | harpoon |
+| `<leader>h4` | Harpoon 4 | harpoon |
+| `<leader>ha` | Add to harpoon | harpoon |
+| `<leader>he` | Harpoon menu | harpoon |
+| `<leader>jf` | JQ query | nvim-jqx |
+| `<leader>jq` | JQ query list | nvim-jqx |
+| `<leader>ma` | Realign Table | vim-table-mode |
+| `<leader>mr` | Toggle Markdown Rendering | render-markdown |
+| `<leader>mt` | Toggle Table Mode | vim-table-mode |
+| `<leader>nc` | Hide dependency versions | package-info |
+| `<leader>nd` | Delete dependency on line | package-info |
+| `<leader>ni` | Install new dependency | package-info |
+| `<leader>np` | Change dependency version | package-info |
+| `<leader>ns` | Show dependency versions | package-info |
+| `<leader>nt` | Toggle dependency versions | package-info |
+| `<leader>nu` | Update dependency on line | package-info |
+| `<leader>o` | Toggle Outline | aerial |
+| `<leader>o` | Toggle Outline | outline-nvim |
+| `<leader>pp` | Toggle profiling | profile |
+| `<leader>ra` | Quick action | overseer |
+| `<leader>rb` | Build task | overseer |
+| `<leader>rc` | Clear cache | overseer |
+| `<leader>rn` | LSP Rename | refactoring |
+| `<leader>rr` | Run task | overseer |
+| `<leader>rsf` | Run tfsec Terraform scan | overseer |
+| `<leader>rst` | Run trivy security scan | overseer |
+| `<leader>rt` | Toggle task list | overseer |
+| `<leader>sc` | Screenshot code | nvim-silicon |
+| `<leader>se` | [S]earch [E]moji | emoji |
+| `<leader>tF` | Run tests in file | neotest |
+| `<leader>tO` | Toggle test output panel | neotest |
+| `<leader>tV` | Show Module Info | mason-lspconfig |
+| `<leader>ta` | Run all tests | neotest |
+| `<leader>tn` | Run nearest test | neotest |
+| `<leader>ts` | Toggle test summary | neotest |
+| `<leader>tw` | Watch tests | neotest |
+| `<leader>vc` | Select cached environment | venv-selector |
+| `<leader>vs` | Select Python environment | venv-selector |
+| `<leader>xL` | Location List (Trouble) | trouble |
+| `<leader>xQ` | Quickfix List (Trouble) | trouble |
+| `<leader>xX` | Buffer Diagnostics (Trouble) | trouble |
+| `<leader>xl` | LSP Definitions / references / ... (Trouble) | trouble |
+| `<leader>xs` | Symbols (Trouble) | trouble |
+| `<leader>xx` | Diagnostics (Trouble) | trouble |
+| `K` | Peek fold or hover | nvim-ufo |
+| `[[` | Previous symbol | aerial |
+| `[[` | Previous symbol (up level) | aerial |
+| `[b` | Prev buffer | bufferline |
+| `]]` | Next symbol | aerial |
+| `]]` | Next symbol (up level) | aerial |
+| `]b` | Next buffer | bufferline |
+| `zM` | Close all folds | nvim-ufo |
+| `zR` | Open all folds | nvim-ufo |
+| `zm` | Close folds with | nvim-ufo |
+| `zr` | Open folds except kinds | nvim-ufo |
+
+## Visual Mode
+
+| Key | Description | Source |
+|-----|-------------|--------|
+| `<leader>sc` | Screenshot code | nvim-silicon |