feat(diagnostic): ansi code colored disagnostics in floating and spli…

[xzbdmw]

close #442
float:

split:

The idea is using nvim_open_term to let nvim render ansi code diagnostic for us, there is one problem, the window size must bigger than both of diagnostic's width and content, if not, previous lines get cleared by nvim somehow(idk why) like this image, notice the error: is missing.

You can try my first commit and set width to a small number say 20.
I don't use rust often lately, hope it works well😸

[github-actions]

Review Checklist

Does this PR follow the Contribution Guidelines? Following is a partial checklist:

Proper conventional commit scoping:

• For example, fix(lsp): some lsp-related bugfix

• Pull request title has the appropriate conventional commit prefix.

If applicable:

• Tested
  • Tests have been added.
  • Tested manually (Steps to reproduce in PR description).
• Updated documentation.
• Updated CHANGELOG.md

[xzbdmw]

This is adopted from https://stackoverflow.com/questions/48948630/lua-ansi-escapes-pattern

[mrcjkb]

suggestion: Add this info as a comment

Suggested change

	vim.split(rendered_diagnostic:gsub('[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]', ''), '\n', { trimempty = true })
	-- adopted from https://stackoverflow.com/questions/48948630/lua-ansi-escapes-pattern
	vim.split(rendered_diagnostic:gsub('[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]', ''), '\n', { trimempty = true })

[xzbdmw]

This is to ensure cursor syncs properly, nvim_win_set_cursor is not a synchronized call, when cursor first enters the window, Terminal mode is activated, and the cursor is at last line.

[mrcjkb]

Hey 👋

Thanks for the PR 🙏

The screenshots look awesome! I'll take a closer look later this week.

[mrcjkb]

Great work! 🚀

Just a few comments.

[mrcjkb]

issue: missing type annotations.
[see my other comment before addressing this]

Suggested change

	local function validate_window_dimensions(float_preview_lines, user_float_win_config)
	---@param float_preview_lines string[]
	---@param user_float_win_config table
	---@return table
	local function validate_window_dimensions(float_preview_lines, user_float_win_config)

[mrcjkb]

issue: This is a private function, not part of Neovim's public API.

I think we can live without validate_window_dimensions. Most users won't set dimensions in their configs and by the looks of it, vim.lsp.util.open_floating_preview determines the correct size.

Although users setting boundaries in their configs could lead to the content not being able to fit, I don't think silently correcting max_width or max_height is desirable behaviour, as it could leave users confused about why their boundaries aren't being respected.

[mrcjkb]

suggestion: Add this info as a comment

Suggested change

	vim.split(rendered_diagnostic:gsub('[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]', ''), '\n', { trimempty = true })
	-- adopted from https://stackoverflow.com/questions/48948630/lua-ansi-escapes-pattern
	vim.split(rendered_diagnostic:gsub('[\27\155][][()#;?%d]*[A-PRZcf-ntqry=><~]', ''), '\n', { trimempty = true })

[mrcjkb]

suggestion: User buffer-local autocommand instead of checking for args.buf.

Suggested change

	local autocmd_id = vim.api.nvim_create_autocmd('WinEnter', {
	callback = function(args)
	if args.buf == bufnr then
	vim.api.nvim_feedkeys(
	vim.api.nvim_replace_termcodes(
	[[<c-\><c-n>]] .. '<cmd>lua vim.api.nvim_win_set_cursor(' .. winnr .. ',{1,0})<CR>',
	true,
	false,
	true
	),
	'n',
	true
	)
	end
	end,
	})
	local autocmd_id = vim.api.nvim_create_autocmd('WinEnter', {
	callback = function()
	vim.api.nvim_feedkeys(
	vim.api.nvim_replace_termcodes(
	[[<c-\><c-n>]] .. '<cmd>lua vim.api.nvim_win_set_cursor(' .. winnr .. ',{1,0})<CR>',
	true,
	false,
	true
	),
	'n',
	true
	)
	end,
	buffer = bufnr,
	})

[mrcjkb]

suggestion: If using a buffer-local autocommand for the WinEnter event, this one can probably be removed.

Suggested change

	vim.api.nvim_create_autocmd('WinClosed', {
	once = true,
	pattern = tostring(winnr),
	callback = function()
	vim.api.nvim_del_autocmd(autocmd_id)
	end,
	})

[xzbdmw]

@mrcjkb Thank you for detailed review! have made all the suggested changes. and rebased with master.