lazy-loading tokyonight.nvim colorscheme on macOS

[winkee01]

I tried to lazy load a bunch of colorschemes so that I can apply them via command :colorscheme tokyonight for example.
However, no matter how I set the triggers, it always gave me errors saying that

Error detected while processing /Users/winkee/.local/share/nvim/site/pack/rocks/opt/tokyonight.nvim/colors/tokyonight.lua:
                                                                                                                                           
E5113: Error while calling lua chunk: ...ite/pack/rocks/opt/tokyonight.nvim/colors/tokyonight.lua:1: module 'tokyonight' not found:No LuaRo
cks module found for tokyonight                                                                                                            
        no field package.preload['tokyonight']                                                                                             
        cache_loader: module 'tokyonight' not found                                                                                        
        cache_loader_lib: module 'tokyonight' not found                                                                                    
        no file './tokyonight.lua'                                                                                                         
        no file '/opt/homebrew/share/luajit-2.1/tokyonight.lua'                                                                            
        no file '/usr/local/share/lua/5.1/tokyonight.lua'                                                                                  
        no file '/usr/local/share/lua/5.1/tokyonight/init.lua'                                                                             
        no file '/opt/homebrew/share/lua/5.1/tokyonight.lua'                                                                               
        no file '/opt/homebrew/share/lua/5.1/tokyonight/init.lua'                                                                          
        no file '/Users/winkee/.local/share/nvim/rocks/share/lua/5.1/tokyonight.lua'                                      
        no file '/Users/winkee/.local//share/nvim/rocks/share/lua/5.1/tokyonight/init.lua'                                 
        no file '/Users/winkee/.local/share/nvim/rocks/share/lua/5.1/init.lua'                                            
        no file './tokyonight.so'                                                                                                          
        no file '/usr/local/lib/lua/5.1/tokyonight.so'                                                                                     
        no file '/opt/homebrew/lib/lua/5.1/tokyonight.so'                                                                                  
        no file '/usr/local/lib/lua/5.1/loadall.so'                                                                                        
        no file '/Users/winkee/.local/share/nvim/rocks/lib/lua/5.1/tokyonight.so'                                         
        no file '/Users/winkee/.local/share/nvim/rocks/lib64/lua/5.1/tokyonight.so'                                       
stack traceback:                                                                                                                           
        [C]: in function 'require'                                                                                                         
        ...ite/pack/rocks/opt/tokyonight.nvim/colors/tokyonight.lua:1: in main chunk  

here is my rocks.toml

[plugins."tokyonight.nvim"]
git = "folke/tokyonight.nvim"
opt = true

and my lazy_specs/colorscheme.lua:

return {
  {
    "folke/tokyonight.nvim",
    -- lazy = true,
    load = function(name)
      vim.cmd("packadd " .. name) 
    end,
    -- event = "ColorScheme",
    event = 'BufRead',
    priority = 1000, 
    after = function()
      require("tokyonight").setup({
        style = "moon",  -- 'storm', 'moon', 'night', 'day'
        transparent = true,  -- Enable transparent background
        terminal_colors = true,  -- Set terminal colors
        styles = {
          comments = { italic = true },
          keywords = { italic = true },
          functions = { bold = true },
          variables = {},
          sidebars = "dark",  -- Style for sidebars
          floats = "dark",  -- Style for floating windows
        },
        sidebars = { "qf", "help", "terminal" },  -- Darker background for listed sidebars
        dim_inactive = true,  -- Dim inactive windows
        lualine_bold = true,  -- Bold section headers in lualine
        on_highlights = function(hl, c)
          -- Customize specific highlight groups (example for LineNr)
          hl.LineNr = {
            fg = c.blue,  -- Change line number color to blue
          }
        end,
      })
      -- vim.cmd.colorscheme("tokyonight")
    end,
  },
}

How can I fix this?

much appreciated

[mrcjkb]

Hey 👋

You need to reference the plugin by name, not by owner/repo. And if the colorscheme requires a setup function, it should probably go in the before hook if it's a luarocks package.

There's also no need to override the load function.

So I'd change your snippet to:

return {
  {
    'tokyonight.nvim',
    colorscheme = 'tokyonight',
    before = function()
      require("tokyonight").setup({
        -- ...
      })
    end,
  },
}

or, if you want to defer setting the colorscheme to a BufRead event:

return {
  {
    'tokyonight.nvim',
    event = 'BufRead',
    before = function()
      require("tokyonight").setup({
        -- ...
      })
    end,
    after = function()
      vim.cmd.colorscheme("tokyonight")
    end,
  },
}

[winkee01]

I immediately tested it with this setting

however, when I press :colorscheme tokyonight, it still complained No LuaRocks Module found for tokyonight

[plugins."tokyonight.nvim"]
git = "folke/tokyonight.nvim"
opt = true

Also, as you mentioned, I also changed the tile from "folke/tokyonight.nvim" to "tokyonight.nvim", however, it didn't seem to affect.
also, I noticed that, for other plugins in directory lazy_specs, referring a plugin by repo/name doesn't seem to have problems.

[winkee01]

ok, finally, I chopped down almost everything and made a minimal config, can you check on that? https://github.com/winkee01/mimal

Thanks a lot!

[winkee01]

Can you please check on that? Thanks!

[mrcjkb]

Please don't pressure me; I am doing this in my free time! 👎

Also, that is not a minimal config. There are lots of plugins.
Please reduce it down to a single plugin with which it can be reproduced.

[winkee01]

Sorry, didn't intend to, you can comment each out, they are not dependent on each other, I leave them there because none of them work. I have spent the whole week on this, so I guess it's time to give up and stay with lazy.nvim.

[mrcjkb]

so I guess it's time to give up and stay with lazy.nvim

If you expect open source maintainers to provide full-fledged "customer support" in their free time, then yes, I strongly recommend you switch to using software with a much larger user base, where you'll be more likely to get quicker support from other users.

Seeing the config you posted is no longer available, I assume you have switched back to lazy.nvim and I can close this discussion.

For the record:

I just tried reproducing it on macOS 15.2 (arm64), with the following config:

# rocks.toml
[plugins]
"rocks.nvim" = "2.42.3"
"rocks-git.nvim" = "2.5.2"
"rocks-lazy.nvim" = "1.1.1"

[plugins."tokyonight.nvim"]
git = "folke/tokyonight.nvim"
rev = "v4.11.0"
opt = true

[rocks_lazy]
import = "lazy_specs/"

-- lua/lazy_specs/colorscheme.lua
return {
  {
    'tokyonight.nvim',
    event = 'DeferredUIEnter',
    after = function()
      require("tokyonight").setup({
        style = "moon",
        -- ...
      })
      vim.cmd.colorscheme("tokyonight")
    end,
  },
}

... and it worked just fine.