Neovim commenting plugin, written in lua.

Neovim plugin to comment text in and out, written in lua. Supports commenting out the current line, a visual selection and a motion/textobject.

Information

Category: Python / Command-line Tools
Watchers: 2
Star: 59
Fork: 2
Last update: Feb 3, 2021

Resource links

https://github.com/b3nj5m1n/kommentary

README
Issues 12

kommentary

Neovim plugin to comment text in and out, written in lua. Supports commenting out the current line, a visual selection and a motion/textobject.

Install

Packer

use 'b3nj5m1n/kommentary'

Vim-Plug

Plug 'b3nj5m1n/kommentary'

Configuration

Configure unsupported language

Replace rust with the filetype you want to configure, the first field in the table with the prefix for single-line comments (A whitespace character gets added by default after a prefix and before a suffix) or false if the language doesn't support single-line comments, and the second field with a table containing the prefix and suffix for multi-line comments (including whitespace) or false if the language doesn't support multi-line comments.

require('kommentary.config').config["rust"] = {"//", {"/*", "*/"}}

Contributing

Any and all contributions are greatly appreciated!

Issues

If you found a bug or want to request a feature, pleases do so by raising an issue.

Pull Requests

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Make your changes
Run the unit tests if you changed anything affected by them
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

Please try your best to follow the style of the rest of the codebase, even though there's no official spec or linter for it.

Documentation

The code is heavily commented, functions are documented using LDoc.

You can build the documentation with this command:

ldoc .

Then you can access it from doc/index.html

Tests

There are unit tests available in the directory lua/test, you'll need to have luaunit installed, then run:

cd ./lua/
lua test/test_util.lua

# You might need to specify the lua version because luaunit doesn't support the latest ones
# lua5.3 test/test_util.lua

# For verbose output (Which tests are being run)
# lua test/test_util.lua -v

Or to run all tests:

cd ./lua/
./run_tests.sh

2 Open More issues

Closed

Support for .toml

Kommentary comments lines the wrong way in .toml files. Found the bug while editing my starship prompt config file.

bug

opened Feb 5, 2021 by Chaitanyabsprip 15

Closed

Feature request: yank and comment

Hi There.

Gr8 plugin, loving it. Just one ask; can you add a new mapping to yank the commented range b4 actually commenting it out? Right now, Im yanking by default like this:

diff --git a/lua/kommentary/kommentary.lua b/lua/kommentary/kommentary.lua
index 638ec2c..5e9c423 100644
--- a/lua/kommentary/kommentary.lua
+++ b/lua/kommentary/kommentary.lua
@@ -439,6 +439,7 @@ function M.toggle_comment_range(line_number_start, line_number_end, mode)
     if line_number_end < line_number_start then
         line_number_start, line_number_end = line_number_end, line_number_start
     end
+    vim.api.nvim_command(tostring(line_number_start) .. ',' .. tostring(line_number_end) .. 'y')
     local configuration = config.get_config(0)
     local modes = config.get_modes()
     mode = config.get_mode(line_number_start, line_number_end, mode)

Would be nice to have a new gcy mapping which yanks.

enhancement wontfix

opened Apr 25, 2021 by tzachar 11

Closed

Issues with block line comments in lua

Hi,

I was giving block commenting a try, and ran into one issue. Here's the gif:

I'm not sure how this should be handled though.

Also, did you thought about adding the block comment style like vim-commentary does, where each line gets the single line comment?

enhancement

opened Jan 31, 2021 by kristijanhusak 10

Closed

question: mixing multiline and normal comments breaks plugin

Example code:

  //for (std::pair<int, std::tuple<std::shared_ptr<Statement>, int, std::shared_ptr<Statement>, int>> e: edges)
  //  dbgEdge(e);
  /* for (std::pair<int, std::tuple<int, std::weak_ptr<Statement>>> e : incomingEdges)
    dbgincomingEdge(e);
  for (std::pair<int, std::tuple<int, std::shared_ptr<Statement>>> e : outgogingEdges)
    dbgoutgoingEdge(e); */

result on using :gc:

  /* //for (std::pair<int, std::tuple<std::shared_ptr<Statement>, int, std::shared_ptr<Statement>, int>> e: edges)
  //  dbgEdge(e);
  /* for (std::pair<int, std::tuple<int, std::weak_ptr<Statement>>> e : incomingEdges)
    dbgincomingEdge(e);
  for (std::pair<int, std::tuple<int, std::shared_ptr<Statement>>> e : outgogingEdges)
    dbgoutgoingEdge(e); */ */

support

opened Feb 10, 2021 by matu3ba 9

Closed

Plugin not working

I build the documentation but couldn't follow a single thing. The documentation mentions the functions and explains them but doesn't talk about configuration on user end. I couldn't figure out how to set it up yet.

support

opened Jan 31, 2021 by Chaitanyabsprip 9

Closed

Support dot repeat, lua callbacks

I was just messing around trying to get dot repeat working, and I ended up overshooting a bit and doing some other stuff as well.

Support passing Lua functions as callbacks
No more passing around strings for callback
Support dot repeat (without vim-repeat) for motion and linewise commenting

