Merge pull request #4 from jan-xyz/make_edits_selectable_2

Make individual edits selectable

Author: Jan Steinke

README.md

@@ -29,6 +29,12 @@ lazy.nvim:
   dependencies = {
    "nvim-telescope/telescope.nvim",
    "nvim-lua/plenary.nvim",
+  {
+    "echasnovski/mini.nvim",
+    config = function()
+     require("mini.diff").setup({})
+    end,
+    },
   },
 }
 ```
@@ -60,10 +66,6 @@ require("lsp-preview").setup({
  apply = true,
  --Preview all changes per default.
  preview = false,
- --Configuration provided to vim.diff (see `:h vim.diff()`)
- diff = {
-  ctxlen = 5,
- },
 })
 ```
 

lua/lsp-preview/config.lua

@@ -5,14 +5,9 @@ local M = {}
 ---@field apply boolean
 ---Preview all changes per default.
 ---@field previe boolean
----Configuration provided to vim.diff (see `:h vim.diff()`)
----@field diff table
 local default_config = {
 	apply = true,
 	preview = false,
-	diff = {
-		ctxlen = 5,
-	},
 }
 
 

lua/lsp-preview/diff.lua

@@ -4,64 +4,54 @@
 
 local action_state = require("telescope.actions.state")
 
+---The diff hunk
 ---@class Previewable
----@field title fun(self): string
----@field preview fun(self, opts: table): {text: string, syntax: string}
-
----@class Value
 ---@field title string
----@field index string
----@field type string
----@field entry Previewable
+---@field filename fun(self): string
+---Return the index in the workspace_edit, sub_index is only provided for
+---Edits.
+---@field index number | {primary: number, secondary: number}
+---@field preview fun(self, bufnr: integer, winid: integer, opts: table): string
 
-local M = {}
+---The Entry passed around in Telescope
+---@class Entry
+---@field value Previewable
+---@field display fun(entry: Entry)
+---@field ordinal string
 
----@param entry Previewable
-local default_make_value = function(entry)
-	return {
-		title = entry:title(),
-	}
-end
 
----@param values Value[]
-local default_make_make_display = function(values)
+local M = {}
+
+---@param values Previewable[]
+local make_make_display = function(values)
 	local entry_display = require("telescope.pickers.entry_display")
 	local strings = require("plenary.strings")
 
-	local index_width = 0
 	local title_width = 0
 	for _, value in ipairs(values) do
-		index_width = math.max(index_width, strings.strdisplaywidth(value.index))
 		title_width = math.max(title_width, strings.strdisplaywidth(value.title))
 	end
 
 	local displayer = entry_display.create({
 		separator = " ",
 		items = {
-			{ width = index_width + 1 },
 			{ width = title_width },
 		},
 	})
 	return function(entry)
 		return displayer({
-			{ entry.value.index .. ":", "TelescopePromptPrefix" },
 			{ entry.value.title },
 		})
 	end
 end
 
----@param job_id string
----@return boolean
-local job_is_running = function(job_id)
-	return vim.fn.jobwait({ job_id }, 0)[1] == -1
-end
-
 ---@param prompt_bufnr integer
----@return integer[]
+---@return Entry[]
 local get_selected_diffs = function(prompt_bufnr)
+	---@type Entry[]
 	local selected = {}
 	local current_picker = action_state.get_current_picker(prompt_bufnr)
-	---@type Value[]
+	---@type Previewable[]
 	local selections = current_picker:get_multi_selection()
 	if vim.tbl_isempty(selections) then
 		vim.notify("no change selected")
@@ -73,162 +63,74 @@ local get_selected_diffs = function(prompt_bufnr)
 	return selected
 end
 
----@param documentChanges Previewable[]
 ---@param changes Previewable[]
 ---@param apply_selection fun(selected_indices: integer[])
-function M.apply_action(opts, documentChanges, changes, apply_selection)
+function M.apply_action(opts, changes, apply_selection)
 	local actions = require("telescope.actions")
 	local pickers = require("telescope.pickers")
-	local Previewer = require("telescope.previewers.previewer")
+	local previewers = require("telescope.previewers")
 	local finders = require("telescope.finders")
 	local conf = require("telescope.config").values
 	local utils = require("telescope.utils")
 	local putils = require("telescope.previewers.utils")
 
