Sharing 3 Yazi plugins for yanking content and structure of files and directories

[yuvals1]

Hello Yazi community,

I've created three plugins for Yazi that I use in my personal workflow and I thought I'd share them in case they might be useful to others:

1. yank-dir-content:

   • Creates an ASCII tree of a directory
   • Copies content of supported files within the directory, including nested directories
   • Formats output with Markdown headers and code blocks, maintaining the original directory hierarchy
   • Aligns content to reflect the nested structure

2. tree-to-clipboard:

   • Generates an ASCII tree of the hovered directory
   • Copies the tree structure to clipboard

3. yank-selected-content:

   • Copies content of selected files (or hovered file if none selected)
   • Formats output with Markdown headers and code blocks

I mainly use those in my LLM interactions when i need to quickly yank out the content and structure of files and directories.

code:

yank-dir-content.yazi/init.lua

local function info(content)
	return ya.notify({
		title = "Yank Directory Content",
		content = content,
		timeout = 5,
	})
end

local hovered_url = ya.sync(function()
	local h = cx.active.current.hovered
	return h and h.url
end)

local function get_language(file)
	local ext = file:match("%.([^%.]+)$")
	if ext then
		ext = ext:lower()
		local extensions = {
			py = "python",
			js = "javascript",
			html = "html",
			css = "css",
			lua = "lua",
			md = "markdown",
			txt = "text",
			-- Add more as needed
		}
		return extensions[ext]
	end
	return nil
end

local function split_path(path)
	local parts = {}
	for part in path:gmatch("[^/]+") do
		table.insert(parts, part)
	end
	return parts
end

