retrovim 0.0.3

package/nvim/plugins/mini.nvim/readmes/mini-jump2d.md

@@ -0,0 +1,197 @@
+<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-jump2d_readme.png?raw=true" alt="mini.jump2d" style="max-width:100%;border:solid 2px"/> </p>
+
+### Jump  within visible lines via iterative label filtering
+
+See more details in [Features](#features) and [Documentation](../doc/mini-jump2d.txt).
+
+---
+
+> [!NOTE]
+> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
+
+⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-jump2d) if you want to mention this module.
+
+⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
+
+⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
+
+⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
+
+---
+
+If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
+
+## Demo
+
+<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-jump2d.mp4 -->
+https://user-images.githubusercontent.com/24854248/227734716-e7b6f2a8-4db1-441d-9b37-873da6772138.mp4
+
+## Features
+
+- Make jump by iterative filtering of possible, equally considered jump spots until there is only one. Filtering is done by typing a label character that is visualized at jump spot.
+- Customizable:
+    - Way of computing possible jump spots with opinionated default.
+    - Characters used to label jump spots during iterative filtering.
+    - Visual effects: how many steps ahead to show; dim lines with spots.
+    - Action hooks to be executed at certain events during jump.
+    - Allowed windows: current and/or not current.
+    - Allowed lines: whether to process blank or folded lines, lines before/at/after cursor line, etc. Example: user can configure to look for spots only inside current window at or after cursor line.
+    Example: user can configure to look for word starts only inside current window at or after cursor line with 'j' and 'k' labels performing some action after jump.
+- Works in Visual and Operator-pending (with dot-repeat) modes.
+- Preconfigured ways of computing jump spots (see help for `MiniJump2d.builtin_opts()`):
+    - Starts of lines.
+    - Starts of words.
+    - Single character from user input.
+    - Variable length query from user input.
+- Works with multibyte characters.
+
+## Installation
+
+This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
+
+There are two branches to install from:
+
+- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
+- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
+
+Here are code snippets for some common installation methods (use only one):
+
+<details>
+<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+vim.pack.add({ 'https://github.com/nvim-mini/mini.jump2d' })
+```
+
+Stable branch:
+
+```lua
+vim.pack.add({
+  { src = 'https://github.com/nvim-mini/mini.jump2d', version = 'stable' },
+})
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
+
+**Full library**
+
+Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
+
+**Standalone plugin**:
+
+Main branch:
+
+```lua
+add('nvim-mini/mini.jump2d')
+```
+
+Stable branch:
+
+```lua
+add({ source = 'nvim-mini/mini.jump2d', checkout = 'stable' })
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+{ 'nvim-mini/mini.jump2d', version = false },
+```
+
+Stable branch:
+
+```lua
+{ 'nvim-mini/mini.jump2d', version = '*' },
+```
+
+</details>
+
+**Important**: don't forget to call `require('mini.jump2d').setup()` to enable its functionality.
+
+**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
+
+- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
+- Install plugin in other place with shorter path.
+
+## Default config
+
+```lua
+-- No need to copy this inside `setup()`. Will be used automatically.
+{
+  -- Function producing jump spots (byte indexed) for a particular line.
+  -- For more information see |MiniJump2d.start|.
+  -- If `nil` (default) - use |MiniJump2d.default_spotter|
+  spotter = nil,
+
+  -- Characters used for labels of jump spots (in supplied order)
+  labels = 'abcdefghijklmnopqrstuvwxyz',
+
+  -- Options for visual effects
+  view = {
+    -- Whether to dim lines with at least one jump spot
+    dim = false,
+
+    -- How many steps ahead to show. Set to big number to show all steps.
+    n_steps_ahead = 0,
+  },
+
+  -- Which lines are used for computing spots
+  allowed_lines = {
+    blank = true, -- Blank line (not sent to spotter even if `true`)
+    cursor_before = true, -- Lines before cursor line
+    cursor_at = true, -- Cursor line
+    cursor_after = true, -- Lines after cursor line
+    fold = true, -- Start of fold (not sent to spotter even if `true`)
+  },
+
+  -- Which windows from current tabpage are used for visible lines
+  allowed_windows = {
+    current = true,
+    not_current = true,
+  },
+
+  -- Functions to be executed at certain events
+  hooks = {
+    before_start = nil, -- Before jump start
+    after_jump = nil, -- After jump was actually done
+  },
+
+  -- Module mappings. Use `''` (empty string) to disable one.
+  mappings = {
+    start_jumping = '<CR>',
+  },
+
+  -- Whether to disable showing non-error feedback
+  -- This also affects (purely informational) helper messages shown after
+  -- idle time if user input is required.
+  silent = false,
+}
+```
+
+## Similar plugins
+
+- [phaazon/hop.nvim](https://github.com/phaazon/hop.nvim) (main inspiration behind this module)
+- [ggandor/lightspeed.nvim](https://github.com/ggandor/lightspeed.nvim)
+- [ggandor/leap.nvim](https://github.com/ggandor/leap.nvim)
+- [rlane/pounce.nvim](https://github.com/rlane/pounce.nvim)

package/nvim/plugins/mini.nvim/readmes/mini-keymap.md

@@ -0,0 +1,205 @@
+<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-keymap_readme.png?raw=true" alt="mini.keymap" style="max-width:100%;border:solid 2px"/> </p>
+
+### Special key mappings
+
+See more details in [Features](#features) and [Documentation](../doc/mini-keymap.txt).
+
+---
+
+> [!NOTE]
+> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
+
+⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-keymap) if you want to mention this module.
+
+⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
+
+⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
+
+⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
+
+---
+
+If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
+
+## Demo
+
+<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-keymap.mp4 -->
+https://github.com/user-attachments/assets/a3e34e9f-6901-4e57-a5bd-9508b2c6d065
+
+## Features
+
+- Map keys to perform configurable multi-step actions: if condition for step one is true - execute step one action, else check step two, and so on until falling back to executing original keys. This is usually referred to as "smart" keys (like "smart tab"). See `:h MiniKeymap.map_multistep()`.
+
+  There are many built-in steps targeted for Insert mode mappings of special keys like `<Tab>`, `<S-Tab>`, `<CR>`, and `<BS>`:
+  - Navigate and accept built-in Insert mode completion. Useful for [mini.completion](https://nvim-mini.org/mini.nvim/readmes/mini-completion).
+  - Navigate and expand [mini.snippets](https://nvim-mini.org/mini.nvim/readmes/mini-snippets).
+  - Execute `<CR>` and `<BS>` respecting [mini.pairs](https://nvim-mini.org/mini.nvim/readmes/mini-pairs).
+  - Jump before/after current tree-sitter node.
+  - Jump before opening and after closing characters (brackets and quotes).
+  - Increase/decrease indent when cursor is inside of it.
+  - Delete all whitespace to the left ("hungry backspace").
+  - Navigate built-in snippet engine (`:h vim.snippet`).
+  - Navigate and accept in [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp) completion.
+  - Navigate and accept in [Saghen/blink.cmp](https://github.com/Saghen/blink.cmp) completion.
+  - Navigate and expand [L3MON4D3/LuaSnip](https://github.com/L3MON4D3/LuaSnip) snippets.
+  - Execute `<CR>` and `<BS>` respecting [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs).
+
+- Map keys as "combo": each key acts immediately plus execute extra action if all are typed within configurable delay between each other. See `:h MiniKeymap.map_combo()`.
+
+  Some of the common use cases include:
+    - Map insertable keys (like "jk", "kj") in Insert and Command-line mode to exit into Normal mode.
+    - Fight against bad habits of pressing the same navigation key by showing a notification if there are too many of them pressed in a row.
+
+Sources with more details:
+
+- `:h MiniKeymap-examples`
+
+## Quickstart
+
+### Multi-step
+
+Setup that works well with 'mini.completion' and 'mini.pairs':
+
+```lua
+local map_multistep = require('mini.keymap').map_multistep
+
+map_multistep('i', '<Tab>',   { 'pmenu_next' })
+map_multistep('i', '<S-Tab>', { 'pmenu_prev' })
+map_multistep('i', '<CR>',    { 'pmenu_accept', 'minipairs_cr' })
+map_multistep('i', '<BS>',    { 'minipairs_bs' })
+```
+
+### Combos
+
+"Better escape" to Normal mode without having to reach for `<Esc>` key:
+
+```lua
+local map_combo = require('mini.keymap').map_combo
+
+-- Support most common modes. This can also contain 't', but would
+-- only mean to press `<Esc>` inside terminal.
+local mode = { 'i', 'c', 'x', 's' }
+map_combo(mode, 'jk', '<BS><BS><Esc>')
+
+-- To not have to worry about the order of keys, also map "kj"
+map_combo(mode, 'kj', '<BS><BS><Esc>')
+
+-- Escape into Normal mode from Terminal mode
+map_combo('t', 'jk', '<BS><BS><C-\\><C-n>')
+map_combo('t', 'kj', '<BS><BS><C-\\><C-n>')
+```
+
+Show notification if there is too much movement by repeating same key:
+
+```lua
+local notify_many_keys = function(key)
+  local lhs = string.rep(key, 5)
+  local action = function() vim.notify('Too many ' .. key) end
+  require('mini.keymap').map_combo({ 'n', 'x' }, lhs, action)
+end
+notify_many_keys('h')
+notify_many_keys('j')
+notify_many_keys('k')
+notify_many_keys('l')
+```
+
+## Installation
+
+This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
+
+There are two branches to install from:
+
+- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
+- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
+
+Here are code snippets for some common installation methods (use only one):
+
+<details>
+<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+vim.pack.add({ 'https://github.com/nvim-mini/mini.keymap' })
+```
+
+Stable branch:
+
+```lua
+vim.pack.add({
+  { src = 'https://github.com/nvim-mini/mini.keymap', version = 'stable' },
+})
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
+
+**Full library**
+
+Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
+
+**Standalone plugin**:
+
+Main branch:
+
+```lua
+add('nvim-mini/mini.keymap')
+```
+
+Stable branch:
+
+```lua
+add({ source = 'nvim-mini/mini.keymap', checkout = 'stable' })
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+{ 'nvim-mini/mini.keymap', version = false },
+```
+
+Stable branch:
+
+```lua
+{ 'nvim-mini/mini.keymap', version = '*' },
+```
+
+</details>
+
+**Important**: no need to call `require('mini.keymap').setup()`, but it can be done to improve usability.
+
+**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
+
+- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
+- Install plugin in other place with shorter path.
+
+## Default config
+
+```lua
+-- No need to copy this inside `setup()`. Will be used automatically.
+{}
+```
+
+## Similar plugins
+
+- [max397574/better-escape.nvim](https://github.com/max397574/better-escape.nvim)
+- [abecodes/tabout.nvim](https://github.com/abecodes/tabout.nvim)

package/nvim/plugins/mini.nvim/readmes/mini-map.md

@@ -0,0 +1,191 @@
+<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-map_readme.png?raw=true" alt="mini.map" style="max-width:100%;border:solid 2px"/> </p>
+
+### Window with buffer text overview, scrollbar, and highlights
+
+See more details in [Features](#features) and [Documentation](../doc/mini-map.txt).
+
+---
+
+> [!NOTE]
+> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
+
+⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-map) if you want to mention this module.
+
+⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
+
+⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
+
+⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
+
+---
+
+If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
+
+## Demo
+
+<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-map.mp4 -->
+https://user-images.githubusercontent.com/24854248/195806215-10e05020-50b7-4bee-9447-ee5af3e971ec.mp4
+
+## Features
+
+- Show and manage special floating window displaying automatically updated overview of current buffer text. Window takes up whole height of Neovim instance and is fixed to a left/right side. Map content is computed by taking all current lines, converting it to binary whitespace/non-whitespace mask, rescaling to appropriate dimensions, and converting back to strings consisting from special encoding symbols. All this is done very fast and asynchronously.
+
+    See `:h MiniMap.open()`, `:h MiniMap.refresh()`, `:h MiniMap.close()`, `:h MiniMap.toggle()`, `:h MiniMap.toggle_side()`.
+
+    For a general overview and tips, see `:h mini.map-usage`.
+
+- Show scrollbar next to map content. It represents current line and view (top and bottom visible lines). Can be the only thing shown, making map window a "pure scrollbar".
+
+- Highlight map lines representing certain data in current buffer. This is done via extensible set of callables, called integrations. There are pre-built generators for common integrations:
+    - Builtin search.
+    - Builtin diagnostic.
+    - General diff hunks provided by ['mini.diff'](https://nvim-mini.org/mini.nvim/readmes/mini-diff).
+    - Hunks provided by ['lewis6991/gitsigns.nvim'](https://github.com/lewis6991/gitsigns.nvim).
+    For more details see `:h MiniMap.gen_integration`.
+
+- Focus on map window to quickly browse current (source) buffer. Moving inside map window updates cursor position in source window enabling fast and targeted buffer exploration. To focus back, hit `<CR>` to accept current explored position or `<Esc>` to go back to original position. See `:h MiniMap.toggle_focus()`.
+
+- Customizable:
+    - Encoding symbols used to display binary information of different resolution (default is 3x2). There are pre-built generators for different basic character families and resolutions. See `:h MiniMap.gen_encode_symbols`.
+    - Scrollbar symbols, separate for line and view. Can have any width (even zero, which virtually disables scrollbar).
+    - Integrations producing map line highlights.
+    - Window options: side (left/right), width, 'winblend', and more.
+
+## Installation
+
+This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
+
+There are two branches to install from:
+
+- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
+- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
+
+Here are code snippets for some common installation methods (use only one):
+
+<details>
+<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+vim.pack.add({ 'https://github.com/nvim-mini/mini.map' })
+```
+
+Stable branch:
+
+```lua
+vim.pack.add({
+  { src = 'https://github.com/nvim-mini/mini.map', version = 'stable' },
+})
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
+
+**Full library**
+
+Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
+
+**Standalone plugin**:
+
+Main branch:
+
+```lua
+add('nvim-mini/mini.map')
+```
+
+Stable branch:
+
+```lua
+add({ source = 'nvim-mini/mini.map', checkout = 'stable' })
+```
+
+</details>
+
+<details>
+<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
+
+**Full library**
+
+Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
+
+**Standalone plugin**
+
+Main branch:
+
+```lua
+{ 'nvim-mini/mini.map', version = false },
+```
+
+Stable branch:
+
+```lua
+{ 'nvim-mini/mini.map', version = '*' },
+```
+
+</details>
+
+**Important**: don't forget to call `require('mini.map').setup()` to enable its functionality.
+
+**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
+
+- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
+- Install plugin in other place with shorter path.
+
+## Default config
+
+```lua
+-- No need to copy this inside `setup()`. Will be used automatically.
+{
+  -- Highlight integrations (none by default)
+  integrations = nil,
+
+  -- Symbols used to display data
+  symbols = {
+    -- Encode symbols. See `:h MiniMap.config` for specification and
+    -- `:h MiniMap.gen_encode_symbols` for pre-built ones.
+    -- Default: solid blocks with 3x2 resolution.
+    encode = nil,
+
+    -- Scrollbar parts for view and line. Use empty string to disable any.
+    scroll_line = '█',
+    scroll_view = '┃',
+  },
+
+  -- Window options
+  window = {
+    -- Whether window is focusable in normal way (with `wincmd` or mouse)
+    focusable = false,
+
+    -- Side to stick ('left' or 'right')
+    side = 'right',
+
+    -- Whether to show count of multiple integration highlights
+    show_integration_count = true,
+
+    -- Total width
+    width = 10,
+
+    -- Value of 'winblend' option
+    winblend = 25,
+
+    -- Z-index
+    zindex = 10,
+  },
+}
+```
+
+## Similar plugins
+
+- [wfxr/minimap.vim](https://github.com/wfxr/minimap.vim)
+- [dstein64/nvim-scrollview](https://github.com/dstein64/nvim-scrollview)
+- [petertriho/nvim-scrollbar](https://github.com/petertriho/nvim-scrollbar)
+- [lewis6991/satellite.nvim](https://github.com/lewis6991/satellite.nvim)