45 Commits
2.2.1 ... 2.3.0

Author SHA1 Message Date
marty
902faedee2 update version to 2.2.3 2010-12-08 09:37:01 +13:00
marty
4447e9e6e8 update the change log 2010-12-08 09:34:13 +13:00
marty
24c68a6852 complain if the user doesnt have filetype plugins enabled 2010-12-08 09:34:13 +13:00
marty
ecf20b005c use echom instead of echo so the user can check :messages 2010-12-08 09:34:13 +13:00
bryanv
930be32a23 Fix typeo in error message. 2010-09-24 12:57:21 +08:00
bryanv
d54bcbfc98 Fix bug when inverting sexy comments 2010-09-22 12:46:30 +08:00
Seth Woodworth
33e3ace742 updating 'last changed' field of header 2010-09-22 12:45:21 +08:00
marty
c0d7109c6b add gsp support 2010-09-11 10:49:19 +12:00
marty
5c9359d3cf update the doc
Add a note about installation. Remove the 'supported filetypes' section.
2010-08-02 22:45:02 +12:00
marty
02c726c6d1 make the mappings to being with <leader> 2010-08-02 22:45:02 +12:00
marty
d868eae71b refactor the GetLeft/GetRight methods
make their args an optional hash, and rename them to Left and Right
2010-08-02 22:45:02 +12:00
marty
e0191f2ce9 dont use b: vars to store the comment delim data, use a hash 2010-08-02 22:45:02 +12:00
marty
cea72da179 store all the comment delims in a hash, not a giant if statement 2010-08-02 22:45:02 +12:00
James Harris
9c8343c939 Added comment support for tmux.conf
tmux.conf has comments similar to bash, making the default C style
comments inappropriate.
2010-07-21 10:32:04 +08:00
Jon Fuller
a1b4c3b94a use rakefile from nerdtree 2010-07-21 10:31:49 +08:00
marty
4d933f01d6 gitignore the tags file 2010-06-15 10:39:50 +12:00
Tim-Smart
bca88e735b s:CommentLinesSexy - Re-added missing line which prefixes whitespace to top delimiter 2009-09-11 22:11:50 +12:00
Tim-Smart
5d42b2ec5c s:CommentLinesSexy - Fixed issue #2 . Tabs now respected in sexy comments. 2009-09-11 22:11:39 +12:00
Arthur Debert
ae430a62fc Added support for python comments.
Signed-off-by: Martin Grenfell <martin_grenfell@msn.com>
2009-09-11 16:49:19 +08:00
Martin Grenfell
e32c0b9675 switch to version 2.2.2 2009-03-30 18:47:25 +13:00
Martin Grenfell
58480d3d64 update changelog 2009-03-30 18:45:35 +13:00
Martin Grenfell
7239f85de1 add a note about the location of the plugin on github/vim.org 2009-03-30 18:44:06 +13:00
Martin Grenfell
8b712bee60 simplify the credits 2009-03-30 18:42:35 +13:00
Martin Grenfell
8176930f17 remove a useless comment 2009-03-30 18:34:08 +13:00
Martin Grenfell
88d6cc97a9 prefix all b: level vars with NERD 2009-03-30 18:33:15 +13:00
Martin Grenfell
7052ba60f4 remove spaces from delimiters when using &commentstring 2009-03-17 13:31:48 +13:00
Martin Grenfell
b32d2cfad2 remove all filetypes where the same &cms was set in vim 7.0 2009-03-11 15:55:02 +13:00
Martin Grenfell
437af04863 remove all "dummy support" filetypes 2009-03-11 14:55:13 +13:00
Martin Grenfell
eeb369e6be remove NERDShutup and the associated message 2009-03-11 14:51:29 +13:00
Martin Grenfell
b3d4476096 fix railslog filetype 2009-03-06 16:24:49 +13:00
Martin Grenfell
23aa888990 add support for pdf 2009-03-06 16:14:13 +13:00
Martin Grenfell
0bd4d5bbca fix sass delims 2009-03-06 16:12:29 +13:00
Martin Grenfell
11114745bd add support for cucumber 2009-03-06 15:01:02 +13:00
Martin Grenfell
81307ff269 fix the ruby filetype matching again 2009-01-30 15:22:41 +13:00
Martin Grenfell
f63b4f0987 use the ruby settings for all "sub-filetypes" of ruby 2009-01-30 13:20:52 +13:00
Martin Grenfell
4b680f34e9 add support for javascript.jquery 2009-01-15 13:05:49 +13:00
Martin Grenfell
19147a70cc make <%# %> the default for eruby 2009-01-15 12:07:33 +13:00
Martin Grenfell
caefbe56fd add support for javacc 2008-12-14 18:39:55 +13:00
Martin Grenfell
53d437a3c8 refactor out s:spaces 2008-12-09 21:58:48 +13:00
Martin Grenfell
a287b40a67 add support for htmlcheetah 2008-12-07 13:02:58 +13:00
Martin Grenfell
95c368779b add support for mp (metapost) filetype 2008-12-07 12:36:59 +13:00
Martin Grenfell
10c120478c fix alternative sass delimiters 2008-12-02 10:47:30 +13:00
Martin Grenfell
b7d141a3e6 bugfix to delimiter setup 2008-11-21 10:04:44 +13:00
Martin Grenfell
df299e7e22 match filetypes case insensitively 2008-11-17 22:07:41 +13:00
Martin Grenfell
40632f247f add support for dhcpd, limits, ntp, resolv, rgb, sysctl, udevconf, udevrules 2008-11-17 22:03:00 +13:00
4 changed files with 773 additions and 1348 deletions

1
.gitignore vendored
View File

@@ -1,2 +1,3 @@
*~
*.swp
tags

View File

@@ -1,18 +1,76 @@
desc "Copy the vim/doc files into ~/.vim"
task :deploy_local do
run "cp plugin/NERD_commenter.vim ~/.vim/plugin"
run "cp doc/NERD_commenter.txt ~/.vim/doc"
end
# written by travis jeffery <travisjeffery@gmail.com>
# contributions by scrooloose <github:scrooloose>
require 'rake'
require 'find'
require 'pathname'
desc "Create a zip archive for release to vim.org"
IGNORE = [/\.gitignore$/, /Rakefile$/]
files = `git ls-files`.split("\n")
files.reject! { |f| IGNORE.any? { |re| f.match(re) } }
desc 'Zip up the project files'
task :zip do
abort "NERD_commenter.zip already exists, aborting" if File.exist?("NERD_commenter.zip")
run "zip NERD_commenter.zip plugin/NERD_commenter.vim doc/NERD_commenter.txt"
zip_name = File.basename(File.dirname(__FILE__))
zip_name.gsub!(/ /, '_')
zip_name = "#{zip_name}.zip"
if File.exist?(zip_name)
abort("Zip file #{zip_name} already exists. Remove it first.")
end
def run(cmd)
puts "Executing: #{cmd}"
system cmd
puts "Creating zip file: #{zip_name}"
system("zip #{zip_name} #{files.join(" ")}")
end
desc 'Install plugin and documentation'
task :install do
vimfiles = if ENV['VIMFILES']
ENV['VIMFILES']
elsif RUBY_PLATFORM =~ /(win|w)32$/
File.expand_path("~/vimfiles")
else
File.expand_path("~/.vim")
end
files.each do |file|
target_file = File.join(vimfiles, file)
FileUtils.mkdir_p File.dirname(target_file)
FileUtils.cp file, target_file
puts "Installed #{file} to #{target_file}"
end
end
desc 'Pulls from origin'
task :pull do
puts "Updating local repo..."
system("cd " << Dir.new(File.dirname(__FILE__)).path << " && git pull")
end
desc 'Calls pull task and then install task'
task :update => ['pull', 'install'] do
puts "Update of vim script complete."
end
desc 'Uninstall plugin and documentation'
task :uninstall do
vimfiles = if ENV['VIMFILES']
ENV['VIMFILES']
elsif RUBY_PLATFORM =~ /(win|w)32$/
File.expand_path("~/vimfiles")
else
File.expand_path("~/.vim")
end
files.each do |file|
target_file = File.join(vimfiles, file)
FileUtils.rm target_file
puts "Uninstalled #{target_file}"
end
end
task :default => ['update']

View File

@@ -11,37 +11,37 @@
CONTENTS *NERDCommenterContents*
1.Intro...................................|NERDCommenter|
2.Functionality provided..................|NERDComFunctionality|
2.1 Functionality Summary.............|NERDComFunctionalitySummary|
2.2 Functionality Details.............|NERDComFunctionalityDetails|
2.2.1 Comment map.................|NERDComComment|
2.2.2 Nested comment map..........|NERDComNestedComment|
2.2.3 Toggle comment map..........|NERDComToggleComment|
2.2.4 Minimal comment map.........|NERDComMinimalComment|
2.2.5 Invert comment map..........|NERDComInvertComment|
2.2.6 Sexy comment map............|NERDComSexyComment|
2.2.7 Yank comment map............|NERDComYankComment|
2.2.8 Comment to EOL map..........|NERDComEOLComment|
2.2.9 Append com to line map......|NERDComAppendComment|
2.2.10 Insert comment map.........|NERDComInsertComment|
2.2.11 Use alternate delims map...|NERDComAltDelim|
2.2.12 Comment aligned maps.......|NERDComAlignedComment|
2.2.13 Uncomment line map.........|NERDComUncommentLine|
2.3 Supported filetypes...............|NERDComFiletypes|
2.4 Sexy Comments.....................|NERDComSexyComments|
2.5 The NERDComment function..........|NERDComNERDComment|
3.Options.................................|NERDComOptions|
3.1 Options summary...................|NERDComOptionsSummary|
3.2 Options details...................|NERDComOptionsDetails|
3.3 Default delimiter Options.........|NERDComDefaultDelims|
4. Customising key mappings...............|NERDComMappings|
5. Issues with the script.................|NERDComIssues|
5.1 Delimiter detection heuristics....|NERDComHeuristics|
5.2 Nesting issues....................|NERDComNesting|
6.The author..............................|NERDComAuthor|
7.Changelog...............................|NERDComChangelog|
8.Credits.................................|NERDComCredits|
9.License.................................|NERDComLicense|
2.Installation............................|NERDComInstallation|
3.Functionality provided..................|NERDComFunctionality|
3.1 Functionality Summary.............|NERDComFunctionalitySummary|
3.2 Functionality Details.............|NERDComFunctionalityDetails|
3.2.1 Comment map.................|NERDComComment|
3.2.2 Nested comment map..........|NERDComNestedComment|
3.2.3 Toggle comment map..........|NERDComToggleComment|
3.2.4 Minimal comment map.........|NERDComMinimalComment|
3.2.5 Invert comment map..........|NERDComInvertComment|
3.2.6 Sexy comment map............|NERDComSexyComment|
3.2.7 Yank comment map............|NERDComYankComment|
3.2.8 Comment to EOL map..........|NERDComEOLComment|
3.2.9 Append com to line map......|NERDComAppendComment|
3.2.10 Insert comment map.........|NERDComInsertComment|
3.2.11 Use alternate delims map...|NERDComAltDelim|
3.2.12 Comment aligned maps.......|NERDComAlignedComment|
3.2.13 Uncomment line map.........|NERDComUncommentLine|
3.4 Sexy Comments.....................|NERDComSexyComments|
3.5 The NERDComment function..........|NERDComNERDComment|
4.Options.................................|NERDComOptions|
4.1 Options summary...................|NERDComOptionsSummary|
4.2 Options details...................|NERDComOptionsDetails|
4.3 Default delimiter Options.........|NERDComDefaultDelims|
5. Customising key mappings...............|NERDComMappings|
6. Issues with the script.................|NERDComIssues|
6.1 Delimiter detection heuristics....|NERDComHeuristics|
6.2 Nesting issues....................|NERDComNesting|
7.About.. ............................|NERDComAbout|
8.Changelog...............................|NERDComChangelog|
9.Credits.................................|NERDComCredits|
10.License................................|NERDComLicense|
==============================================================================
1. Intro *NERDCommenter*
@@ -54,48 +54,69 @@ There are also options that allow to tweak the commenting engine to your
taste.
==============================================================================
2. Functionality provided *NERDComFunctionality*
2. Installation *NERDComInstallation*
The NERD Commenter requires Vim 7 or higher.
Extract the plugin files in your ~/.vim (*nix) or ~/vimfiles (Windows). You
should have 2 files: >
plugin/NERD_commenter.vim
doc/NERD_commenter.txt
<
Next, to finish installing the help file run: >
:helptags ~/.vim/doc
<
See |add-local-help| for more details.
Make sure that you have filetype plugins enabled, as the script makes use of
|'commentstring'| where possible (which is usually set in a filetype plugin).
See |filetype-plugin-on| for details, but basically, stick this in your vimrc >
filetype plugin on
<
==============================================================================
3. Functionality provided *NERDComFunctionality*
------------------------------------------------------------------------------
2.1 Functionality summary *NERDComFunctionalitySummary*
3.1 Functionality summary *NERDComFunctionalitySummary*
The following key mappings are provided by default (there is also a menu
with items corresponding to all the mappings below):
[count],cc |NERDComComment|
[count]<leader>cc |NERDComComment|
Comment out the current line or text selected in visual mode.
[count],cn |NERDComNestedComment|
Same as ,cc but forces nesting.
[count]<leader>cn |NERDComNestedComment|
Same as <leader>cc but forces nesting.
[count],c<space> |NERDComToggleComment|
[count]<leader>c<space> |NERDComToggleComment|
Toggles the comment state of the selected line(s). If the topmost selected
line is commented, all selected lines are uncommented and vice versa.
[count],cm |NERDComMinimalComment|
[count]<leader>cm |NERDComMinimalComment|
Comments the given lines using only one set of multipart delimiters.
[count],ci |NERDComInvertComment|
[count]<leader>ci |NERDComInvertComment|
Toggles the comment state of the selected line(s) individually.
[count],cs |NERDComSexyComment|
[count]<leader>cs |NERDComSexyComment|
Comments out the selected lines ``sexily''
[count],cy |NERDComYankComment|
Same as ,cc except that the commented line(s) are yanked first.
[count]<leader>cy |NERDComYankComment|
Same as <leader>cc except that the commented line(s) are yanked first.
,c$ |NERDComEOLComment|
<leader>c$ |NERDComEOLComment|
Comments the current line from the cursor to the end of line.
,cA |NERDComAppendComment|
<leader>cA |NERDComAppendComment|
Adds comment delimiters to the end of line and goes into insert mode between
them.
@@ -105,26 +126,26 @@ Adds comment delimiters at the current cursor position and inserts between.
Disabled by default.
,ca |NERDComAltDelim|
<leader>ca |NERDComAltDelim|
Switches to the alternative set of delimiters.
[count],cl
[count],cb |NERDComAlignedComment|
[count]<leader>cl
[count]<leader>cb |NERDComAlignedComment|
Same as |NERDComComment| except that the delimiters are aligned down the
left side (,cl) or both sides (,cb).
left side (<leader>cl) or both sides (<leader>cb).
[count],cu |NERDComUncommentLine|
[count]<leader>cu |NERDComUncommentLine|
Uncomments the selected line(s).
------------------------------------------------------------------------------
2.2 Functionality details *NERDComFunctionalityDetails*
3.2 Functionality details *NERDComFunctionalityDetails*
------------------------------------------------------------------------------
2.2.1 Comment map *NERDComComment*
3.2.1 Comment map *NERDComComment*
Default mapping: [count],cc
Default mapping: [count]<leader>cc
Mapped to: <plug>NERDCommenterComment
Applicable modes: normal visual visual-line visual-block.
@@ -138,14 +159,14 @@ If a [count] is given in normal mode, the mapping works as though that many
lines were selected in visual-line mode.
------------------------------------------------------------------------------
2.2.2 Nested comment map *NERDComNestedComment*
3.2.2 Nested comment map *NERDComNestedComment*
Default mapping: [count],cn
Default mapping: [count]<leader>cn
Mapped to: <plug>NERDCommenterNest
Applicable modes: normal visual visual-line visual-block.
Performs nested commenting. Works the same as ,cc except that if a line is
already commented then it will be commented again.
Performs nested commenting. Works the same as <leader>cc except that if a line
is already commented then it will be commented again.
If |'NERDUsePlaceHolders'| is set then the previous comment delimiters will
be replaced by place-holder delimiters if needed. Otherwise the nested
@@ -159,9 +180,9 @@ Related options:
|'NERDDefaultNesting'|
------------------------------------------------------------------------------
2.2.3 Toggle comment map *NERDComToggleComment*
3.2.3 Toggle comment map *NERDComToggleComment*
Default mapping: [count],c<space>
Default mapping: [count]<leader>c<space>
Mapped to: <plug>NERDCommenterToggle
Applicable modes: normal visual-line.
@@ -176,17 +197,17 @@ If a [count] is given in normal mode, the mapping works as though that many
lines were selected in visual-line mode.
------------------------------------------------------------------------------
2.2.4 Minimal comment map *NERDComMinimalComment*
3.2.4 Minimal comment map *NERDComMinimalComment*
Default mapping: [count],cm
Default mapping: [count]<leader>cm
Mapped to: <plug>NERDCommenterMinimal
Applicable modes: normal visual-line.
Comments the selected lines using one set of multipart delimiters if possible.
For example: if you are programming in c and you select 5 lines and press ,cm
then a '/*' will be placed at the start of the top line and a '*/' will be
placed at the end of the last line.
For example: if you are programming in c and you select 5 lines and press
<leader>cm then a '/*' will be placed at the start of the top line and a '*/'
will be placed at the end of the last line.
Sets of multipart comment delimiters that are between the top and bottom
selected lines are replaced with place holders (see |'NERDLPlace'|) if
@@ -198,9 +219,9 @@ If a [count] is given in normal mode, the mapping works as though that many
lines were selected in visual-line mode.
------------------------------------------------------------------------------
2.2.5 Invert comment map *NERDComInvertComment*
3.2.5 Invert comment map *NERDComInvertComment*
Default mapping: ,ci
Default mapping: <leader>ci
Mapped to: <plug>NERDCommenterInvert
Applicable modes: normal visual-line.
@@ -215,9 +236,9 @@ If a [count] is given in normal mode, the mapping works as though that many
lines were selected in visual-line mode.
------------------------------------------------------------------------------
2.2.6 Sexy comment map *NERDComSexyComment*
3.2.6 Sexy comment map *NERDComSexyComment*
Default mapping: [count],cs
Default mapping: [count]<leader>cs
Mapped to: <plug>NERDCommenterSexy
Applicable modes: normal, visual-line.
@@ -235,18 +256,18 @@ Related options:
|'NERDCompactSexyComs'|
------------------------------------------------------------------------------
2.2.7 Yank comment map *NERDComYankComment*
3.2.7 Yank comment map *NERDComYankComment*
Default mapping: [count],cy
Default mapping: [count]<leader>cy
Mapped to: <plug>NERDCommenterYank
Applicable modes: normal visual visual-line visual-block.
Same as ,cc except that it yanks the line(s) that are commented first.
Same as <leader>cc except that it yanks the line(s) that are commented first.
------------------------------------------------------------------------------
2.2.8 Comment to EOL map *NERDComEOLComment*
3.2.8 Comment to EOL map *NERDComEOLComment*
Default mapping: ,c$
Default mapping: <leader>c$
Mapped to: <plug>NERDCommenterToEOL
Applicable modes: normal.
@@ -254,9 +275,9 @@ Comments the current line from the current cursor position up to the end of
the line.
------------------------------------------------------------------------------
2.2.9 Append com to line map *NERDComAppendComment*
3.2.9 Append com to line map *NERDComAppendComment*
Default mapping: ,cA
Default mapping: <leader>cA
Mapped to: <plug>NERDCommenterAppend
Applicable modes: normal.
@@ -264,7 +285,7 @@ Appends comment delimiters to the end of the current line and goes
to insert mode between the new delimiters.
------------------------------------------------------------------------------
2.2.10 Insert comment map *NERDComInsertComment*
3.2.10 Insert comment map *NERDComInsertComment*
Default mapping: disabled by default.
Map it to: <plug>NERDCommenterInInsert
@@ -280,37 +301,37 @@ mapping add >
to your vimrc.
------------------------------------------------------------------------------
2.2.11 Use alternate delims map *NERDComAltDelim*
3.2.11 Use alternate delims map *NERDComAltDelim*
Default mapping: ,ca
Default mapping: <leader>ca
Mapped to: <plug>NERDCommenterAltDelims
Applicable modes: normal.
Changes to the alternative commenting style if one is available. For example,
if the user is editing a c++ file using // comments and they hit ,ca
if the user is editing a c++ file using // comments and they hit <leader>ca
then they will be switched over to /**/ comments.
See also |NERDComDefaultDelims|
------------------------------------------------------------------------------
2.2.12 Comment aligned maps *NERDComAlignedComment*
3.2.12 Comment aligned maps *NERDComAlignedComment*
Default mappings: [count],cl [count],cb
Default mappings: [count]<leader>cl [count]<leader>cb
Mapped to: <plug>NERDCommenterAlignLeft
<plug>NERDCommenterAlignBoth
Applicable modes: normal visual-line.
Same as ,cc except that the comment delimiters are aligned on the left side or
both sides respectively. These comments are always nested if the line(s) are
already commented.
Same as <leader>cc except that the comment delimiters are aligned on the left
side or both sides respectively. These comments are always nested if the
line(s) are already commented.
If a [count] is given in normal mode, the mapping works as though that many
lines were selected in visual-line mode.
------------------------------------------------------------------------------
2.2.13 Uncomment line map *NERDComUncommentLine*
3.2.13 Uncomment line map *NERDComUncommentLine*
Default mapping: [count],cu
Default mapping: [count]<leader>cu
Mapped to: <plug>NERDCommenterUncomment
Applicable modes: normal visual visual-line visual-block.
@@ -331,41 +352,7 @@ Related options:
|'NERDRemoveExtraSpaces'|
------------------------------------------------------------------------------
2.3 Supported filetypes *NERDComFiletypes*
Filetypes that can be commented by this plugin:
abaqus abc acedb ada ahdl amiga aml ampl ant apache apachestyle asm68k asm asn
aspvbs atlas autohotkey autoit automake ave awk basic b bc bdf bib bindzone
bst btm caos catalog c cfg cg ch changelog cl clean clipper cmake conf config
context cpp crontab cs csc csp css cterm cupl csv cvs dcl debchangelog
debcontrol debsources def diff django docbk dns dosbatch dosini dot dracula
dsl dtd dtml dylan ecd eiffel elf elmfilt erlang eruby eterm expect exports
fetchmail fgl focexec form fortran foxpro fstab fvwm fx gdb gdmo geek
gentoo-package-keywords' gentoo-package-mask' gentoo-package-use' gnuplot
gtkrc haskell hb h help hercules hog html htmldjango htmlos ia64 icon idlang
idl indent inform inittab ishd iss ist jam java javascript jess jgraph
jproperties jproperties jsp kconfig kix kscript lace lex lftp lifelines lilo
lisp lite lotos lout lprolog lscript lss lua lynx m4 mail make maple masm
master matlab mel mf mib mma model moduala. modula2 modula3 monk mush muttrc
named nasm nastran natural ncf netdict netrw nqc nroff nsis objc ocaml occam
omlet omnimark openroad opl ora otl ox pascal passwd pcap pccts perl pfmain
php phtml pic pike pilrc pine plaintex plm plsql po postscr pov povini ppd
ppwiz procmail progress prolog psf ptcap python python qf radiance ratpoison r
rc readline rebol registry remind rexx robots rpl rtf ruby sa samba sas sass
sather scheme scilab screen scsh sdl sed selectbuf sgml sgmldecl sgmllnx sh
sicad simula sinda skill slang sl slrnrc sm smarty smil smith sml snnsnet
snnspat snnsres snobol4 spec specman spice sql sqlforms sqlj sqr squid st stp
strace svn systemverilog tads taglist tags tak tasm tcl terminfo tex text
plaintex texinfo texmf tf tidy tli trasys tsalt tsscl tssgm uc uil vb verilog
verilog_systemverilog vgrindefs vhdl vim viminfo virata vo_base vrml vsejcl
webmacro wget winbatch wml wvdial xdefaults xf86conf xhtml xkb xmath xml
xmodmap xpm2 xpm xslt yacc yaml z8a
If a language is not in the list of hardcoded supported filetypes then the
&commentstring vim option is used.
------------------------------------------------------------------------------
2.4 Sexy Comments *NERDComSexyComments*
3.3 Sexy Comments *NERDComSexyComments*
These are comments that use one set of multipart comment delimiters as well as
one other marker symbol. For example: >
/*
@@ -380,7 +367,7 @@ one other marker symbol. For example: >
Here the multipart delimiters are /* and */ and the marker is *.
------------------------------------------------------------------------------
2.5 The NERDComment function *NERDComNERDComment*
3.4 The NERDComment function *NERDComNERDComment*
All of the NERD commenter mappings and menu items invoke a single function
which delegates the commenting work to other functions. This function is
@@ -404,10 +391,10 @@ then the script would do a sexy comment on the last visual selection.
==============================================================================
3. Options *NERDComOptions*
4. Options *NERDComOptions*
------------------------------------------------------------------------------
3.1 Options summary *NERDComOptionsSummary*
4.1 Options summary *NERDComOptionsSummary*
|'loaded_nerd_comments'| Turns off the script.
|'NERDAllowAnyVisualDelims'| Allows multipart alternative delims to
@@ -436,8 +423,6 @@ then the script would do a sexy comment on the last visual selection.
|'NERDRPlace'| Specifies what to use as the right
delimiter placeholder when nesting
comments.
|'NERDShutUp'| Stops "Unknown filetype" output from the
script
|'NERDSpaceDelims'| Specifies whether to add extra spaces
around delimiters when commenting, and
whether to remove them when
@@ -446,7 +431,7 @@ then the script would do a sexy comment on the last visual selection.
style sexy comments.
------------------------------------------------------------------------------
3.3 Options details *NERDComOptionsDetails*
4.3 Options details *NERDComOptionsDetails*
To enable any of the below options you should put the given line in your
~/.vimrc
@@ -583,7 +568,7 @@ this option tells the script whether to look for, and remove, comment
delimiters of the alternative style.
For example, if you are editing a c++ file using // style comments and you go
,cu on this line: >
<leader>cu on this line: >
/* This is a c++ comment baby! */
<
It will not be uncommented if the NERDRemoveAltComs is set to 0.
@@ -635,7 +620,7 @@ To set these options use lines like: >
Following the above example, if we have line of c code: >
/* int horse */
<
and we comment it with ,cn it will be changed to: >
and we comment it with <leader>cn it will be changed to: >
/*FOO int horse BAR*/
<
When we uncomment this line it will go back to what it was.
@@ -659,15 +644,6 @@ Default 1.
This option is used to specify whether place-holder delimiters should be used
when creating a nested comment.
------------------------------------------------------------------------------
*'NERDShutUp'*
Values: 0 or 1.
Default 1.
This option is used to prevent the script from echoing "Unknown filetype"
messages. Stick this line in your vimrc: >
let NERDShutUp=1
<
------------------------------------------------------------------------------
*'NERDSpaceDelims'*
Values: 0 or 1.
@@ -709,7 +685,8 @@ Values: 0 or 1.
Default 1.
When this option is set to 1, comments are nested automatically. That is, if
you hit ,cc on a line that is already commented it will be commented again
you hit <leader>cc on a line that is already commented it will be commented
again.
------------------------------------------------------------------------------
3.3 Default delimiter customisation *NERDComDefaultDelims*
@@ -726,7 +703,7 @@ Example: java uses // style comments by default, but you want it to default to
See |NERDComAltDelim| for switching commenting styles at runtime.
==============================================================================
4. Key mapping customisation *NERDComMappings*
5. Key mapping customisation *NERDComMappings*
To change a mapping just map another key combo to the internal <plug> mapping.
For example, to remap the |NERDComComment| mapping to ",omg" you would put
@@ -741,11 +718,11 @@ map to.
See also |'NERDCreateDefaultMappings'|.
==============================================================================
5. Issues with the script *NERDComIssues*
6. Issues with the script *NERDComIssues*
------------------------------------------------------------------------------
5.1 Delimiter detection heuristics *NERDComHeuristics*
6.1 Delimiter detection heuristics *NERDComHeuristics*
Heuristics are used to distinguish the real comment delimiters
@@ -765,7 +742,7 @@ string. These heuristics, while usually pretty accurate, will not work for all
cases.
------------------------------------------------------------------------------
5.2 Nesting issues *NERDComNesting*
6.2 Nesting issues *NERDComNesting*
If we have some line of code like this: >
/*int foo */ = /*5 + 9;*/
@@ -785,7 +762,7 @@ will become: >
for simplicity)
==============================================================================
6. The author *NERDComAuthor*
7. About *NERDComAbout*
The author of the NERD commenter is Martyzillatron --- the half robot, half
dinosaur bastard son of Megatron and Godzilla. He enjoys destroying
@@ -795,9 +772,38 @@ Drop him a line at martin_grenfell at msn.com. He would love to hear from you.
its a lonely life being the worlds premier terror machine. How would you feel
if your face looked like a toaster and a t-rex put together? :(
The latest stable versions can be found at
http://www.vim.org/scripts/script.php?script_id=1218
The latest dev versions are on github
http://github.com/scrooloose/nerdcommenter
==============================================================================
8. Changelog *NERDComChangelog*
2.2.3
- remove all filetypes which have a &commentstring in the standard vim
runtime for vim > 7.0 unless the script stores an alternate set of
delimiters
- make the script complain if the user doesnt have filetype plugins enabled
- use <leader> instead of comma to start the default mappings
- fix a couple of bugs with sexy comments - thanks to Tim Smart
- lots of refactoring
2.2.2
- remove the NERDShutup option and the message is suppresses, this makes
the plugin silently rely on &commentstring for unknown filetypes.
- add support for dhcpd, limits, ntp, resolv, rgb, sysctl, udevconf and
udevrules. Thanks to Thilo Six.
- match filetypes case insensitively
- add support for mp (metapost), thanks to Andrey Skvortsov.
- add support for htmlcheetah, thanks to Simon Hengel.
- add support for javacc, thanks to Matt Tolton.
- make <%# %> the default delims for eruby, thanks to tpope.
- add support for javascript.jquery, thanks to Ivan Devat.
- add support for cucumber and pdf. Fix sass and railslog delims,
thanks to tpope
2.2.1
- add support for newlisp and clojure, thanks to Matthew Lee Hinman.
- fix automake comments, thanks to Elias Pipping
@@ -839,143 +845,56 @@ if your face looked like a toaster and a t-rex put together? :(
NERDComInsertComment if you wish to restore it
==============================================================================
8. Credits *NERDComCredits*
9. Credits *NERDComCredits*
Thanks and respect to the following people:
Thanks to the follow people for suggestions and patches:
Thanks to Nick Brettell for his many ideas and criticisms. A bloody good
bastard.
:normal :.-2s/good//
Nick Brettell
Matthew Hawkins
Mathieu Clabaut
Greg Searle
Nguyen
Litchi
Jorge Scandaliaris
Shufeng Zheng
Martin Stubenschrott
Markus Erlmann
Brent Rice
Richard Willis
Igor Prischepoff
Harry
David Bourgeois
Eike Von Seggern
Torsten Blix
Alexander Bosecke
Stefano Zacchiroli
Norick Chen
Joseph Barker
Gary Church
Tim Carey-Smith
Markus Klinik
Anders
Seth Mason
James Hales
Heptite
Cheng Fang
Yongwei Wu
David Miani
Jeremy Hinegardner
Marco
Ingo Karkat
Zhang Shuhan
tpope
Ben Schmidt
David Fishburn
Erik Falor
JaGoTerr
Elias Pipping
mntnoe
Mark S.
Thanks to Matthew Hawkins for his awesome refactoring!
Thanks to the authors of the vimspell whose documentation
installation function I stole :)
Thanks to Greg Searle for the idea of using place-holders for nested comments.
Thanks to Nguyen for the suggestions and pointing the h file highlighting bug!
Also, thanks for the idea of doing sexy comments as well as his suggestions
relating to it :P
Thanks again to Nguyen for complaining about the NERD_comments menu mapping
(<Alt>-c) interfering with another mapping of his... and thus the
NERD_dont_create_menu_shortcut option was born :P
(it was then replaced with NERD_menu_mode in version 1.67 :)
Cheers to Litchi for the idea of having a mapping that appends a comment to
the current line :)
Thanks to jorge scandaliaris and Shufeng Zheng for telling me about some
problems with commenting in visual mode. Thanks again to Jorge for his
continued suggestions on this matter :)
Thanks to Martin Stubenschrott for pointing out a bug with the <C-c> mapping
:) Ive gotta stop breaking this mapping!
Thanks to Markus Erlmann for pointing out a conflict that this script was
having with the taglist plugin.
Thanks to Brent Rice for alerting me about, and helping me track down, a bug
in the script when the "ignorecase" option in vim was set.
Thanks to Richard Willis for telling me about how line continuation was
causing problems on cygwin. Also, thanks pointing out a bug in the help file
and for suggesting // comments for c (its about time SOMEONE did :P). May ANSI
have mercy on your soul :)
Thanks to Igor Prischepoff for suggesting that i implement "toggle comments".
Also, thanks for his suggested improvements about toggle comments after i
implemented them.
Thanks to harry for telling me that i broke the <leader>cn mapping in 1.53 :),
and thanks again for telling me about a bug that occurred when editing a file
in a new tab.
Thanks to Martin (Krischikim?) for his patch that fixed a bug with the doc
install function and added support for ada comments with spaces as well as
making a couple of other small changes.
Thanks to David Bourgeois for pointing out a bug with when commenting c files
:)... [a few days later] ok i completely misunderstood what David was talking
about and ended up fixing a completely different bug to what he was talking
about :P
Thanks to David Bourgeois for pointing out a bug when changing buffers.
Cheers to Eike Von Seggern for sending me a patch to fix a bug in 1.60 that
was causing spaces to be added to the end of lines with single-part
delimiters. It's nice when people do my work for me :D
Thanks to Torsten Blix for telling me about a couple of bugs when uncommenting
sexy comments. Sexy comments dont look so sexy when they are only half removed
:P
Thanks to Alexander "boesi" Bosecke for pointing out a bug that was stopping
the NERD_space_delim_filetype_regexp option from working with left aligned
toggle comments. And for pointing out a bug when initialising VB comments.
Thanks to Stefano Zacchiroli for suggesting the idea of "Minimal comments".
And for suggested improvements to minimal comments.
Thanks to Norick Chen for emailing in a patch that fixed the asp delimiters.
In 1.65
Thanks to Joseph Barker for the sugesting that the menu be an optional
feature.
Thanks to Gary Church and Tim Carey-Smith for complaining about the
keymappings and causing me to introduce the NERD_mapleader option :)
Thanks to Markus Klinik for emailing me about a bug for sexy comments where
spaces were being eaten.
Thanks to Anders for emailing me a patch to help get rid of all the visual
bells and screen scrolling.
Thanks to Anders and Markus Klinik for emailing me about the screen scrolling
issues and finally getting me off my ass about them :P
Thanks to Seth Mason for sending me a patch to fix some pathing issues for the
help doc installation.
Cheers to James Hales for the patch that made the comment maps work better with
counts, and made the script reset comment delims for a buffer when its
filetype changes.
Cheers to heptite on #vim for helping me track down some tab-space conversion
bugs.
Cheers to Cheng Fang for the bug reports :D
Cheers to Yongwei Wu for a bug report about the passwd filetype.
Thanks to David Miani for reporting a space-removal bug when using the
NERDSpaceDelims option.
Thanks to Jeremy Hinegardner for emailing me about a bug with aligned
comments and the NERDSpaceDelims option.
Thanks to marco for suggesting NERDDefaultNesting be set by default.
Thanks to Ingo Karkat for the bug reports and the bugfix patch.
Thanks to Zhang Shuhan for sending me a report about spaces not being removed
properly in some circumstances. Also, thanks for emailing me a bunch of bug
reports about sexy/toggle comments and for testing my fixes.
Thanks to tpope for the english lesson.
Thanks to Ben Schmidt, David Fishburn, and Erik Falor for emailing me about an
incompatibility with vim7.2. Thanks also to JaGoTerr for posting the issue.
Thanks to Elias Pipping for sending me a bug report about haskell commenting.
Thanks to mntnoe for pointing out incorrect delimiters for haskell.
Thanks to Mark S. for pointing out a bug in the doc.
Not to forget! Thanks to the following people for sending me new filetypes to
support :D
Thanks to the following people for sending me new filetypes to support:
The hackers The filetypes~
Sam R verilog
@@ -1055,9 +974,15 @@ David conkyrc
Miguel Jaque Barbero SVNannotate
Stefan Walk sieve
Adam Thorsen objj
Thilo Six dhcpd, limits, ntp, resolv, rgb, sysctl,
udevconf, udevrules
Andrey Skvortsov mp
Simon Hengel htmlcheetah
Matt Tolton javacc
Ivan Devat javascript.jquery
tpope cucumber,pdf
==============================================================================
9. License *NERDComLicense*
10. License *NERDComLicense*
The NERD commenter is released under the wtfpl.
See http://sam.zoy.org/wtfpl/COPYING.

File diff suppressed because it is too large Load Diff