Something went wrong. Try again.
Library of 45+ independent Lua modules improving Neovim experience with minimal effort nvim-mini.org/mini.nvim
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202*mini.jump* Jump to next/previous single character
MIT License Copyright (c) 2021 Evgeni Chasnovski, Adam Blažek
------------------------------------------------------------------------------ *MiniJump*Features:- Extend f, F, t, T to work on multiple lines.
- Repeat jump by pressing f, F, t, T again. It is reset when cursor moved as a result of not jumping or timeout after idle time (duration customizable).
- Highlight (after customizable delay) all possible target characters and stop it after some (customizable) idle time.
- Normal, Visual, and Operator-pending (with dot-repeat as in clean Neovim) modes are supported.
This module follows vim's |'ignorecase'| and |'smartcase'| options. When|'ignorecase'| is set, f, F, t, T will match case-insensitively. When|'smartcase'| is also set, f, F, t, T will only match lowercasecharacters case-insensitively.
# Setup ~
This module needs a setup with `require('mini.jump').setup({})`(replace `{}` with your `config` table). It will create global Lua table`MiniJump` which you can use for scripting or manually (with`:lua MiniJump.*`).
See |MiniJump.config| for `config` structure and default values.
You can override runtime config settings locally to buffer inside`vim.b.minijump_config` which should have same structure as`MiniJump.config`. See |mini.nvim-buffer-local-config| for more details.
To stop module from showing non-error feedback, set `config.silent = true`.
# Highlight groups ~*MiniJump-hl-groups*
- `MiniJump` - all possible cursor positions.
To change any highlight group, set it directly with |nvim_set_hl()|.
# Disabling ~
To disable core functionality, set `vim.g.minijump_disable` (globally) or`vim.b.minijump_disable` (for a buffer) to `true`. Considering high number ofdifferent scenarios and customization intentions, writing exact rules fordisabling module's functionality is left to user. See|mini.nvim-disabling-recipes| for common recipes.
------------------------------------------------------------------------------ *MiniJump-events*To allow user customization and integration of external tools, certain |User|autocommand events are triggered under common circumstances:
- `MiniJumpGetTarget` - before asking user for the target. Use |MiniJump.state| for more information about the upcoming jump.- `MiniJumpStart` - after jumping has started.- `MiniJumpJump` - after performing a jump.- `MiniJumpStop` - after jumping is stopped.
------------------------------------------------------------------------------ *MiniJump.setup()* `MiniJump.setup`({config})Module setup
Parameters ~{config} `(table|nil)` Module config table. See |MiniJump.config|.
Usage ~>lua require('mini.jump').setup() -- use default config -- OR require('mini.jump').setup({}) -- replace {} with your config table<------------------------------------------------------------------------------ *MiniJump.config* `MiniJump.config`Defaults ~>lua MiniJump.config = { -- Module mappings. Use `''` (empty string) to disable one. mappings = { forward = 'f', backward = 'F', forward_till = 't', backward_till = 'T', repeat_jump = ';', },
-- Delay values (in ms) for different functionalities. Set any of them to -- a very big number (like 10^7) to virtually disable. delay = { -- Delay between jump and highlighting all possible jumps highlight = 250,
-- Delay between jump and automatic stop if idle (no jump is done) idle_stop = 10000000, },
-- 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, }<------------------------------------------------------------------------------ *MiniJump.state* `MiniJump.state`Data about jumping state
It stores various information used in this module. All elements, except`jumping`, is about the latest jump. They are used as default values forsimilar arguments.
Usage ~This can be used to define mappings which depend on state; either asa standalone mapping or part of |MiniKeymap.map_multistep()|. For example: >lua
-- Stop jumping after pressing `<Esc>` local jump_stop = function() if not MiniJump.state.jumping then return '<Esc>' end MiniJump.stop_jumping() end local opts = { expr = true, desc = 'Stop jumping' } vim.keymap.set({ 'n', 'x', 'o' }, '<Esc>', jump_stop, opts)<Class ~{JumpingState}
Fields ~{target} `(string|nil)` The string to jump to.{backward} `(boolean|nil)` Whether to jump backward.{till} `(boolean|nil)` Whether to jump just before/after the match instead of exactly on target. This includes positioning cursor past the end of previous/current line. Note that with backward jump this might lead to cursor being on target if can't be put past the line.{n_times} `(number|nil)` Number of times to perform consecutive jumps.{mode} `(string)` Mode of latest jump (output of |mode()| with non-zero argument).{jumping} `(boolean)` Whether module is currently in "jumping mode": usage of |MiniJump.smart_jump()| and all mappings won't require target.
Initial values:>lua MiniJump.state = { target = nil, backward = false, till = false, n_times = 1, mode = nil, jumping = false, }<------------------------------------------------------------------------------ *MiniJump.jump()* `MiniJump.jump`({target}, {backward}, {till}, {n_times})Jump to target
Takes a string and jumps to its first occurrence in desired direction.
All default values are taken from |MiniJump.state| to emulate latest jump.
Parameters ~{target} `(string|nil)` The string to jump to.{backward} `(boolean|nil)` Whether to jump backward.{till} `(boolean|nil)` Whether to jump just before/after the match instead of exactly on target. This includes positioning cursor past the end of previous/current line. Note that with backward jump this might lead to cursor being on target if can't be put past the line.{n_times} `(number|nil)` Number of times to perform consecutive jumps.
------------------------------------------------------------------------------ *MiniJump.smart_jump()* `MiniJump.smart_jump`({backward}, {till})Make smart jump
If the last movement was a jump, perform another jump with the same target.Otherwise, wait for a target input (via |getcharstr()|). Respects |v:count|.
All default values are taken from |MiniJump.state| to emulate latest jump.
Parameters ~{backward} `(boolean|nil)` Whether to jump backward.{till} `(boolean|nil)` Whether to jump just before/after the match instead of exactly on target. This includes positioning cursor past the end of previous/current line. Note that with backward jump this might lead to cursor being on target if can't be put past the line.
------------------------------------------------------------------------------ *MiniJump.stop_jumping()* `MiniJump.stop_jumping`()Stop jumping
Removes highlights (if any) and forces the next smart jump to prompt forthe target. Automatically called on appropriate Neovim |events|.
vim:tw=78:ts=8:noet:ft=help:norl: