Homepage: http://github.com/redguardtoo/evil-nerd-commenter
Author: Chen Bin
Updated:
Comment/uncomment lines efficiently. Like Nerd Commenter in Vim
This program emulates nerd-commenter.vim by Marty Grenfell.
It helps you comment/uncomment multiple lines without selecting them.
`M-x evilnc-default-hotkeys` assigns hotkey `M-;` to
`evilnc-comment-or-uncomment-lines'
`M-x evilnc-comment-or-uncomment-lines` comment or uncomment lines.
`M-x evilnc-quick-comment-or-uncomment-to-the-line` will comment/uncomment
from current line to specified line.
The last digit(s) of line number is parameter of the command.
For example, `C-u 9 evilnc-quick-comment-or-uncomment-to-the-line` comments
code from current line to line 99 if you current line is 91.
Though this program could be used *independently*, though I highly recommend
using it with Evil (https://bitbucket.org/lyro/evil/)
Evil makes you take advantage of power of Vi to comment lines.
For example, you can press key `99,ci` to comment out 99 lines.
Setup:
If comma is your leader key, as most Vim users do, setup is one liner,
(evilnc-default-hotkeys)
If you use evil-leader and its default leader key,
insert below setup into your ~/.emacs instead,
(global-set-key (kbd "M-;") 'evilnc-comment-or-uncomment-lines)
(require 'evil-leader)
(global-evil-leader-mode)
(evil-leader/set-key
"ci" 'evilnc-comment-or-uncomment-lines
"cl" 'evilnc-quick-comment-or-uncomment-to-the-line
"ll" 'evilnc-quick-comment-or-uncomment-to-the-line
;; Or use `evilnc-comment-and-kill-ring-save' instead
"cc" 'evilnc-copy-and-comment-lines
"cp" 'evilnc-comment-or-uncomment-paragraphs
"cr" 'comment-or-uncomment-region
"cv" 'evilnc-toggle-invert-comment-line-by-line
"." 'evilnc-copy-and-comment-operator
"\\" 'evilnc-comment-operator)
`evilnc-comment-or-uncomment-html-tag' comment/uncomment html tag(s).
`evilnc-comment-or-uncomment-html-paragraphs' comment/uncomment paragraphs
containing html tags.
You can setup `evilnc-original-above-comment-when-copy-and-comment'
to decide which style to use when `evilnc-copy-and-comment-lines'
or `evilnc-copy-and-comment-operator',
- Place the commented out text above original text
- Or place the original text above commented out text
`evilnc-yank-and-comment-operator' (un)comment&yank text in one shot.
Comment text object "c" is defined. It can have multi-lines.
Press "vac" to select outer object (comment with limiters).
Press "vic" to select inner object (comment without limiter).
You can assign other key instead of "c" to the text object by
customizing `evilnc-comment-text-object'. Either,
(setq evilnc-comment-text-object "c")
(evilnc-default-hotkeys)
Or,
(setq evilnc-comment-text-object "a")
(define-key evil-inner-text-objects-map evilnc-comment-text-object 'evilnc-inner-commenter)
(define-key evil-outer-text-objects-map evilnc-comment-text-object 'evilnc-outer-commenter)
You can list of comments in current buffer through using imenu.
by setup `imenu-create-index-function' to `evilnc-imenu-create-index-function',
(defun counsel-imenu-comments ()
(interactive)
(let* ((imenu-create-index-function 'evilnc-imenu-create-index-function))
(unless (featurep 'counsel) (require 'counsel))
(counsel-imenu)))
For certain major modes, you need manual setup to override its original
keybindings,
(defun matlab-mode-hook-config ()
(local-set-key (kbd "M-;") 'evilnc-comment-or-uncomment-lines))
(add-hook 'matlab-mode-hook 'matlab-mode-hook-config)
Most commands call `evilnc-comment-or-uncomment-region-function'.
You can modify this variable to customize the comment style,
(with-eval-after-load 'evil-nerd-commenter
(defun my-comment-or-uncomment-region (start end)
(let* ((comment-start "aaa")
(comment-end "bbb"))
(evilnc-comment-or-uncomment-region-internal start end)))
(setq evilnc-comment-or-uncomment-region-function
'my-comment-or-uncomment-region))
See "Options Controlling Comments" in Emacs manual for comment options.
See https://github.com/redguardtoo/evil-nerd-commenter for detail.