right-corner-diagnostics.nvim

This plugins is a fork that aims to be a little bit simpler for the user and to add necessary options like the possibility of hiding marks in insert mode.

What does it do?

There's various ways of viewing diagnostics in Neovim, but I really liked this implementation that simply uses virtual text to show the diagnostics at either top or bottom of the buffer, instead of the default virtual text at the end of the line.

Preview

Highlight groups

In the original trld.nvim there was a possibility of defining the highlight groups for the plugin to make use of, but I decided to hard code the groups to be: DiagnosticVirtualTextError, DiagnosticVirtualTextWarn, DiagnosticVirtualTextInfo and DiagnosticVirtualTextHint so it's very probable that your colorscheme already supports them.

Installation and Configuration

-- Packer
use {
  'santigo-zero/right-corner-diagnostics.nvim',
  event = 'LspAttach',
  config = function()
    -- Recommended:
    -- NOTE: Apply this settings before calling the `setup()`.
    vim.diagnostic.config {
      -- Disable default virtual text since you are using this plugin
      -- already :)
      virtual_text = false,

      -- Do not display diagnostics while you are in insert mode, so if you have
      -- `auto_cmds = true` it will not update the diagnostics while you type.
      update_in_insert = false,
    }

    -- Default config:
    require('rcd').setup {
      -- Where to render the diagnostics: top or bottom, the latter sitting at
      -- the bottom line of the buffer, not of the terminal.
      position = 'top',

      -- In order to print the diagnostics we need to use autocommands, you can
      -- disable this behaviour and call the functions yourself if you think
      -- your autocmds work better than the default ones with this option:
      auto_cmds = true,
    }
  end,
}

Showing the diagnostics with autocommands

I encourage anyone to check the setup function to see how everything works since it's pretty simple to understand if not the basic usage of the plugin would look something like this:

local au_rcd = vim.api.nvim_create_augroup('right_corner_diagnostics', {})

vim.api.nvim_create_autocmd({
  'CursorHold',
  'CursorHoldI',
}, {
  group = au_rcd,
  callback = require('rcd').show,
})

vim.api.nvim_create_autocmd({
  'CursorMoved',
  'CursorMovedI',
}, {
  group = au_rcd,
  callback = require('rcd').hide,
})