@qualcomm-ui/mdx-vite 3.2.2 → 3.3.0

package/dist/cli.js

@@ -3617,7 +3617,8 @@ var configSchema = implement().with({
   routingStrategy: z2.union([z2.literal("vite-generouted"), z2.any()]).optional(),
   throwOnError: z2.boolean().optional(),
   typeDocProps: z2.string().optional(),
-  typeDocPropsOptions: typeDocPropsSchema.optional()
+  typeDocPropsOptions: typeDocPropsSchema.optional(),
+  validatePageLinks: z2.boolean().optional()
 });
 
 // src/docs-plugin/config/config-loader.ts
@@ -3648,7 +3649,8 @@ var ConfigLoader = class {
       ...conf,
       appDirectory: conf.appDirectory || "app",
       filePath: config3.filepath,
-      pageDirectory: conf.pageDirectory ? removeTrailingSlash(conf.pageDirectory) : "routes"
+      pageDirectory: conf.pageDirectory ? removeTrailingSlash(conf.pageDirectory) : "routes",
+      validatePageLinks: conf.validatePageLinks ?? true
     };
   }
   loadConfig() {
@@ -3658,7 +3660,7 @@ var ConfigLoader = class {
 };
 
 // src/docs-plugin/search-indexer.ts
-import chalk2 from "chalk";
+import chalk3 from "chalk";
 import { defined as defined2 } from "@qualcomm-ui/utils/guard";
 
 // src/docs-plugin/doc-props/doc-props-indexer.ts
@@ -4602,12 +4604,99 @@ var DocPropsIndexer = class {
   }
 };
 
+// src/docs-plugin/link-validator.ts
+import chalk2 from "chalk";
+import { posix } from "node:path";
+import { visit as visit11 } from "unist-util-visit";
+var externalPrefixes = ["https://", "http://", "mailto:", "tel:"];
+function isExternal(url) {
+  return externalPrefixes.some((prefix) => url.startsWith(prefix));
+}
+function resolveLink(url, sourcePathname) {
+  if (isExternal(url)) {
+    return null;
+  }
+  const [rawPath, fragment] = url.split("#", 2);
+  let pathname;
+  if (!rawPath || rawPath === "./" || rawPath === ".") {
+    pathname = sourcePathname;
+  } else if (rawPath.startsWith("/")) {
+    pathname = rawPath;
+  } else {
+    const sourceDir = sourcePathname.endsWith("/") ? sourcePathname : posix.dirname(sourcePathname);
+    pathname = posix.resolve(sourceDir, rawPath);
+  }
+  if (pathname !== "/" && pathname.endsWith("/")) {
+    pathname = pathname.slice(0, -1);
+  }
+  return { fragment: fragment || void 0, pathname };
+}
+function collectLinks(tree, sourceFile, sourcePathname) {
+  const links = [];
+  visit11(tree, "link", (node) => {
+    const resolved = resolveLink(node.url, sourcePathname);
+    if (!resolved) {
+      return;
+    }
+    links.push({
+      fragment: resolved.fragment,
+      sourceFile,
+      sourcePathname,
+      targetPathname: resolved.pathname,
+      url: node.url
+    });
+  });
+  return links;
+}
+function validateLinks(links, pageMap, docPropIds) {
+  const invalid = [];
+  for (const link of links) {
+    const page = pageMap[link.targetPathname];
+    if (!page) {
+      invalid.push({ ...link, reason: "page-not-found" });
+      continue;
+    }
+    if (link.fragment) {
+      const inToc = page.toc?.some((h) => h.id === link.fragment);
+      const inDocProps = docPropIds?.[link.targetPathname]?.has(link.fragment);
+      if (!inToc && !inDocProps) {
+        invalid.push({ ...link, reason: "fragment-not-found" });
+      }
+    }
+  }
+  return invalid;
+}
+function reportInvalidLinks(invalidLinks) {
+  if (invalidLinks.length === 0) {
+    return;
+  }
+  const grouped = /* @__PURE__ */ new Map();
+  for (const link of invalidLinks) {
+    const existing = grouped.get(link.sourcePathname) ?? [];
+    existing.push(link);
+    grouped.set(link.sourcePathname, existing);
+  }
+  console.debug(
+    `
+${chalk2.yellowBright.bold(`Found ${invalidLinks.length} broken link${invalidLinks.length === 1 ? "" : "s"}:`)}`
+  );
+  for (const [sourcePathname, links] of grouped) {
+    console.debug(`
+  ${chalk2.blueBright.bold(sourcePathname)}`);
+    for (const link of links) {
+      const reason = link.reason === "page-not-found" ? "page not found" : `fragment "#${link.fragment}" not found`;
+      console.debug(`    ${chalk2.red("x")} ${link.url} \u2014 ${reason}`);
+    }
+  }
+  console.debug("");
+}
+
 // src/docs-plugin/markdown/knowledge/section-extractor.ts
 import { toString as toString2 } from "mdast-util-to-string";
 import remarkGfm2 from "remark-gfm";
 import remarkStringify4 from "remark-stringify";
 import { unified as unified4 } from "unified";