local function format_path(path, base_path)
	return path:sub(#base_path + 2) -- +2 to remove leading '/'
end

-- Improved path comparison function
local function compare_paths(a, b)
	local a_parts = split_path(a)
	local b_parts = split_path(b)
	for i = 1, math.min(#a_parts, #b_parts) do
		if a_parts[i] ~= b_parts[i] then
			if a_parts[i]:match("%.yazi$") and not b_parts[i]:match("%.yazi$") then
				return false
			elseif b_parts[i]:match("%.yazi$") and not a_parts[i]:match("%.yazi$") then
				return true
			else
				return a_parts[i] < b_parts[i]
			end
		end
	end
	return #a_parts < #b_parts
end

-- Function to generate ASCII tree
local function generate_tree(dir_url)
	local output, err = Command("tree")
		:arg("-L")
		:arg("3") -- Limit depth to 3 levels, adjust as needed
		:arg("--charset=ascii") -- Use ASCII characters for compatibility
		:arg(tostring(dir_url))
		:output()

	if not output then
		return "Failed to generate tree, error: " .. err
	end

	return output.stdout
end

return {
	entry = function()
		local dir_url = hovered_url()
		if not dir_url then
			return info("No directory hovered")
		end

		local is_dir = ya.sync(function()
			return cx.active.current.hovered.cha.is_dir
		end)

		if not is_dir then
			return info("Hovered item is not a directory")
		end

		-- Generate ASCII tree
		local tree_content = generate_tree(dir_url)

		local output, err = Command("find"):arg(tostring(dir_url)):output()
		if not output then
			return info("Failed to list directory contents, error: " .. err)
		end

		local paths = {}
		for path in output.stdout:gmatch("[^\r\n]+") do
			table.insert(paths, path)
		end
		table.sort(paths, compare_paths)

		local content = tree_content .. "\n\n" -- Add tree content at the top
		local prev_parts = {}
		local total_lines = 0
		local file_count = 0
		local skipped_count = 0

		for _, path in ipairs(paths) do
			local formatted_path = format_path(path, tostring(dir_url))
			local parts = split_path(formatted_path)
			local is_file = ya.sync(function()
				return not fs.stat(path).is_dir
			end)

			-- Output headers for new directories
			for i = 1, #parts do
				if i > #prev_parts or parts[i] ~= prev_parts[i] then
					content = content .. string.rep("#", i) .. " " .. table.concat(parts, "/", 1, i) .. "\n"
					if i == #parts and not is_file then
						content = content .. "````\n````\n" -- Add empty code block for directories
					end
				end
			end

			if is_file then
				local language = get_language(path)
				if language then
					local file_content, file_err = Command("cat"):arg(path):output()
					if file_content then
						content = content .. "````" .. language .. "\n"
						content = content .. file_content.stdout
						content = content .. "````\n\n"

						local file_lines = select(2, file_content.stdout:gsub("\n", "\n"))
						total_lines = total_lines + file_lines
						file_count = file_count + 1
					else
						content = content .. "Error reading file: " .. file_err .. "\n\n"
					end
				else
					skipped_count = skipped_count + 1
				end
			end

			prev_parts = parts
		end

		ya.clipboard(content)
		info(
			string.format(
				"Copied tree and content of %d files (%d lines) to clipboard. Skipped %d unsupported files.",
				file_count,
				total_lines,
				skipped_count
			)
		)
	end,
}

tree-to-clipboard.yazi/init.lua

-- plugins/tree-from-hovered.yazi/init.lua

local function info(content)
	return ya.notify({
		title = "ASCII Tree",
		content = content,
		timeout = 5,
	})
end

local get_hovered = ya.sync(function()
	local hovered = cx.active.current.hovered
	if hovered then
		return hovered.url, hovered.cha.is_dir
	end
	return nil, false
end)

return {
	entry = function()
		local hovered_path, is_dir = get_hovered()
		if not hovered_path then
			return info("No item hovered")
		end

		local path = tostring(hovered_path)
		if not is_dir then
			-- If the hovered item is a file, use its parent directory
			path = ya.parent_path(path)
		end

		local output, err = Command("tree")
			:arg("-L")
			:arg("3") -- Limit depth to 3 levels, adjust as needed
			:arg("--charset=ascii") -- Use ASCII characters for compatibility
			:arg(path)
			:output()

		if not output then
			return info("Failed to generate tree, error: " .. err)
		end

		local tree = output.stdout
		local line_count = select(2, tree:gsub("\n", "\n"))

		ya.clipboard(tree)
		info(string.format("Copied ASCII tree with %d lines to clipboard", line_count))
	end,
}

yank-selected-content.yazi/init.lua

-- Configuration
local CONFIG = {
	log_to_file = false, -- Set this to false to disable logging to file
}

local function get_log_file_path()
	local home = os.getenv("HOME")
	return home .. "/.config/yazi/yank-selected-content.log"
end

local function log_to_file(message)
	if not CONFIG.log_to_file then
		return -- Exit the function if logging is disabled
	end
	local log_file = io.open(get_log_file_path(), "a")
	if log_file then
		local timestamp = os.date("%Y-%m-%d %H:%M:%S")
		log_file:write(string.format("[%s] %s\n", timestamp, message))
		log_file:close()
	end
end

local function info(content)
	log_to_file(content)
	return ya.notify({
		title = "Yank Content",
		content = content,
		timeout = 5,
	})
end

local function safe_access(func, default)
	local success, result = pcall(func)
	if success then
		return result
	else
		return "Error: " .. tostring(result)
	end
end

local get_selected_files = ya.sync(function()
	local selected = {}
	for _, u in pairs(cx.active.selected) do
		table.insert(selected, tostring(u))
	end
	return selected
end)

local get_hovered_file = ya.sync(function()
	local h = cx.active.current.hovered
	return h and tostring(h.url)
end)

local function get_file_content(file_path)
	local output, err = Command("cat"):arg(file_path):output()
	if not output then
		return nil, "Failed to read file: " .. file_path .. ", error: " .. err
	end
	return output.stdout, nil
end

local function get_language(file)
	local ext = file:match("%.([^%.]+)$")
	if ext then
		ext = ext:lower()
		local extensions = {
			py = "python",
			js = "javascript",
			html = "html",
			css = "css",
			lua = "lua",
			md = "markdown",
			txt = "text",
			-- Add more as needed
		}
		return extensions[ext] or "text"
	end
	return "text"
end

local function get_common_prefix(paths)
	if #paths == 0 then
		return ""
	end
	local shortest = paths[1]
	for i = 2, #paths do
		if #paths[i] < #shortest then
			shortest = paths[i]
		end
	end
	local common_prefix = ""
	for i = 1, #shortest do
		local char = shortest:sub(i, i)
		for j = 1, #paths do
			if paths[j]:sub(i, i) ~= char then
				return common_prefix
			end
		end
		common_prefix = common_prefix .. char
	end
	return common_prefix:match("(.*/)") or ""
end

local function get_relative_path(file_path, common_prefix)
	return file_path:sub(#common_prefix + 1)
end

return {
	entry = function()
		local selected_files = safe_access(get_selected_files, {})

		if #selected_files == 0 then
			-- No files selected, use hovered file
			local hovered_file = safe_access(get_hovered_file)
			if not hovered_file then
				return info("No file selected or hovered")
			end
			selected_files = { hovered_file }
		end

		local common_prefix = get_common_prefix(selected_files)
		local content = "# Common prefix: " .. common_prefix .. "\n\n"
		local error_messages = {}
		local file_count = 0
		local total_lines = 0

		for _, file_path in ipairs(selected_files) do
			local file_content, err = get_file_content(file_path)
			if file_content then
				local relative_path = get_relative_path(file_path, common_prefix)
				local language = get_language(file_path)
				content = content .. "## " .. relative_path .. "\n"
				content = content .. "````" .. language .. "\n"
				content = content .. file_content
				content = content .. "````\n\n"
				file_count = file_count + 1
				total_lines = total_lines + select(2, file_content:gsub("\n", "\n"))
			else
				table.insert(error_messages, err)
			end
		end

		if content ~= "" then
			ya.clipboard(content)
			local success_message
			if file_count == 1 then
				success_message = string.format("Copied content of 1 file (%d lines) to clipboard", total_lines)
			else
				success_message =
					string.format("Copied content of %d files (%d lines) to clipboard", file_count, total_lines)
			end
			info(success_message)
		end

		if #error_messages > 0 then
			local error_content = "Errors:\n" .. table.concat(error_messages, "\n")
			info(error_content)
		end
	end,
}

[xfzv]

Thanks for sharing.

You could create separate repositories for each plug-in so that other users can easily add them and get updates.

They could also be added to AnirudhG07/awesome-yazi list.

[AnirudhG07]

You could make 1 repo containing all 3, and just like how yazi-rs uses plugins with : usage, you could add it. avoid extra repos. This would increase accessibility for these plugin in 1 repo.
It would be great if you could add it to the awesome-yazi list as well!