https://github.com/echasnovski/mini.map

Neovim Lua plugin to manage window with buffer text overview. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.map

lua mini-nvim neovim neovim-plugin

Last synced: about 2 months ago
JSON representation

Neovim Lua plugin to manage window with buffer text overview. Part of 'mini.nvim' library.

• Host: GitHub
• URL: https://github.com/echasnovski/mini.map
• Owner: echasnovski
• License: mit
• Created: 2022-10-24T16:24:10.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-23T13:38:42.000Z (3 months ago)
• Last Synced: 2024-06-24T01:42:00.928Z (3 months ago)
• Topics: lua, mini-nvim, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 52.7 KB
• Stars: 75
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![GitHub license](https://badgen.net/github/license/echasnovski/mini.nvim)](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)

### Window with buffer text overview, scrollbar, and highlights

See more details in [Features](#features) and [help file](doc/mini-map.txt).

---

⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/README.md) if you want to mention this module.

⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.

⦿ See the repository page to learn about common design principles and configuration recipes.

---

If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.

## Demo

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://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-diff.md).

    - 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 `` to accept current explored position or `` 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):

With mini.deps

    

        

            Github repo

            Branch Code snippet

        

    

    

        

            'mini.nvim' library Main Follow recommended 'mini.deps' installation

        

        

            Stable

        

        

            Standalone plugin Main add('echasnovski/mini.map')

        

        

            Stable add({ source = 'echasnovski/mini.map', checkout = 'stable' })

        

    

With folke/lazy.nvim

    

        

            Github repo

            Branch Code snippet

        

    

    

        

            'mini.nvim' library

            Main { 'echasnovski/mini.nvim', version = false },

        

        

            Stable { 'echasnovski/mini.nvim', version = '*' },

        

        

            Standalone plugin

            Main { 'echasnovski/mini.map', version = false },

        

        

            Stable { 'echasnovski/mini.map', version = '*' },

        

    

With junegunn/vim-plug

    

        

            Github repo

            Branch Code snippet

        

    

    

        

            'mini.nvim' library

            Main Plug 'echasnovski/mini.nvim'

        

        

            Stable Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }

        

        

            Standalone plugin Main Plug 'echasnovski/mini.map'

        

        

            Stable Plug 'echasnovski/mini.map', { 'branch': 'stable' }

        

    




**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 : 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)