feat: runtime error on missing param parsers

posva · posva · commit 26e303225826 · 2026-01-22T15:35:29.000+01:00
diff --git a/packages/router/src/unplugin/codegen/generateParamParsers.spec.ts b/packages/router/src/unplugin/codegen/generateParamParsers.spec.ts
@@ -1,6 +1,7 @@
 import { describe, expect, it } from 'vitest'
 import {
   warnMissingParamParsers,
+  collectMissingParamParsers,
   generateParamParsersTypesDeclarations,
   generateParamsTypes,
   generateParamParserOptions,
@@ -71,6 +72,87 @@ describe('warnMissingParamParsers', () => {
   })
 })
 
+describe('collectMissingParamParsers', () => {
+  it('returns empty array for routes without param parsers', () => {
+    const tree = new PrefixTree(DEFAULT_OPTIONS)
+    tree.insert('users', 'users.vue')
+    tree.insert('posts/[id]', 'posts/[id].vue')
+
+    const paramParsers: ParamParsersMap = new Map()
+
+    const result = collectMissingParamParsers(tree, paramParsers)
+    expect(result).toEqual([])
+  })
+
+  it('returns empty array for native parsers', () => {
+    const tree = new PrefixTree(DEFAULT_OPTIONS)
+    tree.insert('users/[id=int]', 'users/[id=int].vue')
+    tree.insert('posts/[active=bool]', 'posts/[active=bool].vue')
+
+    const paramParsers: ParamParsersMap = new Map()
+
+    const result = collectMissingParamParsers(tree, paramParsers)
+    expect(result).toEqual([])
+  })
+
+  it('collects missing custom parsers with route and file info', () => {
+    const tree = new PrefixTree(DEFAULT_OPTIONS)
+    tree.insert('users/[id=uuid]', 'users/[id=uuid].vue')
+
+    const paramParsers: ParamParsersMap = new Map()
+
+    const result = collectMissingParamParsers(tree, paramParsers)
+    expect(result).toEqual([
+      {
+        parser: 'uuid',
+        routePath: '/users/:id',
+        filePaths: ['users/[id=uuid].vue'],
+      },
+    ])
+  })
+
+  it('returns empty array when custom parsers exist in map', () => {
+    const tree = new PrefixTree(DEFAULT_OPTIONS)
+    tree.insert('users/[id=uuid]', 'users/[id=uuid].vue')
+
+    const paramParsers: ParamParsersMap = new Map([
+      [
+        'uuid',
+        {
+          name: 'uuid',
+          typeName: 'Param_uuid',
+          relativePath: 'parsers/uuid',
+          absolutePath: '/path/to/parsers/uuid',
+        },
+      ],
+    ])
+
+    const result = collectMissingParamParsers(tree, paramParsers)
+    expect(result).toEqual([])
+  })
+
+  it('collects multiple missing parsers from different routes', () => {
+    const tree = new PrefixTree(DEFAULT_OPTIONS)
+    tree.insert('users/[id=uuid]', 'users/[id=uuid].vue')
+    tree.insert('posts/[slug=slug]', 'posts/[slug=slug].vue')
+
+    const paramParsers: ParamParsersMap = new Map()
+
+    const result = collectMissingParamParsers(tree, paramParsers)
+    expect(result).toHaveLength(2)
+    expect(result).toContainEqual({
+      parser: 'uuid',
+      routePath: '/users/:id',
+      filePaths: ['users/[id=uuid].vue'],
+    })
+    expect(result).toContainEqual({
+      parser: 'slug',
+      routePath: '/posts/:slug',
+      filePaths: ['posts/[slug=slug].vue'],
+    })
+  })
+})
+
 describe('generateParamParsersTypesDeclarations', () => {
   it('returns empty string for empty param parsers map', () => {
     const paramParsers: ParamParsersMap = new Map()
diff --git a/packages/router/src/unplugin/codegen/generateParamParsers.ts b/packages/router/src/unplugin/codegen/generateParamParsers.ts
@@ -37,6 +37,33 @@ export function warnMissingParamParsers(
   }
 }
 
+export interface MissingParamParser {
+  parser: string
+  routePath: string
+  filePaths: string[]
+}
+
+export function collectMissingParamParsers(
+  tree: PrefixTree,
+  paramParsers: ParamParsersMap
+): MissingParamParser[] {
+  const missing: MissingParamParser[] = []
+  for (const node of tree.getChildrenDeepSorted()) {
+    for (const param of node.params) {
+      if (param.parser && !paramParsers.has(param.parser)) {
+        if (!NATIVE_PARAM_PARSERS.includes(param.parser)) {
+          missing.push({
+            parser: param.parser,
+            routePath: node.fullPath,
+            filePaths: Array.from(node.value.components.values()),
+          })
+        }
+      }
+    }
+  }
+  return missing
+}
+
 export function generateParamParsersTypesDeclarations(
   paramParsers: ParamParsersMap
 ) {
diff --git a/packages/router/src/unplugin/core/context.ts b/packages/router/src/unplugin/core/context.ts
@@ -26,6 +26,7 @@ import {
   generateParamParserCustomType,
   ParamParsersMap,
   warnMissingParamParsers,
+  collectMissingParamParsers,
 } from '../codegen/generateParamParsers'
 import picomatch from 'picomatch'
 import { camelCase } from 'scule'
@@ -276,6 +277,24 @@ export function createRoutesContext(options: ResolvedOptions) {
       imports += '\n'
     }
 
+    // collect missing param parsers and generate runtime errors
+    const missingParsers = collectMissingParamParsers(
+      routeTree,
+      paramParsersMap
+    )
+    let missingParserErrors = ''
+    if (missingParsers.length > 0) {
+      missingParserErrors =
+        '\n' +
+        missingParsers
+          .map(
+            ({ parser, routePath, filePaths }) =>
+              `console.error('[vue-router] Parameter parser "${parser}" not found for route "${routePath}". File: ${filePaths.join(', ')}')`
+          )
+          .join('\n') +
+        '\n'
+    }
+
     const hmr = ts`
 export function handleHotUpdate(_router, _hotUpdateCallback) {
   if (import.meta.hot) {
@@ -304,7 +323,7 @@ if (import.meta.hot) {
   })
 }`
 
-    const newAutoResolver = `${imports}${resolverCode}\n${hmr}`
+    const newAutoResolver = `${imports}${missingParserErrors}${resolverCode}\n${hmr}`
 
     // prepend it to the code
     return newAutoResolver
