cloudflare/kumo

Public

mirrored fromhttps://github.com/cloudflare/kumoAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
dcc30c61f1ff301fa2f86d737fe9029352677b34

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

packages/kumo-docs-astro/src/lib/vite-plugin-kumo-registry.ts

80lines · modepreview

import { readFile } from "node:fs/promises";
import { dirname, resolve } from "node:path";
import { fileURLToPath } from "node:url";

const __dirname = dirname(fileURLToPath(import.meta.url));

const VIRTUAL_MODULE_ID = "virtual:kumo-registry";
const RESOLVED_VIRTUAL_MODULE_ID = "\0" + VIRTUAL_MODULE_ID;

/**
 * Vite plugin that provides component registry data as a virtual module.
 * Loads the markdown file at dev time, no build step required.
 * Hot reloads when the registry file changes.
 *
 * @returns Astro/Vite compatible plugin
 */
export function kumoRegistryPlugin() {
  // Navigate from kumo-docs-astro/src/lib to kumo/ai/
  const registryFiles = {
    markdown: resolve(__dirname, "../../../kumo/ai/component-registry.md"),
    json: resolve(__dirname, "../../../kumo/ai/component-registry.json"),
  };

  return {
    name: "vite-plugin-kumo-registry",

    resolveId(id: string) {
      if (id === VIRTUAL_MODULE_ID) {
        return RESOLVED_VIRTUAL_MODULE_ID;
      }
    },

    async load(id: string) {
      if (id === RESOLVED_VIRTUAL_MODULE_ID) {
        const [markdown, json] = await Promise.all([
          readFile(registryFiles.markdown, "utf8"),
          readFile(registryFiles.json, "utf8"),
        ]);

        return `
export const kumoRegistryMarkdown = ${JSON.stringify(markdown)};
export const kumoRegistryJson = ${json};
`;
      }
    },

    configureServer(server: {
      watcher: {
        add: (paths: string[]) => void;
        on: (event: string, callback: (file: string) => void) => void;
      };
      moduleGraph: {
        getModuleById: (id: string) => unknown;
        invalidateModule: (mod: any) => void;
      };
      ws: { send: (message: { type: string }) => void };
    }) {
      // Watch registry files and trigger HMR when they change
      const registryFilePaths = Object.values(registryFiles);

      server.watcher.add(registryFilePaths);

      server.watcher.on("change", (file: string) => {
        if (
          registryFilePaths.some((registryFile) =>
            file.endsWith(registryFile.split("/").pop()!),
          )
        ) {
          const mod = server.moduleGraph.getModuleById(
            RESOLVED_VIRTUAL_MODULE_ID,
          );
          if (mod) {
            server.moduleGraph.invalidateModule(mod);
            server.ws.send({ type: "full-reload" });
          }
        }
      });
    },
  };
}