feat(diag): add diagnostics_update_on_event option
#932
Conversation
lua/bufferline/config.lua
Outdated
| @@ -657,6 +657,7 @@ local function get_defaults() | |||
| diagnostics = false, | |||
| diagnostics_indicator = nil, | |||
| diagnostics_update_in_insert = true, | |||
| diagnostics_update_on_event = false, | |||
There was a problem hiding this comment.
I think we can set this to true by default if they are using nvim_lsp and then update in insert to false. I'll look into deprecating that eventually
There was a problem hiding this comment.
Good idea, but shouldn't update in insert be set to what the user configured in nvim with vim.diagnostic.config? If so, should we display a warning when a user tries to set update in insert for bufferline config (when using nvim_lsp)?
There was a problem hiding this comment.
Tbh I'd like to deprecate the setting entirely since it now seems to be moot, if they use update on event then it will update in insert if they have set that in their lsp config. I don't get much time to do granular tweaks often to this plugin so more keen on trying to set the new normal whenever there are changes like this.
Maybe it's worth just add a deprecation warning that shows one time on plugin load to say this option is now essentially irrelevant because you should use update_on_event and make sure that your vim.diagnostic.config sets update on insert to true.
I think I have a mechanism in the code base already for deprecating options
There was a problem hiding this comment.
I like the idea of deprecated that option entirely, but what about coc users?
And yes a deprecation warning on startup would be the best.
There was a problem hiding this comment.
For now I only deprecated it for nvim_lsp users, so there are no regressions.
gepbird
force-pushed
the
diagnostic-update-on-event
branch
2 times, most recently
from
77e6aff
to
d6b687a
Compare
gepbird
force-pushed
the
diagnostic-update-on-event
branch
from
d6b687a
to
8e4a87f
Compare
|
Sorry about the delay @gepbird I had forgotten about this |
| @@ -181,6 +181,15 @@ local function setup_commands() | |||
| }) | |||
| end | |||
|
|
|||
| local function setup_diagnostic_handler(preferences) | |||
| if preferences.options.diagnostics == "nvim_lsp" and preferences.options.diagnostics_update_on_event then | |||
There was a problem hiding this comment.
nit: this conditional is quite verbose could be local opts = preferences.options
About this PR
Closes #923.
This change makes the ui refresh whenever nvim reports a diagnostic change.
Demo: bufferline diagnostics are up to date
2024-06-25.14-24-39.mp4
Possible improvements for later
When nvim calls our diagnostic handler, we could get extra information about the change, for example the buffer that the change occurred in, all the details about the diagnostics in that buffer and options like
update_in_insert(configured viavim.diagnostic.config). We could use these to replacevim.diagnostic.getcall (possibly improving performance) and deprecate the bufferline optiondiagnostic_update_in_insert. However it would increase the complexity since we want to keep support for coc, so I decided not to do these changes.