Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hrsh7th/nvim-insx
Flexible key mapping manager.
https://github.com/hrsh7th/nvim-insx
neovim neovim-plugins
Last synced: 7 days ago
JSON representation
Flexible key mapping manager.
- Host: GitHub
- URL: https://github.com/hrsh7th/nvim-insx
- Owner: hrsh7th
- Created: 2023-01-10T12:42:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T04:49:45.000Z (3 months ago)
- Last Synced: 2024-08-21T18:14:31.587Z (3 months ago)
- Topics: neovim, neovim-plugins
- Language: Lua
- Homepage:
- Size: 295 KB
- Stars: 174
- Watchers: 6
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nvim-insx
nvim-insx is a flexible key mapping manager.
https://github.com/hrsh7th/nvim-insx/assets/629908/ad878d95-c541-4d6c-b135-139d511602b8
## Limitations and Warnings
- Dot-repeat is supported by only *basic* recipes.
- Note that dot-repeat may not work with the complicated recipes.
- This plugin *usually* works as expected.
- It may fire the accidental action,
because the regular expression does not capture the structure of whole text.
- We do not intend to integrate with tree-sitter
as control over the regular expression is more convenient and sufficient.
- It is more convenient when used with vim-matchup.
- A demonstration of vim-match usage can be referred to above.
- This plugin provides *basic* cmdline-mode pairwise features.
- The advanced recipes do not support cmdline-mode.
- We can not accept the proposal for `preset` if it incorporates `breaking changes`.
- Please write your own mapping definitions in your vimrc. 😢
## Usage
This plugin provides no default mappings.
You need to define your custom mappings as follows.
#### Preset
```lua
require('insx.preset.standard').setup()
```
#### Recipe
```lua
local insx = require('insx')
insx.add(
"'",
insx.with(require('insx.recipe.auto_pair')({
open = "'",
close = "'"
}), {
insx.with.in_string(false),
insx.with.in_comment(false),
insx.with.nomatch([[\\\%#]]),
insx.with.nomatch([[\a\%#]])
})
)
```
## Custom recipe
```lua
-- Simple pair deletion recipe.
local function your_recipe(option)
return {
action = function(ctx)
if option.allow_space then
ctx.remove([[\s*\%#\s*]])
end
ctx.send('')
end,
enabled = function(ctx)
if option.allow_space then
return ctx.match([[(\s*\%#\s*)]])
end
return ctx.match([[(\%#)]])
end
}
end
```
The standard preset enables some advanced features.
### Status
The API is stable except for the helper-related APIs.
Bug report & feature request are welcome.