Custom Component Function Does Not Render Custom git_status Symbols

[Leonie-Theobald]

Hey,

I am new to using Neotree (and Nvim actually). Right now, I am trying to tweak the rendering output of my files to show the git_status and then the file name. I'd like to have the file names aligned for which I have defined a custom component that fills in a static default value if there is no git status.

I have two problems:

1. The built-in git_statuscomponent on its own can render my custom git_status symbols (i.e. U, I, US, S, C) but the custom component git_status_or_empty doesn't use those even though I am calling the built-in git_status component within my own definition
2. I have the feeling that my method of retrieving the current git status of a file might not be the intended way and is maybe even part of the problem. By debug printing, I also checked all fields of the nodeparameter because I felt that this is where the associated git information would belong to but I couldn't find any git related field.

I would appreciate very much if you have a suggestion of how I could solve my problem to insert either the git_status with customized symbols and highlighting or a whitespace for each file line rendering.

---

This is how the files are rendered with my configuration. On the left side you can see the default git_status symbols or the --- placeholder in case their is no git_status. On the right side of the file name you can see the git_status symbol when the built-in function is directly used which correctly renders my custom symbols/letters.

This is my current configuration:

require("neo-tree").setup({
	enable_git_status = true,
	default_component_configs = {
		icon = {
			-- override folder symbols
			folder_closed = "■",
			folder_open = "□",
			folder_empty = "⛶",
		},
		enable_git_status = true,

		git_status = {
			-- override git status symbols	
			symbols = {
				-- Change type
				added = "",
				modified = "",
				deleted = "",
				renamed = "",
				-- Status type
				untracked = " U",
				ignored = " I",
				unstaged = "US",
				staged = " S",
				conflict = " C",
			},
			highlight = true,
		},
	},
	filesystem = {
		components = {
			git_status_or_empty = function(config, node, state)
				-- lookup table listing all files and their git status
				-- filter for current file by using file name as lookup key
				local symbol = state.git_status_lookup[node.path]
				
				if symbol == nil then
					-- no git status means no status symbol assigned
					-- return default string
					return {
						text = "---"
					}
				else
					-- found git status / call built-in "git_status" component
					return {
						require("neo-tree.sources.common.components").git_status(config, node, state)
					}
				end
			end,
		},
		renderers = {
			file = {
				{ "git_status_or_empty" }, -- correctly shows placeholder or git_status depending on 
				                           -- but doesn't use the customized symbols
				{ "name" },
				{ "git_status" }, -- built-in git_status shows correct customized symbols
			},
		},
	},
})

[Leonie-Theobald]

I found a solution with this setup. Still not sure whether this is the intended method but it works for me:

require("neo-tree").setup({
	default_component_configs = {
		icon = {
			-- override folder symbols
			folder_closed = "■",
			folder_open = "□",
			folder_empty = "⛶",
		},
	},
	filesystem = {
		components = {
			git_status_or_empty = function(config, node, state)
				local git_status = require("neo-tree.sources.common.components")
					.git_status(config, node, state).text

				-- not part of git status
				if git_status == nil then
					return {
						text = "-",
						highlight = "NeoTreeDarkFont"
					}
				-- untracked
				elseif git_status == "[?]" then
					return {
						text = "U",
						highlight = "NeoTreeGitUntracked"
					}	
				-- ignored
				elseif git_status == "[!!]" then
					return {
						text = "I",
						highlight = "NeoTreeGitIgnored"
					}	
				-- unstaged or modified
				elseif git_status == "[ M]" or git_status == "[M]" then
					return {
						text = "Z",
						highlight = "NeoTreeGitUnstaged"
					}	
				-- deleted
				elseif git_status == "[D]" then
					return {
						text = "D",
						highlight = "NeoTreeGitUnstaged"
					}	
				-- staged
				elseif git_status == "[A]" then
					return {
						text = "S",
						highlight = "NeoTreeGitStaged"
					}	
				-- partially staged and modified/unstaged
				-- happens if a file is staged and then modified again
				elseif git_status == "[MM]" then
					return {
						text = "5",
						highlight = "NeoTreeGitUnstaged"
					}	
				-- conflict
				elseif git_status == "[C]" then
					return {
						text = "C",
						highlight = "NeoTreeGitConflict"
					}	
				-- missing git status symbol
				else
					return {
						text = git_status,
						highlight = "Normal"
					}
				end
			end,
		},
		renderers = {
			file = {
				{ "git_status_or_empty" },
				{ "name" },
			},
		},
	},
})