This is currently pretty messy and undocumented (because I honestly did not expect to get this far :)). Let me know if you'd want to proceed with this, and I'll work on cleaning it up and documenting it better.

opened Oct 8, 2021 by anihm136 6

Open

[FR] add one universal command to uncomment

As title, sometimes it would be handy if there's such command.

For example:

  a = 1
  --[[ b = 2
  c = 3
  d = 4]]

normally you would have to select the 3 lines and toggle comments, but it would be better if this plugin can detect the comment under cursor.

opened Aug 2, 2022 by glyh 0

Open

[FR] Commenting multiline strings in lua

Say I have the following codes I'd like to comment out:

-- other codes

  use { 'vlime/vlime', ft = 'lisp',
    disable = true,
    config = function()
      vim.g.vlime_cl_impl = "ros"
      vim.cmd([[
        function! VlimeBuildServerCommandFor_ros(vlime_loader, vlime_eval)
            return ["ros", "run",
                        \ "--load", a:vlime_loader,
                        \ "--eval", a:vlime_eval]
        endfunction
      ]])
    end
  }

-- other codes

I put my cursor on the codes and press gcip, it yields this:

  --[[ use { 'vlime/vlime', ft = 'lisp',
    disable = true,
    config = function()
      vim.g.vlime_cl_impl = "ros"
      vim.cmd([[
        function! VlimeBuildServerCommandFor_ros(vlime_loader, vlime_eval)
            return ["ros", "run",
                        \ "--load", a:vlime_loader,
                        \ "--eval", a:vlime_eval]
        endfunction
      ]])
    end
  } ]]

which is not valid lua code. I expect it to do something smarter like:

  --[=[ use { 'vlime/vlime', ft = 'lisp',
    disable = true,
    config = function()
      vim.g.vlime_cl_impl = "ros"
      vim.cmd([[
        function! VlimeBuildServerCommandFor_ros(vlime_loader, vlime_eval)
            return ["ros", "run",
                        \ "--load", a:vlime_loader,
                        \ "--eval", a:vlime_eval]
        endfunction
      ]])
    end
  } ]=]

BTW, if I already have a block of code like the latter one(enclosed by --[=[ and ]=], I can't toggle them with this plugin.

opened Aug 1, 2022 by glyh 0

Open

Expose Lua API directly

Now that we have vim.keymap.set API in Neovim nightly, it allows us to setup keymaps in really clean ways.

I'm using legendary.nvim to set all my keymaps, and I try to keep them all in the same place. I tend to have plugins not set their own keymaps through the plugin config, and instead set the keymaps in my single location where I set up all my keymaps.

You can also now set keymaps directly to Lua functions.

Can you expose the implementations of the <Plug> mappings as Lua functions I can map from my keymaps file?

opened Feb 18, 2022 by mrjones2014 1

Open

Custom comment in react jsx

kommentary support jsx comment by default but I still want to custom my comment like below:

// Single line
{/* <p>Single line comment</p> */}

// Multiple lines
{/* This is 
    for multi-line comments. */}

Here is my config:

-----------------------------------------------------------
-- Comment for vim
-----------------------------------------------------------

local kommentary_config = require('kommentary.config')

-- Plugin: kommentary
--- https://github.com/b3nj5m1n/kommentary

local M = {}

function M.setup()
  kommentary_config.configure_language('default', {
    single_line_comment_string  = 'auto',
    prefer_single_line_comments = true,
    multi_line_comment_strings  = false,
  })
  kommentary_config.configure_language('typescriptreact', {
    single_line_comment_string  = '{/*", "*/}',
    multi_line_comment_strings = {"{/*", "*/}"},
    prefer_single_line_comments = true,
  })
  kommentary_config.configure_language('javascriptreact', {
    single_line_comment_string  = '{/*", "*/}',
    multi_line_comment_strings = {"{/*", "*/}"},
    prefer_single_line_comments = true,
  })
end

return M

Is anything wrong with my config? It did not work as I expected.

opened Oct 1, 2021 by phuongthuan 0

Open

Visual commenting messes up unnamed register

Hi,

Today I noticed that something strange was happening with my clipboard. I was commenting a lot of lines in and out to test something, and my unnamed clipboard constantly changed. Then I figured out that kommentary is somehow overriding my unnamed registry.

Steps to reproduce:

Open some file, select anything, yank it into unnamed register with "+y
Select some other lines, do gc to comment them out
Try pasting unnamed register with "+p, see the result

Expected: See the thing I initially put into the register Actual: I get the lines that I commented out.

Here's the gif reproducing the issue (you can see what I'm typing in bottom right corner):

I wasn't able to find anywhere in the code where anything is done with the unnamed register, but I didn't look into too much details.

Here's some more information:

OS: Linux
Neovim version: 0.6.0-dev (Latest master)

opened Sep 8, 2021 by kristijanhusak 0

Open

Support advanced multiline strings in lua e.g. --[=[ something ]=]

Lua supports semi-arbitrary multiline comment strings in the form of matching numbers of equals signs. Meaning --[==[, --[===[, and --[=[ will only end the comment when it encounters ]==], ]===], and ]=] respectively.

