https://github.com/yochem/chime.nvim
:vertical_traffic_light: Diagnostics in the echo / message area
https://github.com/yochem/chime.nvim
diagnostics lua neovim nvim package plugin
Last synced: 4 months ago
JSON representation
:vertical_traffic_light: Diagnostics in the echo / message area
- Host: GitHub
- URL: https://github.com/yochem/chime.nvim
- Owner: yochem
- License: mit
- Created: 2025-02-19T11:06:30.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-19T11:44:02.000Z (4 months ago)
- Last Synced: 2025-02-19T12:28:25.420Z (4 months ago)
- Topics: diagnostics, lua, neovim, nvim, package, plugin
- Language: Lua
- Homepage:
- Size: 183 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chime.nvim 🚦
Chime is a very little plugin that does a one straightforward thing: it shows
the diagnostic of the current line in the echo / message area.
## Installation
To install, use your favorite plugin manager. For example with
[lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{ 'yochem/chime.nvim' }
```
For lazy-loading you could try `event = 'DiagnosticsChanged'`, although the
plugin should be very light.
## Configuration
This plugin aims to do everything _the Neovim way_. Because it handles
diagnostics, it's an
[`diagnostic-handler`](https://neovim.io/doc/user/diagnostic.html#_handlers).
This means configuration is handled using `vim.diagnostic.config()`, **not**
`setup()`. It also listens to global configuration options for diagnostic
handlers, and you can enable it only for certain namespaces. See
[`vim.diagnostic.config`](https://neovim.io/doc/user/diagnostic.html#vim.diagnostic.config())
for more info.
```lua
vim.diagnostic.config({
chime = {
severity_sort = false,
severity = nil,
format = ...,
}
})
```
Chime can be enabled or disabled on the fly:
```vim
" disable Chime
:lua vim.diagnostic.config({ chime = false })
" and enable again
:lua vim.diagnostic.config({ chime = true })
```
## Format
Set the format of the diagnostic message with the `format` config option. It
should be a function that receives a diagnostic and outputs either a string or
a list of colored chunks (like the first argument of
[`vim.api.nvim_echo()`](https://neovim.io/doc/user/api.html#nvim_echo())).
An example that returns the formatted string `[INFO] Unused functions. (luals)`:
```lua
vim.diagnostic.config({
chime = {
format = function(diagnostic)
return ('[%s] %s (%s)'):format(
-- this assumes the default sign text
vim.diagnostic.severity[diagnostic.severity],
diagnostic.message,
diagnostic.source,
)
end
}
})
```
And the same diagnostic but with the sign text highlighted in its color and the
source in gray:
```lua
vim.diagnostic.config({
chime = {
format = function(diagnostic)
local severity_text = vim.diagnostic.severity[diagnostic.severity]
local severity_color = ({
'DiagnosticError',
'DiagnosticWarn',
'DiagnosticInfo',
'DiagnosticHint',
})[diagnostic.severity]
return {
{ ('[%s] '):format(severity_text), severity_color },
-- prevent "Press enter" prompts by only showing first line
{ vim.split(diagnostic.message, '\n')[1] },
{ (' (%s)'):format(diagnostic.source), "Comment" },
}
end
}
})
```
## Severity
Filter on severities, for example only show errors in Chime. See
[`diagnostic-severity`](https://neovim.io/doc/user/diagnostic.html#diagnostic-severity).
## Severity Sort
Sort by severity. It is recommended to set this to true. See
[`vim.diagnostic.Opts`](https://neovim.io/doc/user/diagnostic.html#vim.diagnostic.Opts).
# TODO
- Add option to always trim messages to fit screen. [Kill "Press ENTER" with
fire](https://github.com/neovim/neovim/issues/22478).
- Better default format.
- Resize `cmdheight` temporary to allow multiple diagnostics at once, without
press enter prompt?