Skip to content

Latest commit

 

History

History
132 lines (97 loc) · 2.74 KB

README.md

File metadata and controls

132 lines (97 loc) · 2.74 KB
Raw

closetag.vim

Usage

The current content:

<table|

Now you press >, the content will be:

<table>|</table>

And then if you press > again, the content will be:

<table>
    |
</table>

The following tags will not be closed:

<area>, <base>, <br>, <col>, <command>, <embed>, <hr>, <img>, 
<input>, <keygen>, <link>, <meta>, <param>, <source>, <track>, <wbr>,<menuitem>

Installation

  • Just put the files into ~/.vim/ or <HOMEDIR>\vimfiles\ (for Windows).

  • Use vundle:

Plugin 'alvan/vim-closetag'
  • Use other package manager.

Commands

Use these commands to toggle/enable/disable this function for the current buffer:

:CloseTagToggleBuffer
:CloseTagEnableBuffer
:CloseTagDisableBuffer

Options

Set in your vimrc:

" filenames like *.xml, *.html, *.xhtml, ...
" These are the file extensions where this plugin is enabled.
"
let g:closetag_filenames = '*.html,*.xhtml,*.phtml'

" filenames like *.xml, *.xhtml, ...
" This will make the list of non-closing tags self-closing in the specified files.
"
let g:closetag_xhtml_filenames = '*.xhtml,*.jsx'

" filetypes like xml, html, xhtml, ...
" These are the file types where this plugin is enabled.
"
let g:closetag_filetypes = 'html,xhtml,phtml'

" filetypes like xml, xhtml, ...
" This will make the list of non-closing tags self-closing in the specified files.
"
let g:closetag_xhtml_filetypes = 'xhtml,jsx'

" integer value [0|1]
" This will make the list of non-closing tags case-sensitive (e.g. `<Link>` will be closed while `<link>` won't.)
"
let g:closetag_emptyTags_caseSensitive = 1

" dict
" Disables auto-close if not in a "valid" region (based on filetype)
"
let g:closetag_regions = {
    \ 'typescript.tsx': 'jsxRegion,tsxRegion',
    \ 'javascript.jsx': 'jsxRegion',
    \ 'typescriptreact': 'jsxRegion,tsxRegion',
    \ 'javascriptreact': 'jsxRegion',
    \ }

" Shortcut for closing tags, default is '>'
"
let g:closetag_shortcut = '>'

" Add > at current position without closing the current tag, default is ''
"
let g:closetag_close_shortcut = '<leader>>'

Note about React fragments

By default, React fragments are automatically closed only when a React file is open.

When editing a .html file you will get:

<|
<>|

When editing a .{t,j}sx file you will get:

<|
<>|</>

To override this behavior, you can set the global g:closetag_enable_react_fragment in your .vimrc:

" integer value [0|1]
" Enables closing tags for React fragments -> <></> for all supported file types
"
let g:closetag_enable_react_fragment = 1
" Disable closing tags for React fragments -> <></> for all supported file types
"
let g:closetag_enable_react_fragment = 0