Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/altermo/ultimate-autopair.nvim
A treesitter supported autopairing plugin with extensions, and much more
https://github.com/altermo/ultimate-autopair.nvim
autopair lua neovim neovim-lua neovim-lua-plugin neovim-plugin nvim nvim-lua nvim-plugin
Last synced: 14 days ago
JSON representation
A treesitter supported autopairing plugin with extensions, and much more
- Host: GitHub
- URL: https://github.com/altermo/ultimate-autopair.nvim
- Owner: altermo
- License: mit
- Created: 2023-02-02T20:38:20.000Z (almost 2 years ago)
- Default Branch: v0.6
- Last Pushed: 2024-03-27T10:14:25.000Z (8 months ago)
- Last Synced: 2024-04-12T12:06:34.881Z (7 months ago)
- Topics: autopair, lua, neovim, neovim-lua, neovim-lua-plugin, neovim-plugin, nvim, nvim-lua, nvim-plugin
- Language: Lua
- Homepage:
- Size: 663 KB
- Stars: 399
- Watchers: 10
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - altermo/ultimate-autopair.nvim - Autopair with extensions. (Editing Support / Scrollbar)
README
**:exclamation: Ultimate-autopair is currently in maintenance mode, no new features will be added in the near future**
# Ultimate-autopair.nvim 0.6.1
[Ultimate-autopair](https://github.com/altermo/ultimate-autopair.nvim) plugin aims to always work as you expect and be ultra customizable, while making it easy to configure. It has features which other auto-pairing plugins lack: multiline support, treesitter-node filtering and treesitter-filetype detection.
For development version, which is sometimes up to date with default branch, check out [development](https://github.com/altermo/ultimate-autopair.nvim/tree/development)\
Requires **neovim 0.9** (for older versions of neovim, check previous versions of plugin)\
For some features, including string filtering, requires **treesitter**.
For new users, check out starter documentation (`:help ultimate-autopair`)
## Installation
Lazy
```lua
{
'altermo/ultimate-autopair.nvim',
event={'InsertEnter','CmdlineEnter'},
branch='v0.6', --recommended as each new version will have breaking changes
opts={
--Config goes here
},
}
```
Packer
```lua
use{
'altermo/ultimate-autopair.nvim',
event={'InsertEnter','CmdlineEnter'},
branch='v0.6', --recommended as each new version will have breaking changes
config=function ()
require('ultimate-autopair').setup({
--Config goes here
})
end,
}
```
## Default configuration
For the default configuration, refer to the documentation (`:help ultimate-autopair-default-config`).
## Demo
demo
### Other plugins to supercharge auto-pairing
These are some other plugins which are related to pairing which have features that ultimate-autopair does not have.
+ [endwise](https://github.com/RRethy/nvim-treesitter-endwise) wisely add `end` in lua, ruby, etc... (Note: doesn't get broken by ultimate-autopair's newline)
+ [tabout](https://github.com/abecodes/tabout.nvim) tab out of treesitter nodes
+ [surround](https://github.com/kylechui/nvim-surround) delete, change surrounding parentheses and much more...
+ [autotag](https://github.com/windwp/nvim-ts-autotag) auto pair html tags
If you want to use this together with [nvim-autopairs](https://github.com/windwp/nvim-autopairs) read `:h ultimate-autopair-use-with-npairs`
### Donate
If you want to donate then you need to find the correct link (hint: 50₁₀):
* [0a]() [0b]() [0c]() [0d]() [0e]() [0f]() [0g]() [0h]()
* [1a]() [1b]() [1c]() [1d]() [1e]() [1f]() [1g]() [1h]()
* [2a]() [2b]() [2c]() [2d]() [2e]() [2f]() [2g]() [2h]()
* [3a]() [3b]() [3c]() [3d]() [3e]() [3f]() [3g]() [3h]()
* [4a]() [4b]() [4c]() [4d]() [4e]() [4f]() [4g]() [4h]()
* [5a]() [5b]() [5c]() [5d]() [5e]() [5f]() [5g]() [5h]()
* [6a]() [6b](https://www.buymeacoffee.com/altermo) [6c]() [6d]() [6e]() [6f]() [6g]() [6h]()
* [7a]() [7b]() [7c]() [7d]() [7e]() [7f]() [7g]() [7h]()
### Chat
+ [github discussions](https://github.com/altermo/ultimate-autopair.nvim/discussions)