1
0
Fork 0
mirror of synced 2024-11-05 00:48:57 -05:00
ultimate-vim/bundle/vim-commentary
2014-05-09 21:28:39 +02:00
..
doc renamed sources_non_forked folder to bundle 2014-05-09 21:28:39 +02:00
plugin renamed sources_non_forked folder to bundle 2014-05-09 21:28:39 +02:00
.gitignore renamed sources_non_forked folder to bundle 2014-05-09 21:28:39 +02:00
CONTRIBUTING.markdown renamed sources_non_forked folder to bundle 2014-05-09 21:28:39 +02:00
README.markdown renamed sources_non_forked folder to bundle 2014-05-09 21:28:39 +02:00

commentary.vim

Comment stuff out. Use gcc to comment out a line (takes a count), gc to comment out the target of a motion (for example, gcap to comment out a paragraph), and gc in visual mode to comment out the selection. That's it.

I wrote this because 5 years after Vim added support for mapping an operator, I still couldn't find a commenting plugin that leveraged that feature (I overlooked tcomment.vim). Striving for minimalism, it weighs in at under 100 lines of code.

Oh, and it uncomments, too. The above maps actually toggle, and gcu uncomments a set of adjacent commented lines. Install repeat.vim to enable repeating gcu with .. (The other maps are repeatable without it.)

Installation

If you don't have a preferred installation method, I recommend installing pathogen.vim, and then simply copy and paste:

cd ~/.vim/bundle
git clone git://github.com/tpope/vim-commentary.git

Once help tags have been generated, you can view the manual with :help commentary.

FAQ

My favorite file type isn't supported!

Relax! You just have to adjust 'commentstring':

autocmd FileType apache set commentstring=#\ %s

Self-Promotion

Like commentary.vim? Follow the repository on GitHub and vote for it on vim.org. And if you're feeling especially charitable, follow tpope on Twitter and GitHub.

License

Copyright (c) Tim Pope. Distributed under the same terms as Vim itself. See :help license.