validate-mdx-links 1.2.0 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # validate-mdx-links
 
+## 1.2.1
+
+- Fix install command in README (use `bun`, not `npm`).
+
 ## 1.2.0
 
 ### Features

package/README.md

@@ -1,7 +1,14 @@
 # validate-mdx-links
 
-Wraps `next-validate-link` with heuristics for false positives.
-Handles relative links, with and without `.mdx` extension, and treats `page.mdx` (Next.js App Router) as an index file.
+Validates internal links in MDX files. Wraps `next-validate-link` with heuristics that cut false positives for relative paths, file extensions, and framework-specific routing.
+
+## Supported Frameworks
+
+- **Next.js** — App Router (`app/`) and Pages Router (`pages/`)
+- **Fumadocs** — content-directory scanning (`content/`)
+- **TanStack Router** — `src/routes/` with `$params`, `_layout` prefixes, `[.]` literal dots
+
+Detection reads `package.json` dependencies first, then falls back to directory heuristics.
 
 ## Install
 
@@ -15,11 +22,22 @@ bun add -D validate-mdx-links
 validate-mdx-links --files "content/**/*.mdx" --verbose
 ```
 
-- `--cwd` defaults to `process.cwd()`
-- `--verbose` prints every scanned route
-- exits `1` on broken links, `0` otherwise
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--files` | — | Glob pattern for MDX files to validate |
+| `--content-dir` | — | Content directory for URL scanning; sets `--files` to `${contentDir}/**/*.mdx` when omitted |
+| `--cwd` | `process.cwd()` | Working directory |
+| `--verbose` | `false` | Print every scanned route |
+
+Exits `1` on broken links, `0` otherwise.
 
-Relative links lose `.mdx` in MDX or JSX. The CLI checks `./foo`, `./foo.mdx`, and `../foo/page.mdx` before complaining.
+### Relative links
+
+The CLI resolves relative links (`./sibling`, `../other-dir/page`) against the content directory. It checks multiple path variants — with and without `.mdx`, and with `page.mdx` (App Router index) — before reporting a broken link.
+
+### Heading fragments
+
+Heading IDs follow GitHub Slugger conventions (duplicate tracking, non-ASCII preservation). Links like `./page#section` validate against extracted headings.
 
 ## API
 
@@ -29,8 +47,14 @@ import { validateMdxLinks, printErrors } from "validate-mdx-links";
 const errors = await validateMdxLinks({
   cwd: "/path/to/docs",
   files: "content/**/*.mdx",
+  contentDir: "content",
   verbose: true,
 });
+
+if (errors.length) {
+  printErrors(errors);
+  process.exit(1);
+}
 ```
 
-You get an array of `{ file, detected }`. Pass it to `printErrors` or build your own reporter.
+`validateMdxLinks` returns `ValidationResult[]`; each entry has `file` and `detected` fields. Pass the array to `printErrors` or build a custom reporter.

package/dist/index.js

@@ -182,6 +182,7 @@ function buildContentScanResult(contentDir, cwd, verbose, deps) {
     return { urls, fallbackUrls };
 }
 export async function validateMdxLinks({ cwd = process.cwd(), files: filesGlob, verbose = false, contentDir, }) {
+    cwd = resolve(cwd);
     const originalCwd = process.cwd();
     process.chdir(cwd);
     const files = globSync(filesGlob);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "validate-mdx-links",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "license": "ISC",
   "type": "module",
   "main": "dist/index.js",

package/src/index.ts

@@ -263,6 +263,7 @@ export async function validateMdxLinks({
   verbose = false,
   contentDir,
 }: ValidateMdxLinksOptions): Promise<ValidationResult[]> {
+  cwd = resolve(cwd);
   const originalCwd = process.cwd();
   process.chdir(cwd);