@lukoweb/apitogo 0.1.1 → 0.1.3

package/src/vite/plugin-mdx.ts

@@ -1,149 +1,149 @@
-import rehypeMetaAsAttributes from "@lekoarts/rehype-meta-as-attributes";
-import mdx from "@mdx-js/rollup";
-import type { Root as HastRoot } from "hast";
-import { toString as hastToString } from "hast-util-to-string";
-import rehypeMdxImportMedia from "rehype-mdx-import-media";
-import rehypeSlug from "rehype-slug";
-import remarkComment from "remark-comment";
-import remarkDirective from "remark-directive";
-import remarkDirectiveRehype from "remark-directive-rehype";
-import remarkFrontmatter from "remark-frontmatter";
-import remarkGfm from "remark-gfm";
-import remarkMdxFrontmatter from "remark-mdx-frontmatter";
-import type { PluggableList } from "unified";
-import { EXIT, visit } from "unist-util-visit";
-import type { Plugin } from "vite";
-import { getCurrentConfig } from "../config/loader.js";
-import { getBuildConfig } from "../config/validators/BuildSchema.js";
-import {
-  createConfiguredShikiRehypePlugins,
-  highlighterPromise,
-} from "../lib/shiki.js";
-import rehypeExtractTocWithJsxExport from "./mdx/rehype-extract-toc-with-jsx-export.js";
-import rehypeExtractTocWithJsx from "./mdx/rehype-extract-toc-with-jsx.js";
-import { remarkCodeTabs } from "./mdx/remark-code-tabs.js";
-import { remarkInjectFilepath } from "./mdx/remark-inject-filepath.js";
-import { remarkLastModified } from "./mdx/remark-last-modified.js";
-import { remarkLinkRewrite } from "./mdx/remark-link-rewrite.js";
-import { remarkNormalizeImageUrl } from "./mdx/remark-normalize-image-url.js";
-import { remarkStaticGeneration } from "./mdx/remark-static-generation.js";
-import { exportMdxjsConst } from "./mdx/utils.js";
-
-// Convert mdxJsxFlowElement img elements to regular element nodes
-// so rehype-mdx-import-media can pick them up
-// biome-ignore lint/suspicious/noExplicitAny: Allow any type
-const rehypeNormalizeMdxImages = () => (tree: any) => {
-  visit(tree, ["mdxJsxFlowElement", "mdxJsxElement"], (node) => {
-    if (node.type !== "mdxJsxFlowElement") return;
-    if (!["img", "video"].includes(node.name)) return;
-
-    const hasStringSrc = node.attributes.some(
-      // biome-ignore lint/suspicious/noExplicitAny: Allow any type
-      (attr: any) =>
-        attr.type === "mdxJsxAttribute" &&
-        attr.name === "src" &&
-        typeof attr.value === "string",
-    );
-
-    if (!hasStringSrc) return;
-
-    node.type = "element";
-    node.tagName = node.name;
-    // biome-ignore lint/suspicious/noExplicitAny: Allow any type
-    node.properties = {} as Record<string, any>;
-
-    for (const attr of node.attributes) {
-      if (attr.type === "mdxJsxAttribute" && typeof attr.value === "string") {
-        node.properties[attr.name] = attr.value;
-      }
-    }
-
-    delete node.name;
-    delete node.attributes;
-    delete node.children;
-    delete node.data;
-    delete node.position;
-  });
-};
-
-const rehypeExcerptWithMdxExport = () => (tree: HastRoot) => {
-  let excerpt: string | undefined;
-
-  visit(tree, "element", (node, _index, parent) => {
-    if (node.tagName !== "p" || parent?.type !== "root") return;
-
-    excerpt = hastToString(node);
-    return EXIT;
-  });
-
-  if (!excerpt) return;
-
-  tree.children.unshift(exportMdxjsConst("excerpt", excerpt));
-};
-
-const viteMdxPlugin = async (): Promise<Plugin> => {
-  const config = getCurrentConfig();
-  const buildConfig = await getBuildConfig();
-  const highlighter = await highlighterPromise;
-
-  const defaultRemarkPlugins = [
-    remarkStaticGeneration,
-    [remarkInjectFilepath, config.__meta.rootDir],
-    remarkComment,
-    remarkGfm,
-    remarkFrontmatter,
-    // ---  important:
-    // this must be sandwiched between remarkFrontmatter and remarkMdxFrontmatter
-    remarkLastModified,
-    // ---
-    remarkMdxFrontmatter,
-    remarkDirective,
-    remarkDirectiveRehype,
-    remarkCodeTabs,
-    [remarkLinkRewrite, config.basePath],
-    [remarkNormalizeImageUrl, config.basePath],
-    ...(config.build?.remarkPlugins ?? []),
-  ] satisfies PluggableList;
-
-  const remarkPlugins =
-    typeof buildConfig?.remarkPlugins === "function"
-      ? buildConfig.remarkPlugins(defaultRemarkPlugins)
-      : [...defaultRemarkPlugins, ...(buildConfig?.remarkPlugins ?? [])];
-
-  const defaultRehypePlugins = [
-    rehypeSlug,
-    rehypeExtractTocWithJsx,
-    rehypeExtractTocWithJsxExport,
-    rehypeExcerptWithMdxExport,
-    rehypeNormalizeMdxImages,
-    rehypeMdxImportMedia,
-    rehypeMetaAsAttributes,
-    ...createConfiguredShikiRehypePlugins(
-      highlighter,
-      config.syntaxHighlighting?.themes,
-    ),
-    ...(config.build?.rehypePlugins ?? []),
-  ] satisfies PluggableList;
-
-  const rehypePlugins =
-    typeof buildConfig?.rehypePlugins === "function"
-      ? buildConfig.rehypePlugins(defaultRehypePlugins)
-      : [...defaultRehypePlugins, ...(buildConfig?.rehypePlugins ?? [])];
-
-  return {
-    enforce: "pre",
-    ...mdx({
-      providerImportSource:
-        config.__meta.mode === "internal" || config.__meta.mode === "standalone"
-          ? "@mdx-js/react"
-          : "@lukoweb/apitogo/components",
-      mdxExtensions: [".mdx"],
-      format: "detect",
-      remarkPlugins,
-      rehypePlugins,
-    }),
-    name: "zudoku-mdx-plugin",
-  } as const;
-};
-
-export default viteMdxPlugin;
+import rehypeMetaAsAttributes from "@lekoarts/rehype-meta-as-attributes";
+import mdx from "@mdx-js/rollup";
+import type { Root as HastRoot } from "hast";
+import { toString as hastToString } from "hast-util-to-string";
+import rehypeMdxImportMedia from "rehype-mdx-import-media";
+import rehypeSlug from "rehype-slug";
+import remarkComment from "remark-comment";
+import remarkDirective from "remark-directive";
+import remarkDirectiveRehype from "remark-directive-rehype";
+import remarkFrontmatter from "remark-frontmatter";
+import remarkGfm from "remark-gfm";
+import remarkMdxFrontmatter from "remark-mdx-frontmatter";
+import type { PluggableList } from "unified";
+import { EXIT, visit } from "unist-util-visit";
+import type { Plugin } from "vite";
+import { getCurrentConfig } from "../config/loader.js";
+import { getBuildConfig } from "../config/validators/BuildSchema.js";
+import {
+  createConfiguredShikiRehypePlugins,
+  highlighterPromise,
+} from "../lib/shiki.js";
+import rehypeExtractTocWithJsxExport from "./mdx/rehype-extract-toc-with-jsx-export.js";
+import rehypeExtractTocWithJsx from "./mdx/rehype-extract-toc-with-jsx.js";
+import { remarkCodeTabs } from "./mdx/remark-code-tabs.js";
+import { remarkInjectFilepath } from "./mdx/remark-inject-filepath.js";
+import { remarkLastModified } from "./mdx/remark-last-modified.js";
+import { remarkLinkRewrite } from "./mdx/remark-link-rewrite.js";
+import { remarkNormalizeImageUrl } from "./mdx/remark-normalize-image-url.js";
+import { remarkStaticGeneration } from "./mdx/remark-static-generation.js";
+import { exportMdxjsConst } from "./mdx/utils.js";
+
+// Convert mdxJsxFlowElement img elements to regular element nodes
+// so rehype-mdx-import-media can pick them up
+// biome-ignore lint/suspicious/noExplicitAny: Allow any type
+const rehypeNormalizeMdxImages = () => (tree: any) => {
+  visit(tree, ["mdxJsxFlowElement", "mdxJsxElement"], (node) => {
+    if (node.type !== "mdxJsxFlowElement") return;
+    if (!["img", "video"].includes(node.name)) return;
+
+    const hasStringSrc = node.attributes.some(
+      // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+      (attr: any) =>
+        attr.type === "mdxJsxAttribute" &&
+        attr.name === "src" &&
+        typeof attr.value === "string",
+    );
+
+    if (!hasStringSrc) return;
+
+    node.type = "element";
+    node.tagName = node.name;
+    // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+    node.properties = {} as Record<string, any>;
+
+    for (const attr of node.attributes) {
+      if (attr.type === "mdxJsxAttribute" && typeof attr.value === "string") {
+        node.properties[attr.name] = attr.value;
+      }
+    }
+
+    delete node.name;
+    delete node.attributes;
+    delete node.children;
+    delete node.data;
+    delete node.position;
+  });
+};
+
+const rehypeExcerptWithMdxExport = () => (tree: HastRoot) => {
+  let excerpt: string | undefined;
+
+  visit(tree, "element", (node, _index, parent) => {
+    if (node.tagName !== "p" || parent?.type !== "root") return;
+
+    excerpt = hastToString(node);
+    return EXIT;
+  });
+
+  if (!excerpt) return;
+
+  tree.children.unshift(exportMdxjsConst("excerpt", excerpt));
+};
+
+const viteMdxPlugin = async (): Promise<Plugin> => {
+  const config = getCurrentConfig();
+  const buildConfig = await getBuildConfig();
+  const highlighter = await highlighterPromise;
+
+  const defaultRemarkPlugins = [
+    remarkStaticGeneration,
+    [remarkInjectFilepath, config.__meta.rootDir],
+    remarkComment,
+    remarkGfm,
+    remarkFrontmatter,
+    // ---  important:
+    // this must be sandwiched between remarkFrontmatter and remarkMdxFrontmatter
+    remarkLastModified,
+    // ---
+    remarkMdxFrontmatter,
+    remarkDirective,
+    remarkDirectiveRehype,
+    remarkCodeTabs,
+    [remarkLinkRewrite, config.basePath],
+    [remarkNormalizeImageUrl, config.basePath],
+    ...(config.build?.remarkPlugins ?? []),
+  ] satisfies PluggableList;
+
+  const remarkPlugins =
+    typeof buildConfig?.remarkPlugins === "function"
+      ? buildConfig.remarkPlugins(defaultRemarkPlugins)
+      : [...defaultRemarkPlugins, ...(buildConfig?.remarkPlugins ?? [])];
+
+  const defaultRehypePlugins = [
+    rehypeSlug,
+    rehypeExtractTocWithJsx,
+    rehypeExtractTocWithJsxExport,
+    rehypeExcerptWithMdxExport,
+    rehypeNormalizeMdxImages,
+    rehypeMdxImportMedia,
+    rehypeMetaAsAttributes,
+    ...createConfiguredShikiRehypePlugins(
+      highlighter,
+      config.syntaxHighlighting?.themes,
+    ),
+    ...(config.build?.rehypePlugins ?? []),
+  ] satisfies PluggableList;
+
+  const rehypePlugins =
+    typeof buildConfig?.rehypePlugins === "function"
+      ? buildConfig.rehypePlugins(defaultRehypePlugins)
+      : [...defaultRehypePlugins, ...(buildConfig?.rehypePlugins ?? [])];
+
+  return {
+    enforce: "pre",
+    ...mdx({
+      providerImportSource:
+        config.__meta.mode === "internal" || config.__meta.mode === "standalone"
+          ? "@mdx-js/react"
+          : "@lukoweb/apitogo/components",
+      mdxExtensions: [".mdx"],
+      format: "detect",
+      remarkPlugins,
+      rehypePlugins,
+    }),
+    name: "zudoku-mdx-plugin",
+  } as const;
+};
+
+export default viteMdxPlugin;

