diff --git a/README.md b/README.md index 2672406..c1f23e4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ +
+

+and in this corner... +

+
+ # vim match-up match-up is a plugin that lets you highlight, navigate, and operate on sets of matching text. It extends vim's `%` key to language-specific words instead of just single characters. -and in this corner... +[![Gitter](https://badges.gitter.im/vim-matchup/community.svg)](https://gitter.im/vim-matchup/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ## Screenshot @@ -38,18 +44,19 @@ more information. This plugin: - Extends vim's `%` motion to language-specific words. The following vim file type plugins currently provide special support for match-up: - > abaqus, ada, aspvbs, bash, c, cpp, chicken, clojure, cmake, cobol, - > context, csc, csh, dtd, dtrace, eiffel, eruby, falcon, fortran, - > framescript, haml, hamster, hog, html, ishd, j, javascript, - > javascriptreact, jsp, kconfig, liquid, lua, m3quake, make, matlab, mf, - > modula2, modula3, mp, nsis, ocaml, pascal, pdf, perl, php, plaintex, - > postscr, ruby, sh, spec, sql, tex (latex), typescriptreact, vb, - > verilog, vhdl, vim, xhtml, xml, zimbu, zsh + > abaqus, ada, aspvbs, bash, c, cpp, chicken, clojure, cmake, cobol, + > context, csc, csh, dtd, dtrace, eiffel, eruby, falcon, fortran, + > framescript, haml, hamster, hog, html, ishd, j, javascript, + > javascriptreact, jsp, kconfig, liquid, lua, m3quake, make, matlab, mf, + > modula2, modula3, mp, nsis, ocaml, pascal, pdf, perl, php, plaintex, + > postscr, ruby, sh, spec, sql, tex (latex), typescriptreact, vb, + > verilog, vhdl, vim, xhtml, xml, zimbu, zsh Other file types can be supported by installing additional filetype plugins (not provided by match-up). Note: match-up uses the same `b:match_words` as matchit. + - Adds motions `g%`, `[%`, `]%`, and `z%`. - Combines these motions into convenient text objects `i%` and `a%`. - Highlights symbols and words under the cursor which `%` can work on, @@ -80,6 +87,30 @@ let g:loaded_matchit = 1 See [Interoperability](#interoperability) for more information about working together with other plugins. +### Tree-sitter integration + +_Note: Currently this feature is possible in neovim 0.5.5+ only._ + +match-up now has experimental support for language syntax provided +by tree-sitter. The list of supported languages is available +[here](https://github.com/andymass/vim-matchup/tree/master/after/queries). + +This feature requires manual opt-in in your init.vim and requires +[nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) to +be installed. + +```vim +Plug 'nvim-treesitter/nvim-treesitter' +lua <