perf(startup): improve rendering on nvim start (#202)

Author: linrongbin16

lua/colorbox.lua

@@ -1,12 +1,14 @@
 local logging = require("colorbox.commons.logging")
 local LogLevels = require("colorbox.commons.logging").LogLevels
 local strings = require("colorbox.commons.strings")
+local tables = require("colorbox.commons.tables")
 
 local configs = require("colorbox.configs")
 local timing = require("colorbox.timing")
 local track = require("colorbox.track")
 local runtime = require("colorbox.runtime")
 local controller = require("colorbox.controller")
+local loader = require("colorbox.loader")
 
 --- @param opts colorbox.Options?
 local function setup(opts)
@@ -78,30 +80,7 @@ local function setup(opts)
 
   vim.api.nvim_create_autocmd("ColorSchemePre", {
     callback = function(event)
-      local logger = logging.get("colorbox") --[[@as commons.logging.Logger]]
-      -- logger:debug("|colorbox.setup| ColorSchemePre event:%s", vim.inspect(event))
-      local ColorNameToColorSpecsMap = require("colorbox.db").get_color_name_to_color_specs_map()
-      if type(event) ~= "table" or ColorNameToColorSpecsMap[event.match] == nil then
-        return
-      end
-      local spec = ColorNameToColorSpecsMap[event.match]
-      local autoload = string.format("%s/autoload", spec.full_pack_path)
-      vim.opt.runtimepath:append(autoload)
-      vim.cmd(string.format([[packadd %s]], spec.git_path))
-      if type(confs.setup) == "table" and type(confs.setup[spec.handle]) == "function" then
-        local home_dir = vim.fn["colorbox#base_dir"]()
-        local ok, setup_err = pcall(confs.setup[spec.handle], home_dir, spec)
-        if not ok then
-          logger:err(
-            "failed to setup colorscheme:%s, error:%s",
-            vim.inspect(spec.handle),
-            vim.inspect(setup_err)
-          )
-        end
-      end
-      if confs.background == "dark" or confs.background == "light" then
-        vim.opt.background = confs.background
-      end
+      loader.load(tables.tbl_get(event, "match"))
     end,
   })
 

lua/colorbox/loader.lua

@@ -0,0 +1,44 @@
+local logging = require("colorbox.commons.logging")
+local strings = require("colorbox.commons.strings")
+local tables = require("colorbox.commons.tables")
+
+local configs = require("colorbox.configs")
+
+local M = {}
+
+--- @param colorname string?
+M.load = function(colorname)
+  local ColorNameToColorSpecsMap = require("colorbox.db").get_color_name_to_color_specs_map()
+
+  if strings.empty(colorname) then
+    return
+  end
+  local spec = ColorNameToColorSpecsMap[colorname]
+  if tables.tbl_empty(spec) then
+    return
+  end
+
+  local autoload_path = string.format("%s/autoload", spec.full_pack_path)
+  vim.opt.runtimepath:append(autoload_path)
+  vim.cmd(string.format([[packadd %s]], spec.git_path))
+
+  local confs = configs.get()
+  local logger = logging.get("colorbox") --[[@as commons.logging.Logger]]
+  if type(confs.setup) == "table" and vim.is_callable(confs.setup[spec.handle]) then
+    local home_dir = vim.fn["colorbox#base_dir"]()
+    local ok, setup_err = pcall(confs.setup[spec.handle], home_dir, spec)
+    logger:ensure(
+      ok,
+      "failed to setup colorscheme:%s, error:%s",
+      vim.inspect(spec.handle),
+      vim.inspect(setup_err)
+    )
+  end
+  if confs.background == "dark" or confs.background == "light" then
+    vim.opt.background = confs.background
+  end
+
+  vim.cmd(string.format("colorscheme %s", colorname))
+end
+
+return M

lua/colorbox/policy.lua

@@ -1,6 +1,3 @@
-local logging = require("colorbox.commons.logging")
-local numbers = require("colorbox.commons.numbers")
-
 local configs = require("colorbox.configs")
 
 local builtin_policy = require("colorbox.policy.builtin")

lua/colorbox/policy/builtin.lua

@@ -3,6 +3,7 @@ local numbers = require("colorbox.commons.numbers")
 
 local runtime = require("colorbox.runtime")
 local track = require("colorbox.track")
+local loader = require("colorbox.loader")
 
 local M = {}
 
@@ -18,7 +19,8 @@ M.shuffle = function()
       vim.inspect(#ColorNamesList),
       vim.inspect(i)
     )
-    vim.cmd(string.format([[color %s]], color))
+
+    loader.load(color)
   end
 end
 
@@ -28,7 +30,8 @@ M.in_order = function()
     local previous_track = track.previous_track() --[[@as colorbox.PreviousTrack]]
     local i = previous_track ~= nil and previous_track.color_number or 0
     local color = track.get_next_color_name_by_idx(i)
-    vim.cmd(string.format([[color %s]], color))
+
+    loader.load(color)
   end
 end
 
@@ -38,7 +41,8 @@ M.reverse_order = function()
     local previous_track = track.previous_track() --[[@as colorbox.PreviousTrack]]
     local i = previous_track ~= nil and previous_track.color_number or (#ColorNamesList + 1)
     local color = track.get_prev_color_name_by_idx(i)
-    vim.cmd(string.format([[color %s]], color))
+
+    loader.load(color)
   end
 end
 
@@ -49,7 +53,7 @@ M.single = function()
     local color = previous_track ~= nil and previous_track.color_name
       or track.get_next_color_name_by_idx(0)
     if color ~= vim.g.colors_name then
-      vim.cmd(string.format([[color %s]], color))
+      loader.load(color)
     end
   end
 end

lua/colorbox/policy/filetype.lua

@@ -2,6 +2,7 @@ local strings = require("colorbox.commons.strings")
 
 local configs = require("colorbox.configs")
 local track = require("colorbox.track")
+local loader = require("colorbox.loader")
 
 local M = {}
 
@@ -25,20 +26,14 @@ M.run = function()
     local confs = configs.get()
     local ft = vim.bo.filetype or ""
 
-    if confs.policy.mapping[ft] then
-      local ok, err =
-        pcall(vim.cmd --[[@as function]], string.format([[color %s]], confs.policy.mapping[ft]))
-      assert(ok, err)
+    if strings.not_empty(confs.policy.mapping[ft]) then
+      loader.load(confs.policy.mapping[ft])
       track.sync_syntax()
     elseif strings.empty(ft) and strings.not_empty(confs.policy.empty) then
-      local ok, err =
-        pcall(vim.cmd --[[@as function]], string.format([[color %s]], confs.policy.empty))
-      assert(ok, err)
+      loader.load(confs.policy.empty)
       track.sync_syntax()
     elseif strings.not_empty(confs.policy.fallback) then
-      local ok, err =
-        pcall(vim.cmd --[[@as function]], string.format([[color %s]], confs.policy.fallback))
-      assert(ok, err)
+      loader.load(confs.policy.fallback)
       track.sync_syntax()
     end
   end, 10)

lua/colorbox/timing.lua

@@ -5,7 +5,7 @@ local M = {}
 
 M.startup = function()
   vim.api.nvim_create_autocmd({ "VimEnter" }, {
-    callback = vim.schedule_wrap(policy.run),
+    callback = policy.run,
   })
 end
 
@@ -16,12 +16,12 @@ M.filetype = function()
     "WinEnter",
     "TermEnter",
   }, {
-    callback = vim.schedule_wrap(policy.run),
+    callback = policy.run,
   })
 end
 
 M.fixed_interval = function()
