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

Neovim Lua plugin for autohighlighting word under cursor. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.cursorword

lua mini-nvim neovim neovim-plugin

Last synced: 2 days ago
JSON representation

Neovim Lua plugin for autohighlighting word under cursor. Part of 'mini.nvim' library.

• Host: GitHub
• URL: https://github.com/echasnovski/mini.cursorword
• Owner: echasnovski
• License: mit
• Created: 2022-10-24T16:19:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-01T08:29:42.000Z (5 months ago)
• Last Synced: 2024-08-07T18:35:17.409Z (3 months ago)
• Topics: lua, mini-nvim, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 43 KB
• Stars: 21
• Watchers: 2
• Forks: 2
• 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)

### Automatic highlighting of word under cursor

See more details in [Features](#features) and [help file](doc/mini-cursorword.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.

## Demo

https://user-images.githubusercontent.com/24854248/173044454-0e4ab873-6e73-448d-838f-45f4b2be876b.mp4

## Features

- Current word under cursor can be highlighted differently.

- "Word under cursor" is meant as in Vim's ``: something user would get as 'iw' text object.

- Highlighting stops in insert and terminal modes.

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

        

        

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

        

        

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

        

        

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

        

    




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

{

  -- Delay (in ms) between when cursor moved and when highlighting appeared

  delay = 100,

}

```

## Similar plugins

- [RRethy/vim-illuminate](https://github.com/RRethy/vim-illuminate)

- [itchyny/vim-cursorword](https://github.com/itchyny/vim-cursorword)