How do I disable nvim-cursorline for specific filetypes like Markdown?

Add the filetype names to the disable_filetypes list in the setup function, e.g., `disable_filetypes = {'markdown', 'txt'}`. This prevents the plugin from activating in those buffers, as per the configuration example.

nvim-cursorline or vim-cursorword: which should I use?

nvim-cursorline combines word highlighting with dynamic cursorline management, while vim-cursorword only handles word highlighting. Choose nvim-cursorline if you want both features in one Neovim-specific plugin, but vim-cursorword is better for Vim users or minimal setups.

Can I change the underline to a background highlight in nvim-cursorline?

Yes, modify the 'hl' option in the cursorword configuration. For example, set `hl = { underline = false, bg = '#ff0000' }` to use a red background highlight instead of an underline, leveraging Neovim's highlight groups.

Why isn't nvim-cursorline highlighting words in my Neovim?

First, ensure the plugin is installed and enabled in setup with `cursorword.enable = true`. Check that the filetype isn't in disable_filetypes, and verify no other highlight rules or plugins are overriding it, as conflicts can occur.

How to adjust the timeout for hiding the cursorline?

Set the 'timeout' value in the cursorline configuration, e.g., `timeout = 500` for half a second. This controls how long after cursor movement stops before the cursorline hides, based on the dynamic behavior described.

Does nvim-cursorline work with treesitter or other highlight plugins?

Generally yes, but it may conflict if both modify the same highlight groups. You might need to adjust highlight priorities or use filetype exclusions to avoid overlaps, as the plugin doesn't provide built-in integration guidance.

Open-Awesome

nvim-cursorline

MITLua

A Neovim plugin that highlights the word under the cursor and shows/hides cursorline based on cursor movement.

GitHub

472 stars28 forks0 contributors

What is nvim-cursorline?

nvim-cursorline is a Neovim plugin that enhances the editing experience by providing visual feedback through cursor-based highlighting. It underlines the word under the cursor and dynamically manages cursorline visibility based on cursor movement. The plugin helps developers maintain better orientation in their code and reduces visual searching during editing sessions.

Target Audience

Neovim users who want improved visual feedback and cursor tracking while editing code or text. Particularly useful for developers working with complex codebases who need better position awareness.

Value Proposition

Developers choose nvim-cursorline for its lightweight, focused approach to cursor enhancement without bloat. It combines word highlighting and intelligent cursorline management in one configurable package, drawing inspiration from established Vim plugins while being built specifically for Neovim's modern architecture.

Overview

A plugin for neovim that highlights cursor words and lines

Use Cases

Best For

Improving code navigation in large files
Reducing eye strain during long coding sessions
Tracking variable names and identifiers while editing
Maintaining orientation in complex code structures
Enhancing visual feedback in minimalist Neovim setups
Configuring cursor behavior for specific filetypes

Not Ideal For

Users needing advanced cursor animations or effects beyond basic hiding/showing, such as smooth transitions or context-aware highlighting
Developers using vanilla Vim or editors other than Neovim, as it relies on Neovim-specific Lua APIs
Those with comprehensive cursor enhancement suites already installed, who might face redundancy or plugin conflicts

Pros & Cons

Pros

Effective Word Highlighting

Underlines the word under the cursor with a configurable minimum length, as shown in the README video, providing clear visual feedback for identifiers during editing.

Dynamic Cursorline Management

Automatically hides the cursorline after a user-defined timeout when the cursor is idle, reducing visual clutter without manual intervention, with timeout settings adjustable in setup.

Granular Filetype Control

Allows disabling the plugin for specific filetypes or buffer types via the disable_filetypes and disable_buftypes options, offering precise control over its application.

Lightweight and Focused

Combines word highlighting and cursorline toggling in a single minimal plugin, avoiding bloat while drawing inspiration from established Vim plugins like vim-cursorword.

Cons

Feature-Limited Scope

Only provides basic word underlining and cursorline toggling; lacks advanced features such as multi-cursor support, integration with syntax highlighting, or animation effects.

Neovim-Exclusive Dependency

Requires Neovim and Lua configuration, making it inaccessible for Vim users or those unfamiliar with Neovim's modern setup, as noted in the installation instructions.

Sparse Advanced Documentation

The README covers basic setup but lacks detailed examples for complex customizations, troubleshooting, or integration with other plugins, which may require community support.

Frequently Asked Questions

Related Projects

vim-illuminate

illuminate.vim - (Neo)Vim plugin for automatically highlighting other uses of the word under the cursor using either LSP, Tree-sitter, or regex matching.

Stars2,461

Forks76

Last commit1 year ago

modicator.nvim

Cursor line number mode indicator plugin for Neovim

Stars369

Forks11

Last commit2 months ago

stcursorword

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

Stars83

Forks1

Last commit7 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub