mini.extra
Generated from the main
branch of ‘mini.nvim’
Extra ‘mini.nvim’ functionality
See more details in Features and Documentation.
[!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.
⦿ This is a part of mini.nvim library. Please use this link 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’ or leave a Github star for ‘mini.nvim’ project and/or any its standalone Git repositories.
Demo
Features
Extra useful functionality which is not essential enough for other ‘mini.nvim’ modules to include directly.
Features:
Various pickers for ‘mini.pick’:
- 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
:h MiniExtra.pickers
for more.
- Built-in diagnostic (
Various textobject specifications for ‘mini.ai’. See
:h MiniExtra.gen_ai_spec
.Various highlighters for ‘mini.hipatterns’. See
:h MiniExtra.gen_highlighter
.
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 parts of help:
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 inmain
branch.
Here are code snippets for some common installation methods (use only one):
With mini.deps
‘mini.nvim’ library:
Branch Code snippet Main Follow recommended ‘mini.deps’ installation Stable Follow recommended ‘mini.deps’ installation Standalone plugin:
Branch Code snippet Main add(‘nvim-mini/mini.extra’)
Stable add({ source = ‘nvim-mini/mini.extra’, checkout = ‘stable’ })
With folke/lazy.nvim
‘mini.nvim’ library:
Branch Code snippet Main { 'nvim-mini/mini.nvim', version = false },
Stable { 'nvim-mini/mini.nvim', version = '*' },
Standalone plugin:
Branch Code snippet Main { 'nvim-mini/mini.extra', version = false },
Stable { 'nvim-mini/mini.extra', version = '*' },
With junegunn/vim-plug
‘mini.nvim’ library:
Branch Code snippet Main Plug 'nvim-mini/mini.nvim'
Stable Plug 'nvim-mini/mini.nvim', { 'branch': 'stable' }
Standalone plugin:
Branch Code snippet Main Plug 'nvim-mini/mini.extra'
Stable Plug 'nvim-mini/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 <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
-- No need to copy this inside `setup()`. Will be used automatically.
{}