Revamp Diagnostics

[prabirshrestha]

There has been lot of asks in the past related to diagnostics feature in vim-lsp but due to the how it has organically grown it has been hard to add features as well as modify existing code to support without breaking.

My hope is to solve these issues and make sure we don't miss any of these while we re-implement. 99% of these can now easily be solved.

• Why highlight references and echo diagnostics only in normal mode?
• Control when diagnostics is run
• Automatically Closing the Location List For Diagnostics
• Newlines filtered out on error messages?
• lsp_diagnostics_echo_cursor not working when NERDTree is open
• Key not present in Dictionary: severity
• Diagnostics for all open buffers - Diagnostics for all buffers #982
• Missing autocommand when diagnostics are updated
• File type specific diagnostics
• LspDocumentDiagnostics` runs before file is fully saved
• vim-lsp 2020
• call s:ensure_flush() after applying workspace edits
• s:on_text_document_did_change isn't fired in normal mode
• Signs don't update after normal commands
• disable/enable virtual text for a specific diagnostic type. That would be nice.
• Optionally disable realtime running of diagnotics
• Disable/Enable diagnostics
• Enabling textprop will break Sign; setting LspErrorHighlight has no effect
• Signs no longer work for me after feba6d6 - Revamp diagnostics highlights #995
• Is there a way to show the error message below the statusline?
• lsp_signs_enabled broken
• redo diagnostics sign
• Use virtual text to display diagnostics
• diagnostic signs not refreshed on undo/redo of text edit
• Truncate diagnostics cursor message while message is too long
• LspNextError and LspPreviousError not working
• How to change when the document is analyzed?
• Auto-run diagnostics / sort diagnostics
• Command to show project errors
• add diagnostics signs.
• Use location-list instead of quick-fix for document diagnostics

If folks have feature request feel free to comment here.

Few of the changes I would want to personally add while we re-implement diagnostics.

• Differentiate between ui vs non-ui parts of diagnostics and expose right apis to build any ui on top of the diagnostics. add internal/diagnostics/state.vim #978
• Diagnostics signs revamp for vim and neovim - Diagnostics signs revamp #994
• Diagnostics virtual text revamp for neovim - Revamp diagnostics virtual text #990
• Diagnostics for all buffers - Diagnostics for all buffers #982
• Internal per buffer disable state for diagnostics - add buffer state of disabled diagnostics state #981
• Public api to disable and enable diagnostics per buffer
• Normalize diagnostics buffer uri - Convert lowercase drive letters to uppercase #953
• Looking into perf optimizations
• Make sure to garbage collect unloaded buffers correctly.
• Unit tests
• Integration test
• Use callbag all the way.