6.4 KiB
Executable File
6.4 KiB
Executable File
Extend and create a/i textobjects
- It enhances some builtin textobjects (like
a(,a),a', and more), creates new ones (likea*,a<Space>,af,a?, and more), and allows user to create their own (like based on treesitter, and more). - Supports dot-repeat,
v:count, different search methods, consecutive application, and customization via Lua patterns or functions. - Has builtins for brackets, quotes, function call, argument, tag, user prompt, and any punctuation/digit/whitespace character.
See more details in help file.
This is a part of mini.nvim library. See its 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 or leave a Github star for 'mini.nvim' project.
Demo
Features
- Customizable creation of
a/itextobjects using Lua patterns and functions. Supports:- Dot-repeat.
v:count.- Different search methods (see help for
MiniAi.config). - Consecutive application (update selection without leaving Visual mode).
- Aliases for multiple textobjects.
- Comprehensive builtin textobjects (see more in help for
MiniAi-textobject-builtin):- Balanced brackets (with and without whitespace) plus alias.
- Balanced quotes plus alias.
- Function call.
- Argument.
- Tag.
- Derived from user prompt.
- Default for punctuation, digit, or whitespace single character.
- Motions for jumping to left/right edge of textobject.
- Set of specification generators to tweak some builtin textobjects (see
help for
MiniAi.gen_spec). - Treesitter textobjects (through
MiniAi.gen_spec.treesitter()helper).
Installation
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).stablewill be updated only upon releases with code tested during public beta-testing phase inmainbranch.
Here are code snippets for some common installation methods (use only one):
- Using wbthomason/packer.nvim:
| Branch | Code snippet |
|---|---|
| Main | use 'echasnovski/mini.nvim' |
| Stable | use { 'echasnovski/mini.nvim', branch = 'stable' } |
- Using junegunn/vim-plug:
| Branch | Code snippet |
|---|---|
| Main | Plug 'echasnovski/mini.nvim' |
| Stable | Plug 'echasnovski/mini.nvim', { 'branch': 'stable' } |
Important: don't forget to call require('mini.ai').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.
{
-- Table with textobject id as fields, textobject specification as values.
-- Also use this to disable builtin textobjects. See |MiniAi.config|.
custom_textobjects = nil,
-- Module mappings. Use `''` (empty string) to disable one.
mappings = {
-- Main textobject prefixes
around = 'a',
inside = 'i',
-- Next/last variants
around_next = 'an',
inside_next = 'in',
around_last = 'al',
inside_last = 'il',
-- Move cursor to corresponding edge of `a` textobject
goto_left = 'g[',
goto_right = 'g]',
},
-- Number of lines within which textobject is searched
n_lines = 50,
-- How to search for object (first inside current line, then inside
-- neighborhood). One of 'cover', 'cover_or_next', 'cover_or_prev',
-- 'cover_or_nearest', 'next', 'previous', 'nearest'.
search_method = 'cover_or_next',
}