Support Nuxt framework preset

Author: fuma-nama

.changeset/new-olives-dig.md

@@ -0,0 +1,5 @@
+---
+'next-validate-link': minor
+---
+
+Support Nuxt framework preset

docs/content/docs/meta.json

@@ -0,0 +1,3 @@
+{
+  "pages": ["index", "---Frameworks---", "..."]
+}

docs/content/docs/nuxt.mdx

@@ -0,0 +1,18 @@
+---
+title: Nuxt
+description: Support Nuxt validation
+---
+
+## Usage
+
+By default, it assumes you are using Next.js routing.
+You can pass a framework preset to customise how it scans your pages.
+
+```ts
+import { scanURLs } from 'next-validate-link';
+
+const scanned = await scanURLs({
+  preset: 'nuxt',
+});
+// validate with the scanned urls
+```

src/presets/astro.ts

@@ -14,14 +14,12 @@ export async function scanURLs(options: ScanOptions = {}): Promise<ScanResult> {
       cwd: path.join(cwd, 'src/pages'),
     });
 
-    return [
-      ...pagesFiles.map((file) => {
-        const parsed = path.parse(file);
-        if (parsed.name === 'index') return parsed.dir;
-
-        return path.join(parsed.dir, parsed.name);
-      }),
-    ];
+    return pagesFiles.map((file) => {
+      const parsed = path.parse(file);
+      if (parsed.name === 'index') return parsed.dir;
+
+      return path.join(parsed.dir, parsed.name);
+    });
   }
 
   const result: ScanResult = { urls: new Map(), fallbackUrls: [] };

src/presets/nuxt.ts

@@ -0,0 +1,36 @@
+import { ScanOptions, ScanResult } from '@/scan';
+import * as path from 'node:path';
+import fg from 'fast-glob';
+import { populateToScanResult } from './shared';
+import { isDirExists } from '@/utils/fs';
+
+export async function scanURLs(options: ScanOptions = {}): Promise<ScanResult> {
+  const ext = options.extensions ?? ['vue', 'md', 'mdx'];
+  const cwd = options.cwd ?? process.cwd();
+
+  async function getFiles() {
+    const suffix = ext.length > 0 ? `.{${ext.join(',')}}` : '';
+
+    const pagesFiles = await fg(`**/*${suffix}`, {
+      cwd: (await isDirExists(path.join(cwd, 'src/pages')))
+        ? path.join(cwd, 'src/pages')
+        : path.join(cwd, 'pages'),
+    });
+
+    return pagesFiles.map((file) => {
+      const parsed = path.parse(file);
+      if (parsed.name === 'index') return parsed.dir;
+
+      return path.join(parsed.dir, parsed.name);
+    });
+  }
+
+  const result: ScanResult = { urls: new Map(), fallbackUrls: [] };
+  const files = options.pages ?? (await getFiles());
+
+  for (const file of files) {
+    populateToScanResult(file.split(path.sep), options, result);
+  }
+
+  return result;
+}

src/scan.ts

@@ -1,5 +1,6 @@
 import * as Next from './presets/next';
 import * as Astro from './presets/astro';
+import * as Nuxt from './presets/nuxt';
 
 export type PopulateParams = Record<
   string,
@@ -45,8 +46,10 @@ export async function scanURLs({
   /**
    * @default next
    */
-  preset?: 'next' | 'astro';
+  preset?: 'next' | 'astro' | 'nuxt';
 } = {}): Promise<ScanResult> {
   if (preset === 'astro') return Astro.scanURLs(options);
+  if (preset === 'nuxt') return Nuxt.scanURLs(options);
+
   return Next.scanURLs(options);
 }

test/fixture/nuxt-1/pages/blog/[id].vue

@@ -61,3 +61,34 @@ test('scan router from file system: Astro', async () => {
     }
   `);
 });
+
+test('scan router from file system: Nuxt', async () => {
+  const urls = await scanURLs({
+    preset: 'nuxt',
+    cwd: path.join(fileURLToPath(import.meta.url), '../fixture/nuxt-1'),
+    populate: {
+      'docs/[...slug]': [
+        {
+          value: 'test',
+        },
+      ],
+    },
+  });
+
+  expect(urls).toMatchInlineSnapshot(`
+    {
+      "fallbackUrls": [
+        {
+          "meta": {},
+          "url": /\\^\\\\/blog\\\\/\\(\\.\\+\\)\\$/,
+        },
+      ],
+      "urls": Map {
+        "/" => {},
+        "/docs/test" => {
+          "value": "test",
+        },
+      },
+    }
+  `);
+});