/mini.ai

Neovim Lua plugin to extend and create `a`/`i` textobjects. Part of 'mini.nvim' library.

Primary LanguageLuaMIT LicenseMIT

GitHub license

Extend and create a/i textobjects

  • It enhances some builtin textobjects (like a(, a), a', and more), creates new ones (like a*, 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 Features and help file.

⦿ 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

demo-ai.mp4

Features

  • Customizable creation of a/i textobjects 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

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

  -- Whether to disable showing non-error feedback
  silent = false,
}

Similar plugins