@lukoweb/apitogo 0.2.60 → 0.2.61

package/src/vite/config.ts

@@ -1,273 +1,278 @@
-import path from "node:path";
-import dotenv from "dotenv";
-import colors from "picocolors";
-import {
-  type ConfigEnv,
-  type InlineConfig,
-  type LogLevel,
-  loadConfigFromFile,
-  mergeConfig,
-} from "vite";
-import packageJson from "../../package.json" with { type: "json" };
-import { ZuploEnv } from "../app/env.js";
-import { logger } from "../cli/common/logger.js";
-import { getZudokuRootDir } from "../cli/common/package-json.js";
-import { loadZudokuConfig } from "../config/loader.js";
-import { CdnUrlSchema } from "../config/validators/ZudokuConfig.js";
-import { joinUrl } from "../lib/util/joinUrl.js";
-import { loadDevPortalViteDefines } from "./dev-portal-env.js";
-import { findPackageRoot } from "./package-root.js";
-import { ensurePagefindDevStub } from "./pagefind-dev-stub.js";
-import vitePlugin from "./plugin.js";
-import { devServerAllow, stateIgnore } from "./watch-ignore.js";
-import { getZuploSystemConfigurations } from "./zuplo.js";
-
-/** Resolved absolute public directory (Vite default: `<root>/public`). */
-const resolveMergedPublicDir = (
-  rootDir: string,
-  merged: InlineConfig,
-): string | undefined => {
-  if (merged.publicDir === false) return undefined;
-  const rel =
-    typeof merged.publicDir === "string" ? merged.publicDir : "public";
-  return path.resolve(rootDir, rel);
-};
-
-export type ZudokuConfigEnv = ConfigEnv & {
-  mode: "development" | "production";
-};
-
-export const getAppClientEntryPath = () =>
-  path.posix.join(getZudokuRootDir(), "src/app/entry.client.tsx");
-
-export const getAppServerEntryPath = () =>
-  path.posix.join(getZudokuRootDir(), "src/app/entry.server.tsx");
-
-// the vite config gets loaded multiple times, so we only log the CDN info once
-let hasLoggedCdnInfo = false;
-const MEDIA_REGEX =
-  /\.(a?png|jpe?g|gif|bmp|svg|webp|tiff|ico|webm|ogg|mp3|wav|m4a|avif|mp4)/i;
-
-const defineEnvVars = (vars: string[]) =>
-  Object.fromEntries(
-    vars.flatMap((v) => [
-      [`process.env.${v}`, JSON.stringify(process.env[v])],
-      [`import.meta.env.${v}`, JSON.stringify(process.env[v])],
-    ]),
-  );
-
-export async function getViteConfig(
-  dir: string,
-  configEnv: ZudokuConfigEnv,
-): Promise<InlineConfig> {
-  const { config, publicEnv, envPrefix } = await loadZudokuConfig(
-    configEnv,
-    dir,
-  );
-
-  const cdnUrl = CdnUrlSchema.parse(config.cdnUrl);
-
-  const base = cdnUrl?.base
-    ? joinUrl(cdnUrl.base, config.basePath)
-    : config.basePath;
-
-  if (cdnUrl && !hasLoggedCdnInfo) {
-    logger.info(colors.blue(`Using CDN URL:`));
-    logger.info(colors.blue(`  base:  `) + colors.dim(cdnUrl.base));
-    logger.info(colors.blue(`  media: `) + colors.dim(cdnUrl.media));
-    hasLoggedCdnInfo = true;
-  }
-
-  // We define public env vars as `process.env` vars because Vite only exposes them as `import.meta.env` vars
-  const publicVarsProcessEnvDefine = Object.fromEntries(
-    Object.entries(publicEnv).map(([key, value]) => [
-      `process.env.${key}`,
-      value,
-    ]),
-  );
-
-  // The workspace of a config version 2 portal links back to its own project; the watcher must not follow that.
-  const ignoreState = stateIgnore(dir);
-
-  if (ZuploEnv.isZuplo) {
-    dotenv.config({
-      path: path.resolve(config.__meta.rootDir, "../.env.zuplo"),
-      quiet: true,
-    });
-  }
-
-  const deploymentName =
-    ZuploEnv.buildConfig?.deploymentName ||
-    getZuploSystemConfigurations(process.env.ZUPLO_SYSTEM_CONFIGURATIONS)
-      ?.__ZUPLO_DEPLOYMENT_NAME;
-
-  const devPortalDefines = await loadDevPortalViteDefines(dir, configEnv.mode);
-
-  const viteConfig: InlineConfig = {
-    root: dir,
-    base,
-    appType: "custom",
-    configFile: false,
-    clearScreen: false,
-    logLevel: (process.env.LOG_LEVEL ?? "info") as LogLevel,
-    customLogger: logger,
-    envPrefix,
-    resolve: {
-      dedupe: ["react", "react-dom"],
-      alias: {
-        "@mdx-js/react": import.meta.resolve("@mdx-js/react"),
-      },
-    },
-    define: {
-      "process.env.ZUDOKU_VERSION": JSON.stringify(packageJson.version),
-      "process.env.IS_ZUPLO": ZuploEnv.isZuplo,
-      "import.meta.env.IS_ZUPLO": ZuploEnv.isZuplo,
-      "import.meta.env.ZUPLO_PUBLIC_DEPLOYMENT_NAME":
-        JSON.stringify(deploymentName),
-      ...defineEnvVars([
-        "SENTRY_DSN",
-        "ZUPLO_BUILD_ID",
-        "ZUPLO_BUILD_CONFIG",
-        "ZUPLO_ENVIRONMENT_TYPE",
-        "ZUPLO_SERVER_URL",
-        "ZUPLO_GATEWAY_SERVICE_URL",
-      ]),
-      ...publicVarsProcessEnvDefine,
-      ...devPortalDefines,
-    },
-    ssr: {
-      target: "node",
-      noExternal: [/apitogo/, "@mdx-js/react"],
-      external: ["@shikijs/themes", "@shikijs/langs"],
-    },
-    server: {
-      middlewareMode: true,
-      open: true,
-      fs: {
-        allow: devServerAllow(dir, config.__meta.moduleDir),
-      },
-      watch: {
-        ignored: [
-          `${dir}/dist`,
-          `${dir}/lib`,
-          `${dir}/.git`,
-          `${config.__meta.moduleDir}/src/vite`,
-          `${config.__meta.moduleDir}/src/cli`,
-          ...(ignoreState ? [ignoreState] : []),
-        ],
-      },
-    },
-    build: {
-      ssr: configEnv.isSsrBuild,
-      sourcemap: true,
-      target: "es2022",
-      outDir: path.resolve(
-        path.join(
-          dir,
-          "dist",
-          config.basePath ?? "",
-          configEnv.isSsrBuild ? "server" : "",
-        ),
-      ),
-      emptyOutDir: true,
-      rollupOptions: {
-        input:
-          configEnv.command === "build"
-            ? configEnv.isSsrBuild
-              ? [
-                  "@lukoweb/apitogo/app/entry.server.tsx",
-                  config.__meta.configPath,
-                ]
-              : "@lukoweb/apitogo/app/entry.client.tsx"
-            : undefined,
-        external: [joinUrl(config.basePath, "/pagefind/pagefind.js")],
-      },
-      chunkSizeWarningLimit: 1500,
-    },
-    experimental: {
-      renderBuiltUrl(filename) {
-        if (cdnUrl?.base && [".js", ".css"].includes(path.extname(filename))) {
-          return joinUrl(cdnUrl.base, filename);
-        }
-
-        if (cdnUrl?.media && MEDIA_REGEX.test(filename)) {
-          return joinUrl(cdnUrl.media, filename);
-        }
-
-        return { relative: true };
-      },
-    },
-    optimizeDeps: {
-      esbuildOptions: {
-        target: "es2022",
-      },
-      entries: [path.posix.join(getZudokuRootDir(), "src/{app,lib}/**")],
-      exclude: [
-        "@lukoweb/apitogo",
-        "@lukoweb/apitogo-plugin-dev-portal-billing",
-      ],
-      include: [
-        "react-dom/client",
-        "@lukoweb/apitogo/icons",
-        ...(process.env.SENTRY_DSN ? ["@sentry/react"] : []),
-      ],
-    },
-    assetsInclude: [
-      // Workaround for Pre-transform error for "virtual" file: https://github.com/vitejs/vite/issues/15374
-      "/__z/entry.client.tsx",
-      "**/pagefind.js",
-    ],
-    plugins: [vitePlugin()],
-    future: {
-      removeServerModuleGraph: "warn",
-      removeSsrLoadModule: "warn",
-      removeServerTransformRequest: "warn",
-      removePluginHookHandleHotUpdate: "warn",
-      removePluginHookSsrArgument: "warn",
-      removeServerHot: "warn",
-    },
-  };
-
-  // Merge vite configs from plugin directories and user's project
-  const configRoots = await Promise.all(
-    (config.__pluginDirs ?? []).map(findPackageRoot),
-  );
-  configRoots.push(dir);
-
-  let mergedViteConfig = viteConfig;
-
-  for (const root of configRoots) {
-    if (!root) continue;
-    const loaded = await loadConfigFromFile(
-      configEnv,
-      undefined,
-      root,
-      undefined,
-      undefined,
-      "runner",
-    );
-    if (!loaded) continue;
-
-    mergedViteConfig = mergeConfig(mergedViteConfig, loaded.config, true);
-
-    if (root === dir) {
-      logger.info(colors.blue(`merged with custom user Vite config`), {
-        timestamp: true,
-      });
-    }
-  }
-
-  // Create pagefind stub before Vite starts. In development, `optimizeDeps.entries` crawls all of
-  // `src/lib/**`, which includes PagefindSearch's dev import of `/pagefind/pagefind.js`; esbuild
-  // must be able to open that path even when search is not configured. Pagefind users still get
-  // the stub until a real index is written (dev index or production prerender).
-  const publicDir = resolveMergedPublicDir(dir, mergedViteConfig);
-  if (
-    publicDir &&
-    (configEnv.mode === "development" || config.search?.type === "pagefind")
-  ) {
-    await ensurePagefindDevStub(publicDir);
-  }
-
-  return mergedViteConfig;
-}
+import path from "node:path";
+import dotenv from "dotenv";
+import colors from "picocolors";
+import {
+  type ConfigEnv,
+  type InlineConfig,
+  type LogLevel,
+  loadConfigFromFile,
+  mergeConfig,
+} from "vite";
+import packageJson from "../../package.json" with { type: "json" };
+import { ZuploEnv } from "../app/env.js";
+import { logger } from "../cli/common/logger.js";
+import { getZudokuRootDir } from "../cli/common/package-json.js";
+import { loadZudokuConfig } from "../config/loader.js";
+import { CdnUrlSchema } from "../config/validators/ZudokuConfig.js";
+import { joinUrl } from "../lib/util/joinUrl.js";
+import { loadDevPortalViteDefines } from "./dev-portal-env.js";
+import { findPackageRoot } from "./package-root.js";
+import { ensurePagefindDevStub } from "./pagefind-dev-stub.js";
+import vitePlugin from "./plugin.js";
+import {
+  devServerAllow,
+  nestedStateIgnore,
+  stateIgnore,
+} from "./watch-ignore.js";
+import { getZuploSystemConfigurations } from "./zuplo.js";
+
+/** Resolved absolute public directory (Vite default: `<root>/public`). */
+const resolveMergedPublicDir = (
+  rootDir: string,
+  merged: InlineConfig,
+): string | undefined => {
+  if (merged.publicDir === false) return undefined;
+  const rel =
+    typeof merged.publicDir === "string" ? merged.publicDir : "public";
+  return path.resolve(rootDir, rel);
+};
+
+export type ZudokuConfigEnv = ConfigEnv & {
+  mode: "development" | "production";
+};
+
+export const getAppClientEntryPath = () =>
+  path.posix.join(getZudokuRootDir(), "src/app/entry.client.tsx");
+
+export const getAppServerEntryPath = () =>
+  path.posix.join(getZudokuRootDir(), "src/app/entry.server.tsx");
+
+// the vite config gets loaded multiple times, so we only log the CDN info once
+let hasLoggedCdnInfo = false;
+const MEDIA_REGEX =
+  /\.(a?png|jpe?g|gif|bmp|svg|webp|tiff|ico|webm|ogg|mp3|wav|m4a|avif|mp4)/i;
+
+const defineEnvVars = (vars: string[]) =>
+  Object.fromEntries(
+    vars.flatMap((v) => [
+      [`process.env.${v}`, JSON.stringify(process.env[v])],
+      [`import.meta.env.${v}`, JSON.stringify(process.env[v])],
+    ]),
+  );
+
+export async function getViteConfig(
+  dir: string,
+  configEnv: ZudokuConfigEnv,
+): Promise<InlineConfig> {
+  const { config, publicEnv, envPrefix } = await loadZudokuConfig(
+    configEnv,
+    dir,
+  );
+
+  const cdnUrl = CdnUrlSchema.parse(config.cdnUrl);
+
+  const base = cdnUrl?.base
+    ? joinUrl(cdnUrl.base, config.basePath)
+    : config.basePath;
+
+  if (cdnUrl && !hasLoggedCdnInfo) {
+    logger.info(colors.blue(`Using CDN URL:`));
+    logger.info(colors.blue(`  base:  `) + colors.dim(cdnUrl.base));
+    logger.info(colors.blue(`  media: `) + colors.dim(cdnUrl.media));
+    hasLoggedCdnInfo = true;
+  }
+
+  // We define public env vars as `process.env` vars because Vite only exposes them as `import.meta.env` vars
+  const publicVarsProcessEnvDefine = Object.fromEntries(
+    Object.entries(publicEnv).map(([key, value]) => [
+      `process.env.${key}`,
+      value,
+    ]),
+  );
+
+  // The workspace of a config version 2 portal links back to its own project; the watcher must not follow that.
+  const ignoreState = stateIgnore(dir);
+
+  if (ZuploEnv.isZuplo) {
+    dotenv.config({
+      path: path.resolve(config.__meta.rootDir, "../.env.zuplo"),
+      quiet: true,
+    });
+  }
+
+  const deploymentName =
+    ZuploEnv.buildConfig?.deploymentName ||
+    getZuploSystemConfigurations(process.env.ZUPLO_SYSTEM_CONFIGURATIONS)
+      ?.__ZUPLO_DEPLOYMENT_NAME;
+
+  const devPortalDefines = await loadDevPortalViteDefines(dir, configEnv.mode);
+
+  const viteConfig: InlineConfig = {
+    root: dir,
+    base,
+    appType: "custom",
+    configFile: false,
+    clearScreen: false,
+    logLevel: (process.env.LOG_LEVEL ?? "info") as LogLevel,
+    customLogger: logger,
+    envPrefix,
+    resolve: {
+      dedupe: ["react", "react-dom"],
+      alias: {
+        "@mdx-js/react": import.meta.resolve("@mdx-js/react"),
+      },
+    },
+    define: {
+      "process.env.ZUDOKU_VERSION": JSON.stringify(packageJson.version),
+      "process.env.IS_ZUPLO": ZuploEnv.isZuplo,
+      "import.meta.env.IS_ZUPLO": ZuploEnv.isZuplo,
+      "import.meta.env.ZUPLO_PUBLIC_DEPLOYMENT_NAME":
+        JSON.stringify(deploymentName),
+      ...defineEnvVars([
+        "SENTRY_DSN",
+        "ZUPLO_BUILD_ID",
+        "ZUPLO_BUILD_CONFIG",
+        "ZUPLO_ENVIRONMENT_TYPE",
+        "ZUPLO_SERVER_URL",
+        "ZUPLO_GATEWAY_SERVICE_URL",
+      ]),
+      ...publicVarsProcessEnvDefine,
+      ...devPortalDefines,
+    },
+    ssr: {
+      target: "node",
+      noExternal: [/apitogo/, "@mdx-js/react"],
+      external: ["@shikijs/themes", "@shikijs/langs"],
+    },
+    server: {
+      middlewareMode: true,
+      open: true,
+      fs: {
+        allow: devServerAllow(dir, config.__meta.moduleDir),
+      },
+      watch: {
+        ignored: [
+          `${dir}/dist`,
+          `${dir}/lib`,
+          `${dir}/.git`,
+          `${config.__meta.moduleDir}/src/vite`,
+          `${config.__meta.moduleDir}/src/cli`,
+          nestedStateIgnore(dir),
+          ...(ignoreState ? [ignoreState] : []),
+        ],
+      },
+    },
+    build: {
+      ssr: configEnv.isSsrBuild,
+      sourcemap: true,
+      target: "es2022",
+      outDir: path.resolve(
+        path.join(
+          dir,
+          "dist",
+          config.basePath ?? "",
+          configEnv.isSsrBuild ? "server" : "",
+        ),
+      ),
+      emptyOutDir: true,
+      rollupOptions: {
+        input:
+          configEnv.command === "build"
+            ? configEnv.isSsrBuild
+              ? [
+                  "@lukoweb/apitogo/app/entry.server.tsx",
+                  config.__meta.configPath,
+                ]
+              : "@lukoweb/apitogo/app/entry.client.tsx"
+            : undefined,
+        external: [joinUrl(config.basePath, "/pagefind/pagefind.js")],
+      },
+      chunkSizeWarningLimit: 1500,
+    },
+    experimental: {
+      renderBuiltUrl(filename) {
+        if (cdnUrl?.base && [".js", ".css"].includes(path.extname(filename))) {
+          return joinUrl(cdnUrl.base, filename);
+        }
+
+        if (cdnUrl?.media && MEDIA_REGEX.test(filename)) {
+          return joinUrl(cdnUrl.media, filename);
+        }
+
+        return { relative: true };
+      },
+    },
+    optimizeDeps: {
+      esbuildOptions: {
+        target: "es2022",
+      },
+      entries: [path.posix.join(getZudokuRootDir(), "src/{app,lib}/**")],
+      exclude: [
+        "@lukoweb/apitogo",
+        "@lukoweb/apitogo-plugin-dev-portal-billing",
+      ],
+      include: [
+        "react-dom/client",
+        "@lukoweb/apitogo/icons",
+        ...(process.env.SENTRY_DSN ? ["@sentry/react"] : []),
+      ],
+    },
+    assetsInclude: [
+      // Workaround for Pre-transform error for "virtual" file: https://github.com/vitejs/vite/issues/15374
+      "/__z/entry.client.tsx",
+      "**/pagefind.js",
+    ],
+    plugins: [vitePlugin()],
+    future: {
+      removeServerModuleGraph: "warn",
+      removeSsrLoadModule: "warn",
+      removeServerTransformRequest: "warn",
+      removePluginHookHandleHotUpdate: "warn",
+      removePluginHookSsrArgument: "warn",
+      removeServerHot: "warn",
+    },
+  };
+
+  // Merge vite configs from plugin directories and user's project
+  const configRoots = await Promise.all(
+    (config.__pluginDirs ?? []).map(findPackageRoot),
+  );
+  configRoots.push(dir);
+
+  let mergedViteConfig = viteConfig;
+
+  for (const root of configRoots) {
+    if (!root) continue;
+    const loaded = await loadConfigFromFile(
+      configEnv,
+      undefined,
+      root,
+      undefined,
+      undefined,
+      "runner",
+    );
+    if (!loaded) continue;
+
+    mergedViteConfig = mergeConfig(mergedViteConfig, loaded.config, true);
+
+    if (root === dir) {
+      logger.info(colors.blue(`merged with custom user Vite config`), {
+        timestamp: true,
+      });
+    }
+  }
+
+  // Create pagefind stub before Vite starts. In development, `optimizeDeps.entries` crawls all of
+  // `src/lib/**`, which includes PagefindSearch's dev import of `/pagefind/pagefind.js`; esbuild
+  // must be able to open that path even when search is not configured. Pagefind users still get
+  // the stub until a real index is written (dev index or production prerender).
+  const publicDir = resolveMergedPublicDir(dir, mergedViteConfig);
+  if (
+    publicDir &&
+    (configEnv.mode === "development" || config.search?.type === "pagefind")
+  ) {
+    await ensurePagefindDevStub(publicDir);
+  }
+
+  return mergedViteConfig;
+}