package/src/vite/plugin-navigation.ts

@@ -1,106 +1,106 @@
-import { stringify } from "javascript-stringify";
-import { isElement } from "react-is";
-import type { Plugin, ViteDevServer } from "vite";
-import { getCurrentConfig } from "../config/loader.js";
-import { IconNames } from "../config/validators/icon-types.js";
-import { NavigationResolver } from "../config/validators/NavigationSchema.js";
-import invariant from "../lib/util/invariant.js";
-import { writePluginDebugCode } from "./debug.js";
-
-const toPascalCase = (str: string) =>
-  str.replace(/(^\w|-\w)/g, (match) => match.replace("-", "").toUpperCase());
-
-const virtualModuleId = "virtual:zudoku-navigation";
-export const resolvedVirtualModuleId = `\0${virtualModuleId}`;
-
-export const invalidate = (server: ViteDevServer) => {
-  const navigationModule =
-    server.environments.ssr.moduleGraph.getModuleById(virtualModuleId);
-  if (!navigationModule) return;
-
-  server.environments.ssr.moduleGraph.invalidateModule(navigationModule);
-};
-
-export const viteNavigationPlugin = (): Plugin => {
-  return {
-    name: "zudoku-navigation-plugin",
-    resolveId(id) {
-      if (id === virtualModuleId) {
-        return resolvedVirtualModuleId;
-      }
-    },
-    async load(id) {
-      if (id !== resolvedVirtualModuleId) return;
-      const config = getCurrentConfig();
-
-      const resolver = new NavigationResolver(config);
-      const resolvedNavigation = await resolver.resolve();
-      const resolvedRules = await resolver.resolveRules(
-        config.navigationRules ?? [],
-      );
-
-      const collectedIcons = new Set<string>();
-      let hasMissingIcon = false;
-
-      const stringifyWithIcons = (value: unknown) =>
-        stringify(
-          value,
-          (value, _indent, next, key) => {
-            // Skip non-serializable React elements
-            if (isElement(value)) return undefined;
-
-            if (key === "icon" && typeof value === "string") {
-              const iconName = toPascalCase(value);
-
-              if (!IconNames.includes(value as IconNames)) {
-                // biome-ignore lint/suspicious/noConsole: Logging allowed here
-                console.warn(
-                  `Icon "${value}" not found, see: https://lucide.dev/icons/`,
-                );
-                hasMissingIcon = true;
-                return "MissingIcon";
-              } else {
-                collectedIcons.add(iconName);
-                return iconName;
-              }
-            }
-            return next(value);
-          },
-          2,
-        );
-
-      const headerNavigationCode = stringifyWithIcons(
-        config.header?.navigation ?? [],
-      );
-      const navigationCode = stringifyWithIcons(resolvedNavigation);
-      const rulesCode = stringifyWithIcons(resolvedRules);
-
-      invariant(headerNavigationCode, "Failed to stringify header navigation");
-      invariant(navigationCode, "Failed to stringify navigation");
-      invariant(rulesCode, "Failed to stringify navigation rules");
-
-      await writePluginDebugCode(
-        config.__meta.rootDir,
-        "navigation-plugin",
-        `export const headerNavigation = ${headerNavigationCode};\nexport const navigation = ${navigationCode};\nexport const rules = ${rulesCode};`,
-        "js",
-      );
-
-      if (hasMissingIcon) {
-        collectedIcons.add("MissingIcon");
-      }
-
-      const importStatement =
-        collectedIcons.size > 0
-          ? `import { ${[...collectedIcons].join(", ")} } from "@lukoweb/apitogo/icons";\n`
-          : "";
-
-      return [
-        importStatement,
-        `export const configuredHeaderNavigation = ${headerNavigationCode};`,
-        `export const configuredNavigation = ${navigationCode};`,
-        `export const configuredNavigationRules = ${rulesCode};`,
-      ].join("\n");
-    },
-  };
-};
+import { stringify } from "javascript-stringify";
+import { isElement } from "react-is";
+import type { Plugin, ViteDevServer } from "vite";
+import { getCurrentConfig } from "../config/loader.js";
+import { IconNames } from "../config/validators/icon-types.js";
+import { NavigationResolver } from "../config/validators/NavigationSchema.js";
+import invariant from "../lib/util/invariant.js";
+import { writePluginDebugCode } from "./debug.js";
+
+const toPascalCase = (str: string) =>
+  str.replace(/(^\w|-\w)/g, (match) => match.replace("-", "").toUpperCase());
+
+const virtualModuleId = "virtual:zudoku-navigation";
+export const resolvedVirtualModuleId = `\0${virtualModuleId}`;
+
+export const invalidate = (server: ViteDevServer) => {
+  const navigationModule =
+    server.environments.ssr.moduleGraph.getModuleById(virtualModuleId);
+  if (!navigationModule) return;
+
+  server.environments.ssr.moduleGraph.invalidateModule(navigationModule);
+};
+
+export const viteNavigationPlugin = (): Plugin => {
+  return {
+    name: "zudoku-navigation-plugin",
+    resolveId(id) {
+      if (id === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+    },
+    async load(id) {
+      if (id !== resolvedVirtualModuleId) return;
+      const config = getCurrentConfig();
+
+      const resolver = new NavigationResolver(config);
+      const resolvedNavigation = await resolver.resolve();
+      const resolvedRules = await resolver.resolveRules(
+        config.navigationRules ?? [],
+      );
+
+      const collectedIcons = new Set<string>();
+      let hasMissingIcon = false;
+
+      const stringifyWithIcons = (value: unknown) =>
+        stringify(
+          value,
+          (value, _indent, next, key) => {
+            // Skip non-serializable React elements
+            if (isElement(value)) return undefined;
+
+            if (key === "icon" && typeof value === "string") {
+              const iconName = toPascalCase(value);
+
+              if (!IconNames.includes(value as IconNames)) {
+                // biome-ignore lint/suspicious/noConsole: Logging allowed here
+                console.warn(
+                  `Icon "${value}" not found, see: https://lucide.dev/icons/`,
+                );
+                hasMissingIcon = true;
+                return "MissingIcon";
+              } else {
+                collectedIcons.add(iconName);
+                return iconName;
+              }
+            }
+            return next(value);
+          },
+          2,
+        );
+
+      const headerNavigationCode = stringifyWithIcons(
+        config.header?.navigation ?? [],
+      );
+      const navigationCode = stringifyWithIcons(resolvedNavigation);
+      const rulesCode = stringifyWithIcons(resolvedRules);
+
+      invariant(headerNavigationCode, "Failed to stringify header navigation");
+      invariant(navigationCode, "Failed to stringify navigation");
+      invariant(rulesCode, "Failed to stringify navigation rules");
+
+      await writePluginDebugCode(
+        config.__meta.rootDir,
+        "navigation-plugin",
+        `export const headerNavigation = ${headerNavigationCode};\nexport const navigation = ${navigationCode};\nexport const rules = ${rulesCode};`,
+        "js",
+      );
+
+      if (hasMissingIcon) {
+        collectedIcons.add("MissingIcon");
+      }
+
+      const importStatement =
+        collectedIcons.size > 0
+          ? `import { ${[...collectedIcons].join(", ")} } from "@lukoweb/apitogo/icons";\n`
+          : "";
+
+      return [
+        importStatement,
+        `export const configuredHeaderNavigation = ${headerNavigationCode};`,
+        `export const configuredNavigation = ${navigationCode};`,
+        `export const configuredNavigationRules = ${rulesCode};`,
+      ].join("\n");
+    },
+  };
+};

package/src/vite/plugin-search.ts

@@ -1,47 +1,47 @@
-import type { Plugin } from "vite";
-import { getCurrentConfig } from "../config/loader.js";
-
-export const viteSearchPlugin = (): Plugin => {
-  const virtualModuleId = "virtual:zudoku-search-plugin";
-  const resolvedVirtualModuleId = `\0${virtualModuleId}`;
-
-  return {
-    name: "zudoku-search-plugin",
-    resolveId(id) {
-      if (id === virtualModuleId) {
-        return resolvedVirtualModuleId;
-      }
-    },
-    async load(id) {
-      if (id !== resolvedVirtualModuleId) return;
-
-      const config = getCurrentConfig();
-
-      if (!config.search || config.__meta.mode === "standalone") {
-        return `export const configuredSearchPlugin = undefined;`;
-      }
-
-      const code = [];
-
-      if (config.search.type === "inkeep") {
-        code.push(
-          `import config from 'virtual:zudoku-config';`,
-          `import { inkeepSearchPlugin } from "@lukoweb/apitogo/plugins/search-inkeep";`,
-          `export const configuredSearchPlugin = inkeepSearchPlugin(config.search);`,
-        );
-
-        return code.join("\n");
-      }
-
-      if (config.search.type === "pagefind") {
-        code.push(
-          `import config from 'virtual:zudoku-config';`,
-          `import { pagefindSearchPlugin } from "@lukoweb/apitogo/plugins/search-pagefind";`,
-          `export const configuredSearchPlugin = pagefindSearchPlugin(config.search);`,
-        );
-
-        return code.join("\n");
-      }
-    },
-  };
-};
+import type { Plugin } from "vite";
+import { getCurrentConfig } from "../config/loader.js";
+
+export const viteSearchPlugin = (): Plugin => {
+  const virtualModuleId = "virtual:zudoku-search-plugin";
+  const resolvedVirtualModuleId = `\0${virtualModuleId}`;
+
+  return {
+    name: "zudoku-search-plugin",
+    resolveId(id) {
+      if (id === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+    },
+    async load(id) {
+      if (id !== resolvedVirtualModuleId) return;
+
+      const config = getCurrentConfig();
+
+      if (!config.search || config.__meta.mode === "standalone") {
+        return `export const configuredSearchPlugin = undefined;`;
+      }
+
+      const code = [];
+
+      if (config.search.type === "inkeep") {
+        code.push(
+          `import config from 'virtual:zudoku-config';`,
+          `import { inkeepSearchPlugin } from "@lukoweb/apitogo/plugins/search-inkeep";`,
+          `export const configuredSearchPlugin = inkeepSearchPlugin(config.search);`,
+        );
+
+        return code.join("\n");
+      }
+
+      if (config.search.type === "pagefind") {
+        code.push(
+          `import config from 'virtual:zudoku-config';`,
+          `import { pagefindSearchPlugin } from "@lukoweb/apitogo/plugins/search-pagefind";`,
+          `export const configuredSearchPlugin = pagefindSearchPlugin(config.search);`,
+        );
+
+        return code.join("\n");
+      }
+    },
+  };
+};