[Feature request] Add a way to move inline comments to a separate line

[jyn514]

Often, I will have some code that looks like this:

some_lua_code() -- and a trailing comment

Eventually the line will get quite long and I will want to move the comment onto the line above:

--- a leading comment
some_lua_code()

Would it be possible to add a keybind for this? Maybe using treesitter queries?

[jyn514]

I came up with this hack that works without treesitter but it's probably not something you want to merge as-is 😅

vim.api.nvim_create_user_command('MoveCommentUp', function(info)
	local view = vim.fn.winsaveview()

	local start, end_line
	if info.range > 0 then
		start = info.line1
		end_line = info.line2
	else
		start = vim.fn.line('.')
		end_line = start
	end
	print(start..' '..end_line)

	local comment = vim.bo.commentstring
	if comment == "" then return end
	comment = string.gsub(comment, "%%s", "")

	-- TODO: need to escape regex metacharacters
	-- {-} means "non-greedy *"
	local regex = [[s/\(\s*\)\(.\{-}\) \?\(]]..comment..[[.*\)/\1\3\r\1\2/e]]
	for line = end_line, start, -1 do
		vim.cmd('keeppatterns '..line..regex)
	end

	vim.fn.winrestview(view)
end, { range = true, desc = "Move comment to line above" })