-	local make_value = default_make_value
-	---@type Value[]
-	local values = {}
-	for index, entry in ipairs(documentChanges) do
-		local value = make_value(entry)
+	-- validate the table to have everything we need
+	for _, value in ipairs(changes) do
 		if type(value) ~= "table" then
 			error("'make_value' must return a table")
 		end
-		if value.title == nil then
+		if type(value.title) ~= "string" then
 			error("'make_value' must return a table containing a field 'title'")
 		end
-
-		value.index = index
-		value.entry = entry
-		value.type = "documentChanges"
-
-		table.insert(values, value)
 	end
-	for index, entry in ipairs(changes) do
-		local value = make_value(entry)
-		if type(value) ~= "table" then
-			error("'make_value' must return a table")
-		end
-		if value.title == nil then
-			error("'make_value' must return a table containing a field 'title'")
-		end
 
-		value.index = index
-		value.entry = entry
-		value.type = "changes"
+	local make_display = make_make_display(changes)
 
-		table.insert(values, value)
-	end
-
-	local make_display = default_make_make_display(values)
-
-	local buffers = {}
-	local term_ids = {}
-
-	local previewer = Previewer:new({
-		title = "Code Action Preview",
-		setup = function(_self)
+	local previewer = previewers.new_buffer_previewer({
+		setup = function(self)
 			-- pre-select all changes on picker creation
 			local prompt_bufnr = vim.api.nvim_get_current_buf()
 			actions.select_all(prompt_bufnr)
 			return {}
 		end,
-		teardown = function(self)
-			if not self.state then
-				return
-			end
-
-			self.state.winid = nil
-			self.state.bufnr = nil
-
-			for _, bufnr in ipairs(buffers) do
-				local term_id = term_ids[bufnr]
-				if term_id and job_is_running(term_id) then
-					vim.fn.jobstop(term_id)
-				end
-				utils.buf_delete(bufnr)
-			end
-
-			buffers = {}
-			term_ids = {}
-		end,
-		---@param entry {value: Value}
-		preview_fn = function(self, entry, status)
-			local preview_winid = status.layout and status.layout.preview and status.layout.preview.winid or
-					status.preview_win
-
-			local do_preview = false
-			local bufnr = buffers[entry.value.index]
-			if not bufnr then
-				bufnr = vim.api.nvim_create_buf(false, true)
-				buffers[entry.value.index] = bufnr
-				do_preview = true
-
-				vim.api.nvim_win_set_option(preview_winid, "winhl", "Normal:TelescopePreviewNormal")
-				vim.api.nvim_win_set_option(preview_winid, "signcolumn", "no")
-				vim.api.nvim_win_set_option(preview_winid, "foldlevel", 100)
-				vim.api.nvim_win_set_option(preview_winid, "wrap", false)
-				vim.api.nvim_win_set_option(preview_winid, "scrollbind", false)
-			end
-
-			utils.win_set_buf_noautocmd(preview_winid, bufnr)
-			self.state.winid = preview_winid
-			self.state.bufnr = bufnr
-
-			if do_preview then
-				local preview = entry.value.entry:preview(opts)
-				preview = preview or { syntax = "", text = "preview not available" }
-
-				vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, vim.split(preview.text, "\n", { plain = true }))
-				putils.highlighter(bufnr, preview.syntax, {})
-			end
+		---@param entry Entry
+		define_preview = function(self, entry, status)
+			local filetype = entry.value:preview(self.state.bufnr, self.state.winid, opts)
+			putils.highlighter(self.state.bufnr, filetype, {})
 		end,
-		scroll_fn = function(self, direction)
-			if not self.state then
-				return
-			end
-
-			local count = math.abs(direction)
-			local term_id = term_ids[self.state.bufnr]
-			if term_id and job_is_running(term_id) then
-				local input = direction > 0 and "d" or "u"
-
-				local termcode = vim.api.nvim_replace_termcodes(count .. input, true, false, true)
-				vim.fn.chansend(term_id, termcode)
-			else
-				local input = direction > 0 and [[]] or [[]]
-
-				vim.api.nvim_win_call(self.state.winid, function()
-					vim.cmd([[normal! ]] .. count .. input)
-				end)
-			end
+		---@param entry Entry
+		---@return string
+		get_buffer_by_name = function(self, entry)
+			-- create a single buffer per file.
+			return entry.value:filename()
 		end,
 	})
 
 	local finder = finders.new_table({
-		results = values,
+		results = changes,
 		entry_maker = function(value)
 			return {
 				display = make_display,
-				ordinal = value.index .. value.title,
+				ordinal = value.title,
 				value = value,
 			}
 		end,
 	})
 
 	pickers.new(opts, {
-		prompt_title = "Code Actions",
+		prompt_title = "Edits to apply",
 		previewer = previewer,
 		finder = finder,
 		sorter = conf.generic_sorter(opts),
 		attach_mappings = function(prompt_bufnr, map)
 			map("i", "<c-a>", actions.toggle_all)
 
 			actions.select_default:replace(function()
-				local selections = get_selected_diffs(prompt_bufnr)
+				local selected_entries = get_selected_diffs(prompt_bufnr)
 
 				actions.close(prompt_bufnr)
 
-				apply_selection(selections)
+				apply_selection(selected_entries)
 			end)
 
 			return true

lua/lsp-preview/telescope.lua

@@ -4,52 +4,20 @@ local config = require("lsp-preview.config")
 
 local M = {}
 
----Used as injection for the telescope picker to apply the selection.
----Filters the workspace edit for the selected hunks and applies it.
----@param workspace_edit WorkspaceEdit
----@param offset_encoding string
----@return fun(selected_indices: {value: Value}[])
-local make_apply_func = function(workspace_edit, offset_encoding, orig_apply_workspace_edits)
-	return function(selected_indices)
-		local documentChanges = {}
-		local changes = {}
-		for _, selection in ipairs(selected_indices) do
-			if selection.value.type == "documentChanges" then
-				local index = selection.value.index
-				local edit = workspace_edit.documentChanges[index]
-				table.insert(documentChanges, edit)
-			elseif selection.value.type == "changes" then
-				local entry = selection.value.entry
-				---@cast entry Edit
-				local edit = workspace_edit.changes[entry.uri]
-				changes[entry.uri] = edit
-			end
-		end
-
-		if not vim.tbl_isempty(documentChanges) then
-			workspace_edit.documentChanges = documentChanges
-		end
-		if not vim.tbl_isempty(changes) then
-			workspace_edit.changes = changes
-		end
-		orig_apply_workspace_edits(workspace_edit, offset_encoding)
-	end
-end
 
 ---Overwriting the built-in function with the selection and preview capabilities
 ---@param orig_apply_workspace_edits fun(workspace_edit: WorkspaceEdit, offset_encoding: string)
 ---@return fun(workspace_edit: WorkspaceEdit, offset_encoding: string)
 M.make_apply_workspace_edit = function(orig_apply_workspace_edits)
 	return function(workspace_edit, offset_encoding)
-		local documentChanges, changes = lDiff.get_changes(workspace_edit, offset_encoding)
+		local changes = lDiff.get_changes(workspace_edit, offset_encoding)
 
 		local opts = config
 
 		lTelescope.apply_action(
 			opts,
-			documentChanges,
 			changes,
-			make_apply_func(workspace_edit, offset_encoding, orig_apply_workspace_edits)
+			lDiff.make_apply_func(workspace_edit, offset_encoding, orig_apply_workspace_edits)
 		)
 	end
 end

lua/lsp-preview/workspace_edit.lua

@@ -2,6 +2,7 @@ local lazypath = vim.fn.stdpath("data") .. "/lazy"
 vim.notify = print
 vim.opt.rtp:append(".")
 vim.opt.rtp:append(lazypath .. "/plenary.nvim")
+vim.opt.rtp:append(lazypath .. "/mini.nvim")
 vim.opt.rtp:append(lazypath .. "/nvim-treesitter")
 vim.opt.rtp:append(lazypath .. "/nvim-nio")
 

selection.png

@@ -0,0 +1,105 @@
+local describe = require("plenary.busted").describe
+local it = require("plenary.busted").it
+local before_each = require("plenary.busted").before_each
+local assert = require("luassert.assert")
+
+local diff = require("lsp-preview.diff")
+
+describe("make_apply_func", function()
+	it("filters the workspace_edit documentChanges correctly", function()
+		-- Given
+		---@type WorkspaceEdit
+		local input_workspace_edit = {
+			documentChanges = {
+				{ kind = "create", uri = "create-some-uri" },
+				{ kind = "rename", uri = "rename-some-uri" },
+				{ kind = "delete", uri = "delete-some-uri" },
+				{
+					textDocument = { uri = "edit-some-uri" },
+					edits = {
+						{ range = { start = { line = 1, character = 2 }, ["end"] = { line = 1, character = 10 } }, newText = "foo" },
+						{ range = { start = { line = 2, character = 3 }, ["end"] = { line = 2, character = 11 } }, newText = "bar" },
+						{ range = { start = { line = 3, character = 4 }, ["end"] = { line = 3, character = 12 } }, newText = "baz" },
+					},
+				},
+			},
+		}
+		local input_selected_entries = {
+			{ value = { index = 1 } },
+			{ value = { index = 3 } },
+			{ value = { index = { primary = 4, secondary = 1 } } },
+			{ value = { index = { primary = 4, secondary = 3 } } },
+		}
+
+		-- When
+		---@type WorkspaceEdit
+		local got_workspace_edit = {}
+		local got_offset_encoding = ""
+
+		local capture_fn = function(captured_workspace_edit, captured_offset_encoding)
+			got_workspace_edit = captured_workspace_edit
+			got_offset_encoding = captured_offset_encoding
+		end
+		local fn = diff.make_apply_func(input_workspace_edit, "utf16", capture_fn)
+		fn(input_selected_entries)
+
+		-- Then
+		local want = {
+			documentChanges = {
+				{ kind = "create", uri = "create-some-uri" },
+				{ kind = "delete", uri = "delete-some-uri" },
+				{
+					textDocument = { uri = "edit-some-uri" },
+					edits = {
+						{ range = { start = { line = 1, character = 2 }, ["end"] = { line = 1, character = 10 } }, newText = "foo" },
+						{ range = { start = { line = 3, character = 4 }, ["end"] = { line = 3, character = 12 } }, newText = "baz" },
+					},
+				},
+			},
+		}
+		assert.same(want, got_workspace_edit)
+		assert.equals("utf16", got_offset_encoding)
+	end)
+
+	it("filters the workspace_edit changes correctly", function()
+		-- Given
+		---@type WorkspaceEdit
+		local input_workspace_edit = {
+			changes = {
+				["edit-some-uri"] = {
+					{ range = { start = { line = 1, character = 2 }, ["end"] = { line = 1, character = 10 } }, newText = "foo" },
+					{ range = { start = { line = 2, character = 3 }, ["end"] = { line = 2, character = 11 } }, newText = "bar" },
+					{ range = { start = { line = 3, character = 4 }, ["end"] = { line = 3, character = 12 } }, newText = "baz" },
+				},
+			},
+		}
+		local input_selected_entries = {
+			{ value = { index = { primary = 1, secondary = 1 }, uri = "edit-some-uri" } },
+			{ value = { index = { primary = 1, secondary = 3 }, uri = "edit-some-uri" } },
+		}
+
+		-- When
+		---@type WorkspaceEdit
+		local got_workspace_edit = {}
+		local got_offset_encoding = ""
+
+		local capture_fn = function(captured_workspace_edit, captured_offset_encoding)
+			got_workspace_edit = captured_workspace_edit
+			got_offset_encoding = captured_offset_encoding
+		end
+		local fn = diff.make_apply_func(input_workspace_edit, "utf16", capture_fn)
+		fn(input_selected_entries)
+
+		-- Then
+		local want = {
+			changes = {
+				["edit-some-uri"] = {
+					{ range = { start = { line = 1, character = 2 }, ["end"] = { line = 1, character = 10 } }, newText = "foo" },
+					{ range = { start = { line = 3, character = 4 }, ["end"] = { line = 3, character = 12 } }, newText = "baz" },
+				},
+			},
+		}
+		assert.same(want, got_workspace_edit)
+		assert.equals("utf16", got_offset_encoding)
+	end)
+end)