https://github.com/alvan/vim-closetag

Auto close (X)HTML tags
https://github.com/alvan/vim-closetag

automate tag vim

Last synced: about 2 months ago
JSON representation

Auto close (X)HTML tags

• Host: GitHub
• URL: https://github.com/alvan/vim-closetag
• Owner: alvan
• Created: 2014-07-21T16:50:12.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-06-01T16:58:01.000Z (8 months ago)
• Last Synced: 2024-08-08T16:15:19.754Z (6 months ago)
• Topics: automate, tag, vim
• Language: Vim script
• Homepage:
• Size: 35.2 KB
• Stars: 745
• Watchers: 7
• Forks: 49
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
closetag.vim

============

### Usage

The current content:

```vim

>, the content will be:

```vim

|

```

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

```vim

    |

```

The following tags will not be closed:

```html

, , 
, , , , 
, , 

, , , , , , , ,

```


### Installation

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

* Use vundle:

```vim

Plugin 'alvan/vim-closetag'

```

* Use other package manager.

### Commands

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

```vim

:CloseTagToggleBuffer

:CloseTagEnableBuffer

:CloseTagDisableBuffer

```

### Options

Set in your vimrc:

```vim

" 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. `` will be closed while `` 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 = '>'

```

### 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`:

```vim

" 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

```