nvim-ts-autotag/README.md

82 lines
1.5 KiB
Markdown
Raw Normal View History

2021-03-08 06:19:01 -06:00
# nvim-ts-autotag
Use treesitter to **autoclose** and **autorename** html tag
2021-03-08 06:19:01 -06:00
2021-06-09 08:43:17 -05:00
It work with html,tsx,vue,svelte,php.
2021-03-07 21:47:09 -06:00
## Usage
``` text
Before Input After
------------------------------------
2021-03-08 08:20:19 -06:00
<div > <div></div>
2021-03-18 18:17:27 -05:00
<div></div> ciwspan <span></span>
2021-03-07 21:47:09 -06:00
------------------------------------
```
2021-03-08 06:19:01 -06:00
2021-03-07 21:47:09 -06:00
## Setup
2021-04-25 00:08:46 -05:00
Neovim 0.5 and nvim-treesitter to work
2021-03-07 21:47:09 -06:00
2021-03-10 00:09:41 -06:00
User treesitter setup
```lua
require'nvim-treesitter.configs'.setup {
autotag = {
enable = true,
}
}
```
or you can use a set up function
2021-03-07 21:47:09 -06:00
``` lua
2021-03-08 08:18:10 -06:00
require('nvim-ts-autotag').setup()
2021-03-10 00:09:41 -06:00
2021-03-07 21:47:09 -06:00
```
2021-06-17 00:33:40 -05:00
# Enable update on insert
if you have that issue on you need to tell lsp diagnostic update in insert
```lua
vim.lsp.handlers['textDocument/publishDiagnostics'] = vim.lsp.with(
vim.lsp.diagnostic.on_publish_diagnostics,
{
underline = true,
virtual_text = {
spacing = 5,
severity_limit = 'Warning',
},
update_in_insert = true,
}
)
```
2021-03-07 21:47:09 -06:00
## Default values
``` lua
local filetypes = {
'html', 'javascript', 'javascriptreact', 'typescriptreact', 'svelte', 'vue'
2021-03-07 21:47:09 -06:00
}
local skip_tags = {
'area', 'base', 'br', 'col', 'command', 'embed', 'hr', 'img', 'slot',
'input', 'keygen', 'link', 'meta', 'param', 'source', 'track', 'wbr','menuitem'
}
```
### Override default values
``` lua
2021-03-10 00:09:41 -06:00
require'nvim-treesitter.configs'.setup {
autotag = {
enable = true,
filetypes = { "html" , "xml" },
}
}
-- OR
2021-03-08 22:57:14 -06:00
require('nvim-ts-autotag').setup({
2021-03-07 21:47:09 -06:00
filetypes = { "html" , "xml" },
})
2021-03-10 00:09:41 -06:00
```