feat: add colorscheme lazy loading (#170)

Author: yukimemi

README.md

@@ -341,6 +341,8 @@ export type Lazy = {
   ft?: string | string[];
   // Load the plugin when the key is pressed. (Optional)
   keys?: string | string[] | KeyMap | KeyMap[];
+  // Load the plugin when the colorscheme is applied. (Optional)
+  colorscheme?: string | string[];
 };
 
 export type Command = {
@@ -583,6 +585,14 @@ e.g.
     },
   });
 
+  // Load on colorscheme.
+  await dvpm.add({
+    url: "folke/tokyonight.nvim",
+    lazy: {
+      colorscheme: "tokyonight",
+    },
+  });
+
   // Load on keys.
   await dvpm.add({
     url: "mbbill/undotree",

dvpm.ts

@@ -879,6 +879,18 @@ export class Dvpm {
             );
           }
         }
+        if (lazy.colorscheme) {
+          const colorschemes = Array.isArray(lazy.colorscheme)
+            ? lazy.colorscheme
+            : [lazy.colorscheme];
+          await autocmd.define(
+            denops,
+            "ColorSchemePre",
+            colorschemes,
+            `call denops#request('${denops.name}', 'load', ['${p.info.url}', 'colorscheme', '<amatch>'])`,
+            { once: true },
+          );
+        }
         if (lazy.event) {
           const events = Array.isArray(lazy.event) ? lazy.event : [lazy.event];
           await autocmd.define(

plugin.ts

@@ -125,7 +125,7 @@ export class Plugin {
 
   private async initLazy() {
     const lazy = this.info.lazy;
-    if (lazy.cmd || lazy.event || lazy.ft || lazy.keys) {
+    if (lazy.cmd || lazy.event || lazy.ft || lazy.keys || lazy.colorscheme) {
       lazy.enabled = true;
     }
     lazy.enabled = await this.is(lazy.enabled ?? false);

tests/colorscheme_lazy_test.ts

@@ -0,0 +1,58 @@
+// =============================================================================
+// File        : colorscheme_lazy_test.ts
+// Author      : yukimemi
+// Last Change : 2026/04/01 00:00:00.
+// =============================================================================
+
+import { assertEquals } from "@std/assert";
+import { test } from "@denops/test";
+import { Dvpm } from "../dvpm.ts";
+
+test({
+  mode: "all",
+  name: "Lazy Loading: colorscheme trigger defines ColorSchemePre autocmd",
+  fn: async (denops) => {
+    const base = await Deno.makeTempDir();
+    // Use Dvpm.begin to register dispatcher
+    const dvpm = await Dvpm.begin(denops, { base, health: false });
+
+    const colorName = "mycolor";
+    const pluginUrl = "color/plugin";
+    await dvpm.add({
+      url: pluginUrl,
+      lazy: {
+        enabled: true,
+        colorscheme: colorName,
+      },
+    });
+
+    const plugin = dvpm.plugins[0];
+
+    try {
+      await dvpm.end();
+
+      // Check if ColorSchemePre autocmd for mycolor is defined
+      const isDefined = await denops.call("exists", `#ColorSchemePre#${colorName}`);
+      assertEquals(isDefined, 1, `ColorSchemePre autocmd for ${colorName} should be defined`);
+
+      // Manually trigger ColorSchemePre to simulate colorscheme command
+      await denops.cmd(`doautocmd ColorSchemePre ${colorName}`);
+
+      // Verify the plugin was loaded into runtimepath
+      const rtp = await denops.eval("&runtimepath") as string;
+      assertEquals(
+        rtp.includes(plugin.info.dst),
+        true,
+        "Plugin destination should be in runtimepath after trigger",
+      );
+    } finally {
+      // Clean up
+      await denops.cmd(`autocmd! ColorSchemePre ${colorName}`);
+      try {
+        await Deno.remove(base, { recursive: true });
+      } catch {
+        // Ignore
+      }
+    }
+  },
+});

types.ts

@@ -97,6 +97,7 @@ export type LazyParams = {
   event?: string | string[];
   ft?: string | string[];
   keys?: string | string[] | KeyMap | KeyMap[];
+  colorscheme?: string | string[];
 };
 
 const _LazyParamsSchema = type({
@@ -105,14 +106,15 @@ const _LazyParamsSchema = type({
   "event?": "string | string[]",
   "ft?": "string | string[]",
   "keys?": type(KeyMapSchema, "|", "string").array().or(KeyMapSchema).or("string"),
+  "colorscheme?": "string | string[]",
 });
 
 export const LazyParamsSchema: Type<LazyParams> = _LazyParamsSchema as unknown as Type<LazyParams>;
 
 /**
  * Represents the type of load trigger.
  */
-export type LoadType = "cmd" | "keys" | "ft" | "event";
+export type LoadType = "cmd" | "keys" | "ft" | "event" | "colorscheme";
 
 /**
  * Schema for the arguments of the load method.
@@ -146,7 +148,7 @@ const _CmdParamsSchema = type({
 
 const _LoadArgsSchema = type({
   url: "string",
-  "loadType?": type("'cmd' | 'keys' | 'ft' | 'event'").or("undefined"),
+  "loadType?": type("'cmd' | 'keys' | 'ft' | 'event' | 'colorscheme'").or("undefined"),
   "arg?": type("string").or("undefined"),
   "params?": _CmdParamsSchema.or("undefined"),
 });