[](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE) ### Comment lines See more details in [Features](#features) and [help file](../doc/mini-comment.txt). --- ⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-comment.md) if you want to mention this module. ⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'. ⦿ See the repository page to learn about common design principles and configuration recipes. --- If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories. ## Demo https://user-images.githubusercontent.com/24854248/173044250-1a8bceae-8f14-40e2-a678-31aca0cd6c1a.mp4 ## Features - Commenting in Normal mode respects `v:count` and is dot-repeatable. - Comment structure is inferred from 'commentstring': either from current buffer or from locally active tree-sitter language (only on Neovim>=0.9). It can be customized via `options.custom_commentstring`. - Handles both tab and space indenting (but not when they are mixed). - Allows custom hooks before and after successful commenting. - Configurable options for some nuanced behavior. Notes: - To use tree-sitter aware commenting, global value of 'commentstring' should be `''` (empty string). This is the default value in Neovim>=0.9, so make sure to not set it manually. ## 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):

With mini.deps

Github repo	Branch	Code snippet
'mini.nvim' library	Main	Follow recommended 'mini.deps' installation
	Stable
Standalone plugin	Main	add('echasnovski/mini.comment')
	Stable	add({ source = 'echasnovski/mini.comment', checkout = 'stable' })

With folke/lazy.nvim

Github repo	Branch	Code snippet
'mini.nvim' library	Main	{ 'echasnovski/mini.nvim', version = false },
	Stable	{ 'echasnovski/mini.nvim', version = '*' },
Standalone plugin	Main	{ 'echasnovski/mini.comment', version = false },
	Stable	{ 'echasnovski/mini.comment', version = '*' },

With junegunn/vim-plug

Github repo	Branch	Code snippet
'mini.nvim' library	Main	Plug 'echasnovski/mini.nvim'
	Stable	Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }
Standalone plugin	Main	Plug 'echasnovski/mini.comment'
	Stable	Plug 'echasnovski/mini.comment', { 'branch': 'stable' }

**Important**: don't forget to call `require('mini.comment').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 : 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 ```lua -- No need to copy this inside `setup()`. Will be used automatically. { -- Options which control module behavior options = { -- Function to compute custom 'commentstring' (optional) custom_commentstring = nil, -- Whether to ignore blank lines when commenting ignore_blank_line = false, -- Whether to recognize as comment only lines without indent start_of_line = false, -- Whether to force single space inner padding for comment parts pad_comment_parts = true, }, -- Module mappings. Use `''` (empty string) to disable one. mappings = { -- Toggle comment (like `gcip` - comment inner paragraph) for both -- Normal and Visual modes comment = 'gc', -- Toggle comment on current line comment_line = 'gcc', -- Toggle comment on visual selection comment_visual = 'gc', -- Define 'comment' textobject (like `dgc` - delete whole comment block) -- Works also in Visual mode if mapping differs from `comment_visual` textobject = 'gc', }, -- Hook functions to be executed at certain stage of commenting hooks = { -- Before successful commenting. Does nothing by default. pre = function() end, -- After successful commenting. Does nothing by default. post = function() end, }, } ``` ## Similar plugins - Built-in commenting in Neovim>=0.10, see `:h commenting` (implemented with 'mini.comment' as reference) - [numToStr/Comment.nvim](https://github.com/numToStr/Comment.nvim) - [tpope/vim-commentary](https://github.com/tpope/vim-commentary) - [preservim/nerdcommenter](https://github.com/preservim/nerdcommenter) - [b3nj5m1n/kommentary](https://github.com/b3nj5m1n/kommentary)