Custom highlight for the openspec archive folder in NeoVim

[mipmip]

I made this change in my neovim so I can easily find the archive folder in changes. Maybe you like it...

Setup

1. Define highlight groups (in your init.lua or after neo-tree loads):

  vim.api.nvim_set_hl(0, "NeoTreeArchiveIcon", { fg = "#d79921" })
  vim.api.nvim_set_hl(0, "NeoTreeArchiveFolder", { fg = "#a89984", italic = true })

Adjust the colors to match your colorscheme. The above uses gruvbox yellow for the icon and gruvbox gray for the text.

2. Override icon and name components in your neo-tree setup:

  require("neo-tree").setup({
    filesystem = {
      components = {
        icon = function(config, node, state)
          local cc = require("neo-tree.sources.common.components")
          local result = cc.icon(config, node, state)
          if node.type == "directory"
             and node.name == "archive"
             and node:get_parent_id()
             and node:get_parent_id():match("/openspec/changes$") then
            result.text = "󰀼 " -- the nerdfont charachter doesn't render here, but you get what I mean.
            result.highlight = "NeoTreeArchiveIcon"
          end
          return result
        end,
        name = function(config, node, state)
          local cc = require("neo-tree.sources.common.components")
          local result = cc.name(config, node, state)
          if node.type == "directory"
             and node.name == "archive"
             and node:get_parent_id()
             and node:get_parent_id():match("/openspec/changes$") then
            result.highlight = "NeoTreeArchiveFolder"
          end
          return result
        end,
      },
      -- ... rest of your filesystem config
    },
    -- ... rest of your neo-tree config
  })