feat: add renderer.icons.diagnostic_placement

[baahrens]

Attempts to close #1510

This is my first proper PR in this project, so please let me know if this is the wrong approach/direction or if I broke any styling guidelines.

There's a few things I'm unsure about:

1. Is it okay to reload the whole explorer on DiagnosticChanged or should we aim for a more finegrained approach?
2. Should this be config.renderer.icons.diagnostic_placement or config.diagnostics.placement (this was proposed in Add nvim-tree.diagnostics.placement config option #1510)?
3. There was a lot of logging in the original diagnostics.update function. Should this be replicated somewhere in the new implementation? If yes, where?

TODO:

• Add support for folder diagnostics
• documentation/help

[alex-courtis]

1. Is it okay to reload the whole explorer on DiagnosticChanged or should we aim for a more finegrained approach?

Unfortunately we cannot afford that expensive operation.

Diagnostic changes must be updated in the debounced "thread" M.update, affecting only diagnostics.

Edit: to be clear: we can draw, just not reload the tree.

[alex-courtis]

2. Should this be config.renderer.icons.diagnostic_placement or config.diagnostics.placement

config.diagnostics.placement is preferable, however inconsistent with modified/git.

config.renderer.icons.diagnostic_placement please.

[alex-courtis]

There was a lot of logging in the original diagnostics.update function. Should this be replicated somewhere in the new implementation? If yes, where?

Please retain the logging and profiling, in the M.update debounced "thread".

[alex-courtis]

This is looking great - thanks for your work.

[baahrens]

Thanks for your feedback!

I adjusted a few things:

• The tree is now redrawing instead of reloaded on DiagnosticChanged
• Diagnostic are now shown on folders, respecting diagnostics.show_on_dirs and diagnostics.show_on_open_dirs (can you check, if this is working correctly? I'm not quite sure)
• Added the logging again, although I'm not sure it makes sense like this, as the update function from before doesn't exist anymore, as diagnostic rendering is now part of the drawing process and doesn't happen in a debounced "thread"

Let me know if this is going in the right direction, I'll update the help file then.

renderer.icons.diagnostic_placement == "after"

renderer.icons.diagnostic_placement == "before"

[alex-courtis]

Looking good except for sign column folders.

Test case nvim-tree/dev/lua/nvim-tree/actions/finders/find-file.lua

  view = {
    width = {
      min = 20,
      max = 50,
    },
  },

OK:
show_on_dirs = false, show_on_open_dirs = false,
diagnostic_placement = "before",
diagnostic_placement = "signcolumn",
diagnostic_placement = "after",
diagnostic_placement = nil,

show_on_dirs = true, show_on_open_dirs = false,
diagnostic_placement = "before",
diagnostic_placement = "signcolumn",
diagnostic_placement = "after",
diagnostic_placement = nil,

show_on_dirs = false, show_on_open_dirs = true,
diagnostic_placement = "before",
diagnostic_placement = "signcolumn",
diagnostic_placement = "after",
diagnostic_placement = nil,

show_on_dirs = true, show_on_open_dirs = true,
diagnostic_placement = "before",
diagnostic_placement = "after",

FAIL:
show_on_dirs = true, show_on_open_dirs = true,
diagnostic_placement = "signcolumn",
diagnostic_placement = nil,

Same results with group_empty = true, in an empty directory tree.

[alex-courtis]

• Added the logging again, although I'm not sure it makes sense like this, as the update function from before doesn't exist anymore, as diagnostic rendering is now part of the drawing process and doesn't happen in a debounced "thread"

Please wrap the profile / logging around the "DiagnosticChanged" and "CocDiagnosticChange" autocommands. We want to capture the time spent fetching diagnostics.

[alex-courtis]

This doesn't fit in here; it should go back in diagnostics.lua.

I like _get_diagnostic_icon - nice and consistent.

Proposal:

• Move this back into diagnostics.update
• diagnostics.update records the diagnostic state of the node. Something like git_status
• call draw following diagnostics.update
• _get_diagnostic_icon calls something like local diagnostic_icon = diagnostics.get_icon(node)

[alex-courtis]

Any updates on this one @baahrens ? This would be a great addition... I will be using it...

[baahrens]

I will look into this shortly, sorry for the delay

[alex-courtis]

I will look into this shortly, sorry for the delay

There is no hurry; just checking whether you still intend to work on this one.

[alex-courtis]

superseded by #2396