Update generated neovim config
This commit is contained in:
167
config/neovim/store/lazy-plugins/mini.nvim/readmes/mini-pairs.md
Normal file
167
config/neovim/store/lazy-plugins/mini.nvim/readmes/mini-pairs.md
Normal file
@ -0,0 +1,167 @@
|
||||
<img src="https://github.com/echasnovski/media/blob/main/mini.nvim/logo/logo_pairs.png" style="width: 100%"/>
|
||||
|
||||
<!-- badges: start -->
|
||||
[](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)
|
||||
<!-- badges: end -->
|
||||
|
||||
### Minimal and fast autopairs
|
||||
|
||||
See more details in [Features](#features) and [help file](../doc/mini-pairs.txt).
|
||||
|
||||
---
|
||||
|
||||
⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-pairs.md) if you want to mention this module.
|
||||
|
||||
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
|
||||
|
||||
⦿ See the repository page to learn about common design principles and configuration recipes.
|
||||
|
||||
---
|
||||
|
||||
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
|
||||
|
||||
## Demo
|
||||
|
||||
https://user-images.githubusercontent.com/24854248/173044991-18653715-9b4e-444e-a4ba-14eb80bc4e38.mp4
|
||||
|
||||
## Features
|
||||
|
||||
- Functionality to work with 'paired' characters conditional on cursor's neighborhood (two characters to its left and right).
|
||||
- Usage should be through making appropriate mappings using `MiniPairs.map()` or in `MiniPairs.setup()` (for global mapping), `MiniPairs.map_buf()` (for buffer mapping).
|
||||
- Pairs get automatically registered to be recognized by `<BS>` and `<CR>`.
|
||||
|
||||
## Installation
|
||||
|
||||
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
|
||||
|
||||
There are two branches to install from:
|
||||
|
||||
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
|
||||
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
|
||||
|
||||
Here are code snippets for some common installation methods (use only one):
|
||||
|
||||
<details>
|
||||
<summary>With <a href="https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-deps.md">mini.deps</a></summary>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Github repo</th>
|
||||
<th>Branch</th> <th>Code snippet</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td rowspan=2>'mini.nvim' library</td> <td>Main</td> <td rowspan=2><i>Follow recommended 'mini.deps' installation</i></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan=2>Standalone plugin</td> <td>Main</td> <td><code>add('echasnovski/mini.pairs')</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stable</td> <td><code>add({ source = 'echasnovski/mini.pairs', checkout = 'stable' })</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Github repo</th>
|
||||
<th>Branch</th> <th>Code snippet</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td rowspan=2>'mini.nvim' library</td>
|
||||
<td>Main</td> <td><code>{ 'echasnovski/mini.nvim', version = false },</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stable</td> <td><code>{ 'echasnovski/mini.nvim', version = '*' },</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan=2>Standalone plugin</td>
|
||||
<td>Main</td> <td><code>{ 'echasnovski/mini.pairs', version = false },</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stable</td> <td><code>{ 'echasnovski/mini.pairs', version = '*' },</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>With <a href="https://github.com/junegunn/vim-plug">junegunn/vim-plug</a></summary>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Github repo</th>
|
||||
<th>Branch</th> <th>Code snippet</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td rowspan=2>'mini.nvim' library</td>
|
||||
<td>Main</td> <td><code>Plug 'echasnovski/mini.nvim'</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stable</td> <td><code>Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan=2>Standalone plugin</td> <td>Main</td> <td><code>Plug 'echasnovski/mini.pairs'</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stable</td> <td><code>Plug 'echasnovski/mini.pairs', { 'branch': 'stable' }</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</details>
|
||||
|
||||
<br>
|
||||
|
||||
**Important**: don't forget to call `require('mini.pairs').setup()` to enable its functionality.
|
||||
|
||||
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
|
||||
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
|
||||
- Install plugin in other place with shorter path.
|
||||
|
||||
## Default config
|
||||
|
||||
```lua
|
||||
-- No need to copy this inside `setup()`. Will be used automatically.
|
||||
{
|
||||
-- In which modes mappings from this `config` should be created
|
||||
modes = { insert = true, command = false, terminal = false },
|
||||
|
||||
-- Global mappings. Each right hand side should be a pair information, a
|
||||
-- table with at least these fields (see more in |MiniPairs.map|):
|
||||
-- - <action> - one of 'open', 'close', 'closeopen'.
|
||||
-- - <pair> - two character string for pair to be used.
|
||||
-- By default pair is not inserted after `\`, quotes are not recognized by
|
||||
-- `<CR>`, `'` does not insert pair after a letter.
|
||||
-- Only parts of tables can be tweaked (others will use these defaults).
|
||||
mappings = {
|
||||
['('] = { action = 'open', pair = '()', neigh_pattern = '[^\\].' },
|
||||
['['] = { action = 'open', pair = '[]', neigh_pattern = '[^\\].' },
|
||||
['{'] = { action = 'open', pair = '{}', neigh_pattern = '[^\\].' },
|
||||
|
||||
[')'] = { action = 'close', pair = '()', neigh_pattern = '[^\\].' },
|
||||
[']'] = { action = 'close', pair = '[]', neigh_pattern = '[^\\].' },
|
||||
['}'] = { action = 'close', pair = '{}', neigh_pattern = '[^\\].' },
|
||||
|
||||
['"'] = { action = 'closeopen', pair = '""', neigh_pattern = '[^\\].', register = { cr = false } },
|
||||
["'"] = { action = 'closeopen', pair = "''", neigh_pattern = '[^%a\\].', register = { cr = false } },
|
||||
['`'] = { action = 'closeopen', pair = '``', neigh_pattern = '[^\\].', register = { cr = false } },
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## Similar plugins
|
||||
|
||||
- [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs)
|
||||
- [jiangmiao/auto-pairs](https://github.com/jiangmiao/auto-pairs)
|
||||
Reference in New Issue
Block a user