numToStr/Comment.nvim
Comment.nvim
Comment.nvim is a Neovim plugin for toggling line and block comments in code. It uses a language-aware syntax resolver to determine the correct comment characters based on the active buffer's filetype and a text-object commenting engine to apply these changes across specific code regions using motions.
The plugin features a hook-based action pipeline that executes user-defined pre and post callbacks around core buffer modification operations. It supports Tree-Sitter syntax detection to handle embedded languages within a single file and allows for the definition of custom comment syntax for unsupported file types.
The system provides capabilities for inserting, toggling, and repeating comment operations, including pattern-based line exclusion. It manages these actions through a stateful command stack to enable the immediate re-execution of the most recent comment or uncomment operation.
Features
- Comment Toggling Utilities - Toggles comments on and off for selected lines or blocks using code-aware movement commands.
- Comment Syntax Customization - Allows users to define custom comment delimiters for unsupported programming languages or file types.
- Commenting Engines - Implements distinct logic paths for applying either linewise or blockwise comment styles based on user selection.
- Language-Aware Syntax Resolvers - Determines the correct comment characters based on the filetype of the active Neovim buffer.
- Neovim Plugins - Provides an integrated commenting solution specifically for the Neovim text editor.
- Text Buffer Manipulations - Directly modifies the editor buffer content using Lua API calls to insert or remove comment delimiters.
- Text-Object Commenting - Toggles comments for specific code regions using cursor motions and text objects like paragraphs or brackets.
- Buffer Modification Engines - Employs a dedicated engine to apply insert, toggle, and uncomment actions by directly editing the buffer text.
- Comment Syntax Mappings - Resolves language-specific comment characters at runtime by looking up the buffer filetype in a configuration map.
- Comment Action Pipelines - Executes user-defined pre and post callbacks around core buffer modification operations to allow behavior extension.
- Command Re-execution - Enables the immediate re-execution of the most recent comment operation by storing its parameters in a stateful stack.
- Comment Insertion Utilities - Adds a new comment line before or after the current line and automatically enters edit mode.
- Comment Mode Selection - Supports both linewise and blockwise commenting depending on the user command or visual mode selection.
- Language-Specific Configurations - Allows the definition of custom comment delimiters for programming languages not automatically recognized.
- Repeatable Comment Operations - Stores the parameters of the most recent comment action to facilitate immediate re-execution.
- Pipeline Lifecycle Hooks - Provides a hook-based pipeline to run user-defined callbacks before and after each comment operation.
- Embedded Language Detection - Uses Tree-Sitter syntax tree analysis to determine the correct comment markers for embedded languages within a file.
- Commenting Utilities - Powerful commenting with motion support.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
