https://github.com/sontungexpt/stcursorword

A concise, precise, and high-performance cursor word highlighting plugin for Neovim, implemented in Lua.
https://github.com/sontungexpt/stcursorword

cursorline cursorword lua neovim neovim-colorscheme neovim-dotfiles neovim-plugin nvim plugin

Last synced: about 1 month ago
JSON representation

A concise, precise, and high-performance cursor word highlighting plugin for Neovim, implemented in Lua.

• Host: GitHub
• URL: https://github.com/sontungexpt/stcursorword
• Owner: sontungexpt
• License: mit
• Created: 2023-09-24T10:38:22.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-28T11:14:13.000Z (5 months ago)
• Last Synced: 2024-10-14T18:41:34.128Z (about 2 months ago)
• Topics: cursorline, cursorword, lua, neovim, neovim-colorscheme, neovim-dotfiles, neovim-plugin, nvim, plugin
• Language: Lua
• Homepage:
• Size: 898 KB
• Stars: 74
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - sontungexpt/stcursorword - Highlight the word under the cursor (Improved and compact version of nvim-cursorline). (Bars and Lines / Cursorline)

README

        
## STCursorword

A concise, precise, and high-performance cursor word highlighting plugin for Neovim, implemented in Lua.

- ❓ [Reasons for creating](#reason)

- 👀 [Installation](#installation)

- 💻 [Configuration](#configuration)

- 😆 [Usage](#usage)

- 😁 [Contributing](#contributing)

- ✌️ [License](#license)

## Reasons  for creating this plugin

🎉 There are many plugins that do this, but none of them support disabling for certain filetypes. So, If I accidentally open a binary file such as .png file it gives me an error

🛠️ Other plugins always reset highlighting when the cursor moves, whereas this plugin does not. It only resets the highlighting when the cursor moves to a new word.

For example, if the cursor is on the character `h` in the word `hello`, and you move the cursor to `e`, other plugins will remove the highlighting from the word `hello` and then highlight it again, even though the cursor is still on that word. Consequently, when you move to the `o`, it will undergo highlighting five times.

🍕 Easily to disable and enable when needed.

🚀 And a subjective reason is that I used to use the [nvim-cursorline](https://github.com/yamatsum/nvim-cursorline) plugin before, but I don't use the cursorline feature. Another plugins i found that [nvim-cursorword](https://github.com/xiyaowong/nvim-cursorword), it works quite similar to this plugin, but its setup method is not like the plugins I usually use. So this is the reason for this plugin.

## Preview

https://github.com/sontungexpt/stcursorword/assets/92097639/2beb58cf-d6f9-44f9-979d-dea280a52b4d

Compare with nvim cursorline

Nvim cursorline error when accidentally open a binary file

![nvim-cursorline error](./docs/readme/compare1.png)

This plugin fixed this error.

https://github.com/sontungexpt/stcursorword/assets/92097639/d00be822-dfcf-47e8-8e97-a2a6ae0b6abf

## Installation

```lua

    -- lazy

    {

        "sontungexpt/stcursorword",

        event = "VeryLazy",

        config = true,

    },

```

## Configuration

```lua

    -- default configuration

    require("stcursorword").setup({

        max_word_length = 100, -- if cursorword length > max_word_length then not highlight

        min_word_length = 2, -- if cursorword length < min_word_length then not highlight

        excluded = {

            filetypes = {

                "TelescopePrompt",

            },

            buftypes = {

                -- "nofile",

                -- "terminal",

            },

            patterns = { -- the pattern to match with the file path

                -- "%.png$",

                -- "%.jpg$",

                -- "%.jpeg$",

                -- "%.pdf$",

                -- "%.zip$",

                -- "%.tar$",

                -- "%.tar%.gz$",

                -- "%.tar%.xz$",

                -- "%.tar%.bz2$",

                -- "%.rar$",

                -- "%.7z$",

                -- "%.mp3$",

                -- "%.mp4$",

            },

        },

        highlight = {

            underline = true,

            fg = nil,

            bg = nil,

        },

    })

```

## Usage

`:Cursorword` command

| **Args**  | **Description**                             |

| --------- | ------------------------------------------- |

| `toggle`  | Toggle highlight the word under the cursor  |

| `enable`  | Enable highlight the word under the cursor  |

| `disable` | Disable highlight the word under the cursor |

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details