Skip to content

mini-cursorword.md

Latest commit

 

History

History
137 lines (84 loc) · 4.5 KB

mini-cursorword.md

File metadata and controls

137 lines (84 loc) · 4.5 KB

mini.cursorword

Automatic highlighting of word under cursor

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

demo-cursorword.mp4

Features

  • Current word under cursor can be highlighted differently.
  • "Word under cursor" is meant as in Vim's <cword>: 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):

(Recommended) With vim.pack (on Neovim 0.12 and newer)

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

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

Stable branch:

vim.pack.add({
  { src = 'https://github.com/nvim-mini/mini.cursorword', version = 'stable' },
})
With mini.deps (before Neovim 0.12)

Full library

Follow recommended 'mini.deps' installation.

Standalone plugin:

Main branch:

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

Stable branch:

add({ source = 'nvim-mini/mini.cursorword', checkout = 'stable' })
With folke/lazy.nvim

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

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

Stable branch:

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

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 <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.
{
  -- Delay (in ms) between when cursor moved and when highlighting appeared
  delay = 100,
}

Similar plugins