todo-comments unable to load highlight group colors after auto-session restoration

[teoshibin]

Long story short, todo-comments highlighting won't get the correct color of base46 after session restore of auto-session, but other colors in the editor looks fine. I believe this has something todo with how cached highlight groups are loaded, maybe the order it loads etc. Not a lua expert here so I have no idea how to properly fix it. I just do a very lazy and straight forward workaround to fix it, documented below.

I don't even know if this is even a bug so I'll put it here in the discussion.

Reproducing

So first we'll need 2 external plugins todo-comments and auto-session. base46 is installed.
plugin config for auto-session

  {
    -- open up the same stuff after closing editor
    "rmagatti/auto-session",
    lazy = false,
    config = function()

      -- NOTE: fix nvimtree buffer layout
      -- https://github.com/NvChad/ui/issues/132
      vim.api.nvim_create_autocmd({ "BufEnter" }, {
        pattern = "NvimTree*",
        callback = function()
          local api = require "nvim-tree.api"
          local view = require "nvim-tree.view"
          if not view.is_visible() then
            api.tree.open()
          end
        end,
      })

      require("auto-session").setup {
        auto_session_suppress_dirs = { "~/", "~/Projects", "~/Downloads", "/" },
      }
    end,
  },

plugin config for todo comments

  {
    "folke/todo-comments.nvim",
    dependencies = { "nvim-lua/plenary.nvim" },
    opts = {},
    event = "BufReadPost",
  },

now we could do

:SessionSave
:wqa
nvim

and that will open up the editor with the previously saved session
saving it isn't mandatory but we want to be sure it is saved just for demonstration.

Result

Now, the problem arise, the following is what should've been displayed

And what is actually displayed after session restoration is as follows

I also tried the following command after restoration, the color is correct which is even more confusing why it didn't work for todo-comments.

Extra

Now looking into their todo-comments source code, we see some configs stuff related to highlight groups and some fallback colors (I believe the white we're getting is simply because there's no fallback for it, but the rest will just fallback to their hardcoded colors)

• their color config
• where they do the highlighting

After some more digging around I found out that this is assigned to build, which is the point I realized something is cached.

  -- plugin/init.lua
  {
    "NvChad/base46",
    branch = "v2.0",
    build = function()
      require("base46").load_all_highlights()
    end,
  },

Workaround

As I can't be bothered diving any deeper, I just call load all highlights again for the plugin, but this defeats the purpose of the cache.

  {
    "folke/todo-comments.nvim",
    dependencies = { "nvim-lua/plenary.nvim" },
    config = function()
      require("base46").load_all_highlights()  -- here
      require("todo-comments").setup({
        signs = false,
      })
    end,
    event = "BufReadPost",
  },

I am more than happy to discuss about this if anyone can find out why this happens.

[teoshibin]

Ah v2.5 contains Todo highlight groups integration that can be loaded. Nice

[siduck]

@teoshibin i didnt comment here as i was releasing v2.5 which would also fix your issue 😬