package/src/vite/markdown-output-path.ts

@@ -0,0 +1,48 @@
+import { rm } from "node:fs/promises";
+import path from "node:path";
+
+/**
+ * Where the build writes the exported Markdown copy of the page at `routePath`: `<distDir>/<route>.md`, or
+ * `<distDir>/index.md` for `/`. The markdown export plugin writes it and prerender removes it again when the copies
+ * were only made for llms.txt, so both must use this one function.
+ */
+export const markdownOutputPath = (
+  distDir: string,
+  routePath: string,
+): string => {
+  const segments =
+    routePath === "/" ? ["index"] : routePath.split("/").filter(Boolean);
+  return `${path.join(distDir, ...segments)}.md`;
+};
+
+/**
+ * The exported copy to remove after the build, or `undefined` when the path would leave `distDir` (a route with
+ * `..` in it, say). Prerender must only ever delete what the build wrote, never a source page.
+ */
+export const removableMarkdownOutput = (
+  distDir: string,
+  routePath: string,
+): string | undefined => {
+  const output = path.resolve(markdownOutputPath(distDir, routePath));
+  const relative = path.relative(path.resolve(distDir), output);
+  if (!relative || relative.startsWith("..") || path.isAbsolute(relative)) {
+    return undefined;
+  }
+  return output;
+};
+
+/**
+ * Remove the exported `.md` copies of these pages from `distDir`. Only the route decides what is removed; the source
+ * file (`filePath` in markdown-info.json) is never touched.
+ */
+export const removeExportedMarkdown = async (
+  distDir: string,
+  pages: ReadonlyArray<{ routePath: string }>,
+): Promise<void> => {
+  await Promise.all(
+    pages
+      .map((page) => removableMarkdownOutput(distDir, page.routePath))
+      .filter((output) => output !== undefined)
+      .map((output) => rm(output, { force: true }).catch(() => {})),
+  );
+};