-  vim.schedule_wrap(policy.run)()
+  policy.run()
 end
 
 M.setup = function()

spec/colorbox/controller_spec.lua

@@ -47,22 +47,22 @@ describe("colorbox.controller", function()
         controller.update()
       end
     end)
-    it("clean", function()
-      if not github_actions then
-        controller.clean()
-      end
-    end)
+    -- it("clean", function()
+    --   if not github_actions then
+    --     controller.clean()
+    --   end
+    -- end)
     it("info", function()
       if not github_actions then
         controller.info("scale=0.7")
         controller.info()
         controller.info("")
       end
     end)
-    it("reinstall", function()
-      if not github_actions then
-        controller.reinstall()
-      end
-    end)
+    -- it("reinstall", function()
+    --   if not github_actions then
+    --     controller.reinstall()
+    --   end
+    -- end)
   end)
 end)

spec/colorbox/loader_spec.lua

@@ -0,0 +1,31 @@
+local cwd = vim.fn.getcwd()
+
+describe("colorbox.loader", function()
+  local assert_eq = assert.is_equal
+  local assert_true = assert.is_true
+  local assert_false = assert.is_false
+
+  before_each(function()
+    vim.api.nvim_command("cd " .. cwd)
+  end)
+
+  local github_actions = os.getenv("GITHUB_ACTIONS") == "true"
+  local runtime = require("colorbox.runtime")
+  local loader = require("colorbox.loader")
+  require("colorbox").setup({
+    debug = true,
+    file_log = true,
+    background = "dark",
+  })
+
+  describe("loader", function()
+    it("load", function()
+      -- if not github_actions then
+      local colors = runtime.colornames()
+      for i, c in ipairs(colors) do
+        loader.load(c)
+      end
+      -- end
+    end)
+  end)
+end)