validate-mdx-links 1.0.1 → 1.0.3

package/dist/index.js

@@ -15,12 +15,14 @@ export async function validateMdxLinks({ cwd = process.cwd(), files: filesGlob,
         console.log(`Found ${files.length} markdown files to validate.\n`);
     }
     const scanned = await scanURLs();
-    console.log("\n" +
-        "Scanned routes from the file system:\n" +
-        [...scanned.urls.keys(), ...scanned.fallbackUrls.map((x) => x.url)]
-            .map((x) => `"${x}"`)
-            .join(", ") +
-        "\n");
+    if (verbose) {
+        console.log("\n" +
+            "Scanned routes from the file system:\n" +
+            [...scanned.urls.keys(), ...scanned.fallbackUrls.map((x) => x.url)]
+                .map((x) => `"${x}"`)
+                .join(", ") +
+            "\n");
+    }
     const validations = await validateFiles(files, { scanned });
     const withoutFalsePositives = await Promise.all(validations.map(async ({ file, detected }) => {
         const filteredDetected = [];
@@ -30,10 +32,6 @@ export async function validateMdxLinks({ cwd = process.cwd(), files: filesGlob,
                 // If there is a hash #id, we don't parse the file to find the heading,
                 // just assume it exists and check if the file exists.
                 link = link.split("#")[0] || "";
-                // relative links inside of JSX lose the .mdx extension
-                if (!link.endsWith(".mdx")) {
-                    link = `${link}.mdx`;
-                }
                 {
                     const path = resolve(dirname(file), link);
                     if (await fileExists(path)) {
@@ -41,14 +39,27 @@ export async function validateMdxLinks({ cwd = process.cwd(), files: filesGlob,
                         continue;
                     }
                 }
+                // relative links can lose their .mdx extension
+                if (!link.endsWith(".mdx")) {
+                    const dest = resolve(dirname(file), `${link}.mdx`);
+                    if (await fileExists(dest)) {
+                        // file exists, the error is a false positive
+                        continue;
+                    }
+                }
+                // relative links inside of JSX lose the .mdx extension
                 // if the link is relative and the file containing the link is `page.mdx`,
                 // we can check if {destination}/page.mdx exists
                 if (basename(file) === "page.mdx") {
-                    const possibleDest = resolve(dirname(file), "..", link, "page.mdx");
-                    if (await fileExists(possibleDest)) {
+                    const dest = resolve(dirname(file), "..", link, "page.mdx");
+                    if (await fileExists(dest)) {
                         continue;
                     }
                 }
+                // There's another case for a false postive:
+                // We could have a relative link `./bar` from (a)/(b)/foo/page.mdx to (c)/bar/page.mdx
+                // We should either open an issue in `next-validate-link` or handle it with glob patterns.
+                // For now, prefer to use absolute links in cases like this.
             }
             filteredDetected.push(error);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "validate-mdx-links",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "main": "dist/index.js",
   "type": "module",
   "bin": {

package/src/index.ts

@@ -38,14 +38,16 @@ export async function validateMdxLinks({
 
   const scanned = await scanURLs();
 
-  console.log(
-    "\n" +
-      "Scanned routes from the file system:\n" +
-      [...scanned.urls.keys(), ...scanned.fallbackUrls.map((x) => x.url)]
-        .map((x) => `"${x}"`)
-        .join(", ") +
-      "\n"
-  );
+  if (verbose) {
+    console.log(
+      "\n" +
+        "Scanned routes from the file system:\n" +
+        [...scanned.urls.keys(), ...scanned.fallbackUrls.map((x) => x.url)]
+          .map((x) => `"${x}"`)
+          .join(", ") +
+        "\n"
+    );
+  }
 
   const validations = await validateFiles(files, { scanned });