.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-pairs / Readme.md
1 # coc-pairs
2
3 Auto pair extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
4
5 **Note** you can use other vim auto pairs plugins with coc.nvim, it's a
6 simplified implementation to make auto pairs work like in VSCode.
7
8 **Note** `b:coc_paires` have renamed to `b:coc_pairs`
9
10 For enhanced `<CR>` experience, checkout `:h coc#on_enter()`.
11
12 ## Tips
13
14 - You should disable/remove other auto pair plugins for this extension work as expected.
15 - When you type a paired character which is just the next character, it would just move to the right by one column.
16 - When the previous content ends with two inserting characters, the characters would just be inserted without inserting the paired character. This makes inserting triple quotes easier.
17 - `'` only pairs when the character before is not a word character.
18 - for `<` to insert paired `>`, the previous character should not be an empty space.
19
20 ## Install
21
22 In vim/neovim, run this command:
23
24 ```
25 :CocInstall coc-pairs
26 ```
27
28 ## Features
29
30 - Insert pair characters automatically.
31 - Buffer local pairs, ex: `autocmd FileType tex let b:coc_pairs = [["$", "$"]]`
32
33 ## Options
34
35 - `pairs.disableLanguages`, list of language ids to disable this extension, default: `[]`.
36 - `pairs.enableCharacters`, list of enabled characters, default: `` ["(", "[", "{", "<", "'", "\"", "`"] ``.
37 - `pairs.enableBackspace`, enable imap for backspace to remove paired characters,
38   default: `true`, won't work when `<bs>` is already mapped.
39
40 To disable characters for a specified filetypes, you can use `b:coc_pairs_disabled`, ex:
41
42     autocmd FileType markdown let b:coc_pairs_disabled = ['`']
43
44 ## License
45
46 MIT