Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/delphinus/agrp.nvim
https://github.com/delphinus/agrp.nvim
lua neovim plugin
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/delphinus/agrp.nvim
- Owner: delphinus
- Created: 2021-06-28T08:20:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-17T05:17:07.000Z (over 2 years ago)
- Last Synced: 2024-04-16T22:29:49.659Z (7 months ago)
- Topics: lua, neovim, plugin
- Language: Lua
- Homepage:
- Size: 14.6 KB
- Stars: 18
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# agrp.nvim
Yet another utility to set augroup in Neovim
## What's this?
This makes you easily define augroup & autocmd with Neovim native APIs. There are `vim.api.nvim_create_augroup` & `vim.api.nvim_create_autocmd`, but they have a bit complex syntax. This plugin is meant to be used as a syntax sugar.
## Usage
### Standard augroup & autocmd
```lua
require'agrp'.set{
MyHelloWorld = {
{'VimEnter', '*', 'echo "Hello World!"'},
},
MyFavorites = {
{'VimEnter', '*', 'doautocmd ColorScheme solarized8'},
{'QuickFixCmdPost', '*grep*', 'cwindow'},
},
}
```
This will execute the script below.
```lua
vim.api.nvim_create_augroup("MyHelloWorld")
vim.api.nvim_create_autocmd("VimEnter", {
group = "MyHelloWorld",
command = [[echo 'Hello World!']],
})
vim.api.nvim_create_augroup("MyFavorites")
vim.api.nvim_create_autocmd("VimEnter", {
group = "MyFavorites",
command = [[doautocmd ColorScheme solarized8]],
})
vim.api.nvim_create_autocmd("QuickFixCmdPost", {
group = "MyFavorites",
pattern = "*grep*",
command = [[cwindow]],
})
```
### Bind with Lua functions
It can binds Lua functions.
```lua
require'agrp'.set{
MyFavorites2 = {
-- See https://github.com/neovim/neovim/pull/12279
{
'TextYankPost',
'*',
function()
vim.highlight.on_yank {}
end,
},
-- Quit with `q` when run with `-R`
{
'VimEnter',
'*',
function()
if vim.opt.readonly:get() then
vim.api.nvim_set_keymap('n', 'q', 'qa', {})
end
end,
},
},
}
```
In this case, it runs below.
```lua
vim.api.nvim_create_augroup("MyFavorites2")
vim.api.nvim_create_autocmd("TextYankPost", {
group = "MyFavorites2",
callback = function() vim.highlight.on_yank {} end,
})
vim.api.nvim_create_autocmd("VimEnter", {
group = "MyFavorites2",
callback = function()
if vim.opt.readonly:get() then
vim.api.nvim_set_keymap("n", "q", "qa", {})
end
end,
})
```
### Multi definitions for one event
Multi definitions can be gathered into one table.
```lua
require'agrp'.set{
MyFiledetect = {
['BufNewFile,BufRead'] = {
{'*.hoge', 'set filetype=hoge'},
{'*.fuga', 'set filetype=fuga'},
{'*.foo', 'set filetype=foo'},
},
},
}
```
### autocmd without augroup
For ftdetct, you can define autocmd without any augroup.
NOTE: This is not recommended for the normal use of autocmd.
```lua
require'agrp'.set{
{
['BufNewFile,BufRead'] = {
{'*.hoge', 'set filetype=hoge'},
{'*.fuga', 'set filetype=fuga'},
{'*.foo', 'set filetype=foo'},
},
},
}
```
### `++once` and `++nested` options
Options for autocmd should be set in a table just before the command (or Lua function).
```lua
require'agrp'.set{
RunOnlyOnce = {
{'InsertCharPre', '*', {'once'}, function()
vim.api.nvim_echo({
{'Inserting a char: '..vim.v.char, 'WarningMsg'},
}, false, {})
end},
},
}
```