Copy relative path or filename of file under cursor

[ghillb]

Hi, what do you think about adding a feature like nvim-tree's copy_name and copy_path?

key	function	description
y	copy_name	copy name to system clipboard
Y	copy_path	copy relative path to system clipboard

[kay-adamof]

The lack of this feature makes me hesitate to move to Neo-tree. I WANT IT!

[nagy135]

I always open file and use these binds ...but this feature would be better for sure!

" absolute path to clipboard
nnoremap <F1> :let @+ = expand("%:p")<CR>
" relative path to clipboard
nnoremap <F2> :let @+ = expand("%:f")<CR>
" filename to clipboard
nnoremap <F3> :let @+ = expand("%:t")<CR>

[adoyle-h]

Try my answer.

[adoyle-h]

require('neo-tree').setup {
  window = {
    mappings = {
      ['Y'] = function(state)
        -- NeoTree is based on [NuiTree](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree)
        -- The node is based on [NuiNode](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree#nuitreenode)
        local node = state.tree:get_node()
        local filepath = node:get_id()
        local filename = node.name
        local modify = vim.fn.fnamemodify

        local results = {
          filepath,
          modify(filepath, ':.'),
          modify(filepath, ':~'),
          filename,
          modify(filename, ':r'),
          modify(filename, ':e'),
        }

        -- absolute path to clipboard
        local i = vim.fn.inputlist({
          'Choose to copy to clipboard:',
          '1. Absolute path: ' .. results[1],
          '2. Path relative to CWD: ' .. results[2],
          '3. Path relative to HOME: ' .. results[3],
          '4. Filename: ' .. results[4],
          '5. Filename without extension: ' .. results[5],
          '6. Extension of the filename: ' .. results[6],
        })

        if i > 0 then
          local result = results[i]
          if not result then return print('Invalid choice: ' .. i) end
          vim.fn.setreg('"', result)
          vim.notify('Copied: ' .. result)
        end
      end
    }
  }
}

---- Update ----

If you are using https://github.com/stevearc/dressing.nvim, try below codes. (Inspired by @mehalter 's comment)

require('neo-tree').setup {
  window = {
    mappings = {
      ['Y'] = function(state)
        -- NeoTree is based on [NuiTree](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree)
        -- The node is based on [NuiNode](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree#nuitreenode)
        local node = state.tree:get_node()
        local filepath = node:get_id()
        local filename = node.name
        local modify = vim.fn.fnamemodify

        local results = {
          filepath,
          modify(filepath, ':.'),
          modify(filepath, ':~'),
          filename,
          modify(filename, ':r'),
          modify(filename, ':e'),
        }

        vim.ui.select({
          '1. Absolute path: ' .. results[1],
          '2. Path relative to CWD: ' .. results[2],
          '3. Path relative to HOME: ' .. results[3],
          '4. Filename: ' .. results[4],
          '5. Filename without extension: ' .. results[5],
          '6. Extension of the filename: ' .. results[6],
        }, { prompt = 'Choose to copy to clipboard:' }, function(choice)
          local i = tonumber(choice:sub(1, 1))
          local result = results[i]
          vim.fn.setreg('"', result)
          vim.notify('Copied: ' .. result)
        end)
      end
    }
  }
}

[Marv963]

@t18n Do you tried my customized configuration too? I also use lazyvim with the default configuration, and it does work for me.

{
  "nvim-neo-tree/neo-tree.nvim",
  opts = {
    filesystem = {
      filtered_items = {
        hide_dotfiles = false,
        hide_by_name = {
          "__pycache__",
          ".git",
          ".vscode",
          ".DS_Store",
        },
        never_show = {
          ".php-cs-fixer.cache",
        },
        never_show_by_pattern = {
          ".null-ls_*",
        },
      },
      window = {
        mappings = {
          ["Y"] = function(state)
            -- NeoTree is based on [NuiTree](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree)
            -- The node is based on [NuiNode](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree#nuitreenode)
            local node = state.tree:get_node()
            local filepath = node:get_id()
            local filename = node.name
            local modify = vim.fn.fnamemodify

            local results = {
              filepath,
              modify(filepath, ":."),
              modify(filepath, ":~"),
              filename,
              modify(filename, ":r"),
              modify(filename, ":e"),
            }

            local messages = {
              "Choose to copy to clipboard:",
              "1. Absolute path: " .. results[1],
              "2. Path relative to CWD: " .. results[2],
              "3. Path relative to HOME: " .. results[3],
              "4. Filename: " .. results[4],
              "5. Filename without extension: " .. results[5],
              "6. Extension of the filename: " .. results[6],
            }
            vim.api.nvim_echo({ { table.concat(messages, "\n"), "Normal" } }, true, {})
            local i = vim.fn.getchar()

            if i >= 49 and i <= 54 then
              local result = results[i - 48]
              print(result)
              vim.fn.setreg("*", result)
            else
              print("Invalid choice: " .. string.char(i))
            end
          end,
        },
      },
    },
  },
},

[MuhammadSawalhy]

@cseickel this should be a default keybinding in the plugin.

[mehalter]

I've been using this mapping for a while and I recently did a rewrite to have a few improvements:

• use vim.ui.select which is quite nice. By default it gives the select by 1/2/3/... but if you have vim.ui.select overridden then it will match the rest of the UI.
• moved the function to the global commands section so that we can use it in a global mapping. This makes the text nice in the help menu with ?
• filter out empty values. For example using it on a folder will have no extension, so don't give that as a copy option
• Added file URI to the copyable formats

require("neo-tree").setup {
  commands = {
    copy_selector = function(state)
      local node = state.tree:get_node()
      local filepath = node:get_id()
      local filename = node.name
      local modify = vim.fn.fnamemodify

      local vals = {
        ["BASENAME"] = modify(filename, ":r"),
        ["EXTENSION"] = modify(filename, ":e"),
        ["FILENAME"] = filename,
        ["PATH (CWD)"] = modify(filepath, ":."),
        ["PATH (HOME)"] = modify(filepath, ":~"),
        ["PATH"] = filepath,
        ["URI"] = vim.uri_from_fname(filepath),
      }

      local options = vim.tbl_filter(
        function(val)
          return vals[val] ~= ""
        end,
        vim.tbl_keys(vals)
      )
      if vim.tbl_isempty(options) then
        vim.notify("No values to copy", vim.log.levels.WARN)
        return
      end
      table.sort(options)
      vim.ui.select(options, {
        prompt = "Choose to copy to clipboard:",
        format_item = function(item)
          return ("%s: %s"):format(item, vals[item])
        end,
      }, function(choice)
        local result = vals[choice]
        if result then
          vim.notify(("Copied: `%s`"):format(result))
          vim.fn.setreg("+", result)
        end
      end)
    end,
  },
  window = {
    mappings = {
      Y = "copy_selector",
    },
  },
}

[vcfvct]

Bing Chat took me here when trying to find a solution to copy file name. Was to copy the script adoyle-h posted to my custom config but scrolled to the bottom and found a familiar Avatar. And I then tried Y in my neotree, all these options are already available thanks to that I am using AstroNvim. 🤣
Thanks a lot @mehalter !!! 👍

I've been using this mapping for a while and I recently did a rewrite to have a few improvements:

• use vim.ui.select which is quite nice. By default it gives the select by 1/2/3/... but if you have vim.ui.select overridden then it will match the rest of the UI.
• moved the function to the global commands section so that we can use it in a global mapping. This makes the text nice in the help menu with ?
• filter out empty values. For example using it on a folder will have no extension, so don't give that as a copy option
• Added file URI to the copyable formats

[t18n]

@mehalter Wow, this works wonder. Thank you!

[liketoeatcheese]

Inspired by @adoyle-h <3, for anyone who wants one keystroke approach like me, and got used with nvim-tree ways (note that I remapped c to "copy_to_clipboard" instead):

["y"] = function(state)
	-- NeoTree is based on [NuiTree](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree)
	-- The node is based on [NuiNode](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree#nuitreenode)
	local node = state.tree:get_node()
	local filename = node.name
	vim.fn.setreg('"', filename)
	vim.notify("Copied: " .. filename)
end,
["Y"] = function(state)
	-- NeoTree is based on [NuiTree](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree)
	-- The node is based on [NuiNode](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree#nuitreenode)
	local node = state.tree:get_node()
	local filepath = node:get_id()
	vim.fn.setreg('"', filepath)
	vim.notify("Copied: " .. filepath)
end,

[AH-Merii]

Inspired by @adoyle-h's comment, this adds error handling to gracefully manage cases where a user cancels the selection or makes an invalid choice:

local function copy_path(state)
	-- NeoTree is based on [NuiTree](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree)
	-- The node is based on [NuiNode](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/tree#nuitreenode)
	local node = state.tree:get_node()
	local filepath = node:get_id()
	local filename = node.name
	local modify = vim.fn.fnamemodify

	local results = {
		filepath,
		modify(filepath, ":."),
		modify(filepath, ":~"),
		filename,
		modify(filename, ":r"),
		modify(filename, ":e"),
	}

	vim.ui.select({
		"1. Absolute path: " .. results[1],
		"2. Path relative to CWD: " .. results[2],
		"3. Path relative to HOME: " .. results[3],
		"4. Filename: " .. results[4],
		"5. Filename without extension: " .. results[5],
		"6. Extension of the filename: " .. results[6],
	}, { prompt = "Choose to copy to clipboard:" }, function(choice)
		if choice then
			local i = tonumber(choice:sub(1, 1))
			if i then
				local result = results[i]
				vim.fn.setreg('"', result)
				vim.notify("Copied: " .. result)
			else
				vim.notify("Invalid selection")
			end
		else
			vim.notify("Selection cancelled")
		end
	end)
end

Simply map the function to the desired key:

window = {
	mappings = {
		["Y"] = copy_path,
		-- Additional mappings
	},
}