Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/winston0410/commented.nvim
Neovim commenting plugin in Lua. Support operator, motions and more than 60 languages! :fire:
https://github.com/winston0410/commented.nvim
neovim neovim-plugin
Last synced: 13 days ago
JSON representation
Neovim commenting plugin in Lua. Support operator, motions and more than 60 languages! :fire:
- Host: GitHub
- URL: https://github.com/winston0410/commented.nvim
- Owner: winston0410
- License: mit
- Created: 2021-05-29T07:22:50.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-12T18:54:09.000Z (over 2 years ago)
- Last Synced: 2024-07-31T20:51:44.250Z (3 months ago)
- Topics: neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 1.06 MB
- Stars: 112
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - winston0410/commented.nvim - A commenting plugin that supports counts and multiple comment patterns and much more. (Editing Support / Comment)
README
# commented.nvim
A commenting plugin written in Lua that actually works.
This plugin uses `commentstring` and custom comment definition for accurately comment and uncomment code.
## Latest features
### Codetags (6-10-2021)
Use `commented.nvim` to toggle a comment with code tag. You can check all existing codetags [here](https://github.com/winston0410/commented.nvim/blob/632423912c87923c37cf81b4c23d5303e9ddec55/lua/commented/init.lua#L345), PR welcomed.
```lua
vim.api.nvim_set_keymap(
"n",
"ff",
"v:lua.require'commented'.codetags.fixme_line()",
{ expr = true, silent = true, noremap = true }
)
```
**No default** is provided for the codetags binding. You can enable them like this or map them manually with `vim.api.nvim_set_keymap`. The key in `codetags_keybindings` has to match the key in [`codetags` table](https://github.com/winston0410/commented.nvim/blob/4dc89a654ac8ba3d090568ebfac173f376f2397c/lua/commented/init.lua#L365):
```lua
-- packer.nvim example
use({
"winston0410/commented.nvim",
config = function()
require("commented").setup({
codetags_keybindings = {
fixme = "f",
fixme_line = "ff",
todo = "t",
todo_line = "tt",
bug = "b",
bug_line = "bb",
note = "n",
note_line = "nn",
wont_fix = "w",
wont_fix_line = "ww",
},
})
end,
})
```
You can also create a custom tag, using `commented` function:
```lua
local foo = function()
return commented("bar")
end
```
```lua
vim.api.nvim_set_keymap(
"n",
"d",
"v:lua.require'filename'.foo()",
{ expr = true, silent = true, noremap = true }
)
```
## Features
- Provide sensible comment symbols default for **as much language as possible** (Always a WIP, [50+ right now](https://github.com/winston0410/commented.nvim/blob/master/lua/commented/init.lua#L7))
- Handle multi-line block comment, both commenting and uncommenting
- Commenting lines in normal mode and visual line mode
- Support **counts** for commenting in normal mode (e.g. `2c2j`, `3cc`)
- Toggleable commenting command
- Handle uncommenting **multiple comment patterns(inline and block comment)** correctly
- Handle comments with various spacing correctly
- Comment ex-mode command that handles range included
- Provide the correct `commentstring` for filetype not handled by neovim initially
- Integrate with any plugin that dynamically switch `cms` based on embedded languages
## Demo
### Commenting in normal mode with count
### Commenting in visual line mode
### Uncommenting both inline and block comment
## Why another comment plugin?
I need a comment plugin that works in normal mode and virtual mode and accepts count. Neither does [kommentary](https://github.com/b3nj5m1n/kommentary) and [nvim-comment](https://github.com/terrortylor/nvim-comment) provide counts, therefore I decided to write one for myself.
## Installation
### `Paq.nvim`
```lua
paq{'winston0410/commented.nvim'}
```
### `vim-plug`
```lua
Plug 'winston0410/commented.nvim'
```
### `packer.nvim`
Do not set this plugin as optional, as sensible default has been made with `ftplugin`
```lua
use{'winston0410/commented.nvim'}
```
## Configuration
This is the default configuration.
```lua
local opts = {
comment_padding = " ", -- padding between starting and ending comment symbols
keybindings = {n = "c", v = "c", nl = "cc"}, -- what key to toggle comment, nl is for mapping c$, just like dd for d
prefer_block_comment = false, -- Set it to true to automatically use block comment when multiple lines are selected
set_keybindings = true, -- whether or not keybinding is set on setup
ex_mode_cmd = "Comment" -- command for commenting in ex-mode, set it null to not set the command initially.
}
```
You can define your own mapping with `require('commented').toggle_comment(mode)`
If you are happy with it, just call `setup()` to make it start working.
```lua
require('commented').setup()
```
## Doesn't work for the language I use
If this plugin doesn't work for the language you use, you can [contribute and add those symbols here](https://github.com/winston0410/commented.nvim/blob/94246498eb89948271bbeedf0e64d78b28510720/lua/commented/init.lua#L7-L40) for that language. The key for the pattern doesn't matter.
## Integration
This plugin integrates with those that change `commentstring` dynamically in two ways. Using `nvim-ts-context-commentstring` as an example:
You could use an autocommand to dynamically set the `commentstring`:
```lua
require'nvim-treesitter.configs'.setup {
context_commentstring = {
enable = true,
-- This plugin provided an autocommand option
enable_autocmd = true,
}
}
```
But this will depends on `updatetime`, which may be slow. Another approach is to use hook, which is faster and doesn't depend on `updatetime`:
```lua
require("commented").setup({
hooks = {
before_comment = require("ts_context_commentstring.internal").update_commentstring,
},
})
```
## Inspiration
[kommentary](https://github.com/b3nj5m1n/kommentary)
[nvim-comment](https://github.com/terrortylor/nvim-comment)