https://github.com/echasnovski/mini.jump

Neovim Lua plugin to jump forward/backward to a single character. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.jump

lua mini-nvim neovim neovim-plugin

Last synced: 4 days ago
JSON representation

Neovim Lua plugin to jump forward/backward to a single character. Part of 'mini.nvim' library.

• Host: GitHub
• URL: https://github.com/echasnovski/mini.jump
• Owner: echasnovski
• License: mit
• Created: 2022-10-24T16:22:42.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-01T08:29:58.000Z (5 months ago)
• Last Synced: 2024-08-07T18:35:20.768Z (3 months ago)
• Topics: lua, mini-nvim, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 55.7 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![GitHub license](https://badgen.net/github/license/echasnovski/mini.nvim)](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)

### Jump to next/previous single character

See more details in [Features](#features) and [help file](doc/mini-jump.txt).

---

⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/README.md) 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'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.

Initial idea and implementation by [Adam Blažek](https://github.com/xigoi).

## Demo

https://user-images.githubusercontent.com/24854248/173044762-f0f50a73-02df-4432-a79e-54b0ddaa1e48.mp4

## 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 full dot-repeat) modes are supported.

## 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.jump')

        

        

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

        

        

            Stable { 'echasnovski/mini.jump', 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.jump'

        

        

            Stable Plug 'echasnovski/mini.jump', { 'branch': 'stable' }

        

    




**Important**: don't forget to call `require('mini.jump').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 : 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.

{

  -- 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,

  },

}

```

## Similar plugins

- [rhysd/clever-f.vim](https://github.com/rhysd/clever-f.vim)

- [justinmk/vim-sneak](https://github.com/justinmk/vim-sneak)