Mini Ai

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 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 whole library documentation to learn about general design principles, disable/configuration recipes, and more.

⦿ See MiniMax for a full config example that uses this module.

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

https://user-images.githubusercontent.com/24854248/181909691-b6f6b677-c37f-468f-85db-8eb8b1e1314e.mp4

Features

Customizable creation of a/i textobjects using Lua patterns and functions. Supports:
- Dot-repeat.
- v:count.
- Different search methods (see :h MiniAi.config).
- Consecutive application (update selection without leaving Visual mode).
- Aliases for multiple textobjects.
Comprehensive builtin textobjects (see more at :h MiniAi-builtin-textobjects):
- Balanced brackets (with and without whitespace) plus alias.
- Balanced quotes plus alias.
- Function call.
- Argument.
- Tag.
- Derived from user prompt.
- Default for anything but Latin letters (to fall back to :h text-objects).
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):

<details> <summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

lua

vim.pack.add({ 'https://github.com/nvim-mini/mini.ai' })

Stable branch:

lua

vim.pack.add({
  { src = 'https://github.com/nvim-mini/mini.ai', version = 'stable' },
})

</details> <details> <summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>

Full library

Standalone plugin:

Main branch:

lua

add('nvim-mini/mini.ai')

Stable branch:

lua

add({ source = 'nvim-mini/mini.ai', checkout = 'stable' })

</details> <details> <summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

lua

{ 'nvim-mini/mini.ai', version = false },

Stable branch:

lua

{ 'nvim-mini/mini.ai', version = '*' },

</details>

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

lua

-- 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
    -- NOTE: This (deliberately) overrides Neovim>=0.12 built-in incremental
    -- selection mappings. See `:h MiniAi-default-an-in` for more details.
    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
  -- This also affects (purely informational) helper messages shown after
  -- idle time if user input is required.
  silent = false,
}

Extend and create a/i textobjects

Demo

Features

Installation

Default config

Similar plugins

Extend and create `a`/`i` textobjects