It would be a great idea to match an opening regex like --\[\(=*\)\[ (or --\[(=*)\[ in PCRE style just to make sure it's clear) to the closing ]\1] (using the capture group from the opening regex to guarantee the same number of =)

This may not be as important when creating the comments, but is important to effectively uncomment them.

opened Aug 27, 2021 by Corey-Keller 0

Neovim plugin that allows you to easily write your .vimrc in lua or any lua based language

A set of configurations for Neovim made in Lua by someone who doesn't know Lua but has a lot of free time.

missing utf8 module for neovim Lua.

A minimal, stylish and customizable statusline for Neovim written in Lua

A workaround Neovim plugin to fix unnamed clipboard issue

🗣️ Simple self-hosted node app for Disqus-like drop-in commenting on static websites

Isso – a commenting server similar to Disqus

Presentation plugin for neovim written in lua

:brain: :muscle: // Smart and powerful comment plugin for neovim. Supports commentstring, dot repeat, left-right/up-down motions, hooks, and more

Xcode 8 Source Extension that moves cursor to next line after commenting/uncommenting current line

A lightweight commenting platform using Notion as a backend

autopairs for neovim written by lua

Neovim theme based off of the Nord Color Palette, written in lua with tree sitter support

🗂 Neovim plugin that lets you use your favorite terminal file managers from within Neovim.

A low-config, minimalistic buffer tabline Neovim plugin written in Lua.

lsp-rooter.nvim is a neovim plugin written in lua to change the current working directory to the project's root directory automagically using nvim native lsp.

project.nvim is an all in one neovim plugin written in lua that provides superior project management.

Snippet Engine for Neovim written in Lua.

💻 Dev setup for init.lua and plugin development with full signature help, docs and completion for the nvim lua API.

C++11 API for creating Lua bindings

A public catalogue of Lua plugins Neovim users would like to see exist

Share this repo

Related Repos

Command-line Tools

RSS reader client for CLI (Command Line Interface),

rReader rReader is RSS reader client for CLI(Command Line Interface), spinned off from rterm. rReader requires Python version 3.7 and above. rReader는

Command-line Tools

BoilingFactory is a CLI tool that generates factories for models generated by sqlboiler.

BoilingFactory This is a CLI tool that generates factories for models generated by sqlboiler. Installation Install sqlboiler Install your database dri

Command-line Tools

An assortment of handy nbb CLIs

Description An assortment of handy nbb CLIs. Prerequisites nodejs >= 16.3.1 and npm nbb >= 0.1.0 globally installed - npm install nbb -g Setup To use

Command-line Tools

You could use terminal to set your todo

Python Tutorial You can learn how to build a terminal application(CLI application) to manage your task and tools. You will use typer for building this

Command-line Tools

A litee.nvim backed plugin for saving important places in your code.

██╗ ██╗████████╗███████╗███████╗ ███╗ ██╗██╗ ██╗██╗███╗ ███╗ ██║ ██║╚══██╔══╝██╔════╝██╔════╝ ████╗ ██║██║ ██║██║████╗ ████║ Ligh

Command-line Tools

3.8k

Drop-down terminal for GNOME

Guake 3 README Introduction Guake is a python based dropdown terminal made for the GNOME desktop environment. Guake's style of window is based on an F

Command-line Tools

Neovim plugin for managing formatters

About Caution: Still a work in progress A lightweight installer plugin written for null-ls used to manage formatters Formatters are installed locally

Command-line Tools

Suricata Language Server is an implementation of the Language Server Protocol for Suricata...

Suricata Language Server is an implementation of the Language Server Protocol for Suricata signatures. It adds syntax check, hints and auto-completion to your preferred editor once it is configured.

Command-line Tools

Neovim plugin for web developers

Liveview.nvim Neovim Wrapper for browser sync View your html/css files with a live server HTML & CSS tag rename, repeat rename action Install Install

Command-line Tools

3.9k

Manage your SSH like a boss.

--- storm is a command line tool to manage your ssh connections. features adding, editing, deleting, listing, searching across your SSHConfig. command

Command-line Tools

363

A python telnet/ssh server for modern terminals. In spirit of classic software such as a...

Introduction An experimental python 2 Telnet (and SSH) BBS this project is abandoned, so please don't get too excited! Maybe you would be more interes

Command-line Tools

I can keep a SSHecret

SSHecret If you have an encrypted ssh key for each domain you access (you should), and you keep your unlocked keys in a single ssh-agent (you maybe sh

Command-line Tools

341

SSHPry v2 - Spy & Control os SSH Connected client's TTY

SSHPry2.0 This is a second release of SSHPry tool, with multiple features added. Control of target's TTY Built-In Keylogger Console-Level phishing Rec

Command-line Tools

170

SSH Session Manager

redial redial is a simple shell application that manages your SSH sessions on Unix terminal. What's New 0.7 (19.12.2019) Basic support for adding ssh

Command-line Tools

Shows signature help from lsp server.

denops-signature.vim Shows signature help from lsp server. Features works in both Vim and Neovim support both vim-lsp and ddc-nvim-lsp support multipl