nvim-comment-frame
A Neovim plugin that creates language-aware comment frames using Tree-sitter for automatic syntax detection.
What is nvim-comment-frame?
nvim-comment-frame is a Neovim plugin that generates decorative comment blocks in code files. It automatically detects the programming language using Tree-sitter and creates properly formatted comment frames with customizable borders and indentation. This helps developers visually separate code sections and improve documentation readability.
Neovim users who write code in multiple languages and want to enhance their commenting style with automated, language-aware formatting.
It eliminates manual effort in creating consistent comment blocks across different file types, with intelligent syntax detection and flexible configuration options for personalized workflows.
Overview
Detects the language using treesitter and adds a comment block
Use Cases
Best For
- Adding decorative section headers in code documentation
- Creating visually distinct comment blocks in multi-language projects
- Automating comment formatting with language-specific syntax
- Improving code readability with framed comments
- Customizing comment styles per programming language
- Quickly inserting formatted comments via keybindings
Not Ideal For
- Projects that enforce minimalistic, plain comment styles without decorative elements
- Teams requiring automated API documentation generation from comments (e.g., with Doxygen or JSDoc)
- Neovim users without Tree-sitter installed or configured, as language detection depends on it
Pros & Cons
Pros
Uses Tree-sitter to automatically identify file types and apply correct comment syntax, as demonstrated in the README with examples for JavaScript, Bash, and Lua.
Respects current line indentation and tab/space settings via the auto_indent option, ensuring comment frames align properly within code blocks, as explained in the auto indent section.
Allows per-language configuration of frame width, fill characters, and start/end strings, detailed in the setup examples for languages like Lua with star-filled borders.
Provides default keybindings (<leader>cf and <leader>cm) and easy customization through the setup function, supporting both single and multiline comments as shown in the keymaps section.
Cons
Relies on nvim-treesitter for language detection; if Tree-sitter is missing or fails, the plugin may not work correctly, requiring manual configuration or additional setup.
Primarily designed for creating decorative comment frames, not for general commenting or inline documentation, which limits its utility for broader documentation needs beyond visual separation.
While customizable, setting up language-specific configurations can be tedious, especially for multi-language projects, as each language requires individual adjustments in the setup, as noted in the configuration examples.
Frequently Asked Questions
Related Projects
Comment.nvim:brain: :muscle: // Smart and powerful comment plugin for neovim. Supports treesitter, dot repeat, left-right/up-down motions, hooks, and more
todo-comments.nvim✅ Highlight, list and search todo comments in your projects
neogenA better annotation generator. Supports multiple languages and annotation conventions.
nvim-ts-context-commentstringNeovim treesitter plugin for setting the commentstring based on the cursor location in a file.
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.