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

Extra 'mini.nvim' functionality. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.extra

lua mini-nvim neovim neovim-plugin

Last synced: 3 days ago
JSON representation

Extra 'mini.nvim' functionality. Part of 'mini.nvim' library.

• Host: GitHub
• URL: https://github.com/echasnovski/mini.extra
• Owner: echasnovski
• License: mit
• Created: 2023-11-02T10:04:43.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T10:04:43.000Z (11 days ago)
• Last Synced: 2024-11-08T11:19:02.169Z (11 days ago)
• Topics: lua, mini-nvim, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 73.2 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• 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)

### Extra 'mini.nvim' functionality

See more details in [Features](#features) and [help file](doc/mini-extra.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/readmes/mini-extra.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://github.com/echasnovski/mini.nvim/assets/24854248/31ceb716-eefa-4858-b77f-5b6b3fe594f5

## Features

Extra useful functionality which is not essential enough for other 'mini.nvim' modules to include directly.

Features:

- Various pickers for ['mini.pick'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-pick.md):

    - Built-in diagnostic (`*MiniExtra.pickers.diagnostic()*`).

    - File explorer (`*MiniExtra.pickers.explorer()*`).

    - Git branches/commits/files/hunks (`*MiniExtra.pickers.git_hunks()*`, etc.).

    - Command/search/input history (`*MiniExtra.pickers.history()*`).

    - LSP references/symbols/etc. (`*MiniExtra.pickers.lsp()*`).

    - Tree-sitter nodes (`*MiniExtra.pickers.treesitter()*`).

    - **And much more**.

  See `*MiniExtra.pickers*` help tag for more.

- Various textobject specifications for ['mini.ai'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-ai.md). See `*MiniExtra.gen_ai_spec*` help tag for more.

- Various highlighters for ['mini.hipatterns'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-hipatterns.md). See `*MiniExtra.gen_highlighter*` help tag for more.

Notes:

- This module requires only those 'mini.nvim' modules which are needed for a particular functionality: 'mini.pick' for pickers, etc.

For more information, see these tags in help file:

- `*MiniExtra.pickers*`

- `*MiniExtra.gen_ai_spec*`

- `*MiniExtra.gen_highlighter*`

## 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.extra')

        

        

            Stable add({ source = 'echasnovski/mini.extra', 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.extra', version = false },

        

        

            Stable { 'echasnovski/mini.extra', 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.extra'

        

        

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

        

    




**Important**: don't forget to call `require('mini.extra').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.

## Default config

```lua

-- No need to copy this inside `setup()`. Will be used automatically.

{}

```

## Similar plugins

- [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)

- [ibhagwan/fzf-lua](https://github.com/ibhagwan/fzf-lua)