Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vigoux/notifier.nvim
Non-intrusive notification system for neovim
https://github.com/vigoux/notifier.nvim
Last synced: 3 days ago
JSON representation
Non-intrusive notification system for neovim
- Host: GitHub
- URL: https://github.com/vigoux/notifier.nvim
- Owner: vigoux
- License: bsd-3-clause
- Created: 2022-08-25T12:42:08.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-18T08:19:49.000Z (about 1 year ago)
- Last Synced: 2024-05-01T16:27:40.037Z (7 months ago)
- Language: Lua
- Size: 109 KB
- Stars: 190
- Watchers: 3
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `notifier.nvim` non-intrusive notification system for neovim
## Setup
Using `packer.nvim`:
```lua
use {
"vigoux/notifier.nvim",
config = function()
require'notifier'.setup {
-- You configuration here
}
end
}
```
The default configuration is:
```lua
{
ignore_messages = {}, -- Ignore message from LSP servers with this name
status_width = something, -- COmputed using 'columns' and 'textwidth'
components = { -- Order of the components to draw from top to bottom (first nvim notifications, then lsp)
"nvim", -- Nvim notifications (vim.notify and such)
"lsp" -- LSP status updates
},
notify = {
clear_time = 5000, -- Time in milliseconds before removing a vim.notify notification, 0 to make them sticky
min_level = vim.log.levels.INFO, -- Minimum log level to print the notification
},
component_name_recall = false, -- Whether to prefix the title of the notification by the component name
zindex = 50, -- The zindex to use for the floating window. Note that changing this value may cause visual bugs with other windows overlapping the notifier window.
}
```
This plugin provides some commands:
```vim
:NotifierClear " Clear the vim.notify items
:NotifierReplay " Replay all vim.notify items
:NotifierReplay! " Replay all vim.notify items to the quickfix list
```
This plugin defines multiple highlight groups that you can configure:
- `NotifierTitle`: the title of the notification (`lsp:..` and `nvim`)
- `NotifierIcon`: Icon of the notification (if any)
- `NotifierContent`: the content of the notification
- `NotifierContentDim`: dimmed content of the notification
## `vim.notify` options
This plugin supports two options for `vim.notify`:
```lua
title: string -- The title for this notification
icon: string -- The icon for this notification
```
## Acknowledgement
Heavily inspired by [fidget.nvim]
[fidget.nvim]: https://github.com/j-hui/fidget.nvim
## TODO
- [x] Handle LSP progress
- [x] Hook into `vim.notify` and friends
- [x] Allow to customize log levels
- [ ] When out, hook into `ui_attach` to route more messages from nvim
- [ ] Add docs for `status.push` and `status.pop`