feat: clear lsp references on ui open

[A-Lamia]

If you're hovering over text with a LSP, it highlights all the references, when entering SSR these highlights persist, this can be visually noisy

Before:

before.mp4

After:

after.mp4

[cshuaimin]

Thanks for bringing this problem to me!

I wonder if it is more useful when you clear lsp highlights in an BufLeave autocmd? And you can use vim.lsp.buf.clear_references().

[cshuaimin]

I found related code in AstroNvim, maybe we can also add BufLeave event to AstroNvim, to clear lsp highlights when you enter another buffer (a vsplit or :h).

[A-Lamia]

Hmmm, yes, i'm currently using my own autocmd for this, but you might be right this probably is not needed in ssr, if people don't have that function implemented them selves they will not have this "side effect" I'll have this solved in astro.

:)

[cshuaimin]

No I think it's useful to clear lsp highlights in ssr.nvim. If you change the PR to use vim.lsp.buf.clear_references() in an autocmd, then I'm happy to merge this.

[A-Lamia]

I've found a pretty bad bug that is the root of some issues, ill be doing some testing and ill get back to you once i figure everything vim.lsp.buf.clear_references() might not be the best use case for this situation.

EDIT: an autocmd also may not be the best choice, autocmd is typicality used when you want to automate a function execution, but in our case with SSR we are always executing Ui:open() manually, the Autocmd is just extra overhead for the same result, if that is what you want however i have no issue with doing it via autocmd.

[A-Lamia]

aah something i didn't think of, if people leave ssr active while editing code in this case yeah the autocmd makes sense, this was an oversight on my part as i typically don't use ssr like that.

[A-Lamia]

need to merge #32 before this PR.