-import { visit as visit11 } from "unist-util-visit";
+import { visit as visit12 } from "unist-util-visit";
 
 // src/docs-plugin/markdown/knowledge/utils.ts
 import { createHash as createHash2 } from "node:crypto";
@@ -4619,9 +4708,9 @@ function computeMd5(content) {
 // src/docs-plugin/markdown/knowledge/section-extractor.ts
 function transformLinks() {
   return () => (tree) => {
-    visit11(tree, "link", (node) => {
+    visit12(tree, "link", (node) => {
       let text = "";
-      visit11(node, "text", (textNode) => {
+      visit12(node, "text", (textNode) => {
         text += textNode.value;
       });
       Object.assign(node, {
@@ -5330,6 +5419,8 @@ var SearchIndexer = class {
   mdxFileReader;
   allowedHeadings;
   metaJson;
+  _collectedLinks = [];
+  _docPropIds = {};
   routeMetaNav = {};
   config;
   logWarnings;
@@ -5357,6 +5448,8 @@ var SearchIndexer = class {
   _searchIndex = [];
   reset() {
     this.mdxFileReader.reset();
+    this._collectedLinks = [];
+    this._docPropIds = {};
     this._pageMap = {};
     this._searchIndex = [];
   }
@@ -5467,6 +5560,11 @@ var SearchIndexer = class {
           removeMermaidCodeBlocks: true
         });
         const tree = processor.runSync(processor.parse(fileContents));
+        if (this.config.validatePageLinks) {
+          this._collectedLinks.push(
+            ...collectLinks(tree, filePath, defaultSection.pathname)
+          );
+        }
         const pageInfo = {
           frontmatter,
           id: defaultSection.id,
@@ -5479,9 +5577,9 @@ var SearchIndexer = class {
       }
     } catch (error) {
       console.debug(
-        `${chalk2.yellowBright.bold(
+        `${chalk3.yellowBright.bold(
           "Failed to parse mdx page content."
-        )} ${chalk2.blueBright.bold(filePath)}`
+        )} ${chalk3.blueBright.bold(filePath)}`
       );
       if (this.config.throwOnError) {
         throw new Error(error);
@@ -5510,6 +5608,17 @@ var SearchIndexer = class {
     }
     if (docPropSections.length) {
       this._pageDocProps[defaultSection.pathname] = docProps;
+      if (this.config.validatePageLinks) {
+        const ids = /* @__PURE__ */ new Set();
+        for (const section of docPropSections) {
+          if (section.heading?.id) {
+            ids.add(section.heading.id);
+          }
+        }
+        if (ids.size) {
+          this._docPropIds[defaultSection.pathname] = ids;
+        }
+      }
     }
     if (!cached) {
       this.mdxFileReader.updateCache(filePath, fileContents, {
@@ -5606,6 +5715,14 @@ var SearchIndexer = class {
     ).map((file) => this.compileTsxFile(file));
     this._searchIndex.push(...mdxIndex.filter((entry) => !entry.hideFromSearch));
     this.navBuilder.build();
+    if (this.config.validatePageLinks) {
+      const invalidLinks = validateLinks(
+        this._collectedLinks,
+        this._pageMap,
+        this._docPropIds
+      );
+      reportInvalidLinks(invalidLinks);
+    }
     return compiledFiles;
   }
 };