refactor!: drop radix3 support in favour of rou3

danielroe · danielroe · commit aed2a25880ec · 2025-08-09T13:22:41.000+01:00
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ This library is a work in progress and in active development.
 - [ ] export capability for framework routers
   - [x] RegExp patterns
   - [x] [`vue-router`](https://router.vuejs.org/) routes
-  - [ ] [radix3](http://github.com/unjs/radix3)/[Nitro](https://nitro.unjs.io/) routes
+  - [x] [rou3](http://github.com/h3js/rou3)/[Nitro](https://nitro.unjs.io/) routes
   - [ ] [SolidStart](https://start.solidjs.com/core-concepts/routing)
   - [ ] [SvelteKit](https://kit.svelte.dev/docs/routing) routes
 - [ ] support scanning FS (with optional watch mode)
@@ -77,7 +77,7 @@ console.log(result2.segments) // [[{ type: 'static', value: 'api' }]]
 ### Convert to Router Formats
 
 ```js
-import { parsePath, toVueRouter4, toRadix3, toRegExp } from 'unrouting'
+import { parsePath, toVueRouter4, toRou3, toRegExp } from 'unrouting'
 
 const result = parsePath('users/[id]/posts/[slug].vue')
 const segments = result.segments
@@ -86,8 +86,8 @@ const segments = result.segments
 const vueRoute = toVueRouter4(segments)
 console.log(vueRoute.path) // '/users/:id()/posts/:slug()'
 
-// Radix3/Nitro format  
-const nitroRoute = toRadix3(segments)
+// Rou3/Nitro format  
+const nitroRoute = toRou3(segments)
 console.log(nitroRoute) // '/users/:id/posts/:slug'
 
 // RegExp pattern
@@ -145,9 +145,9 @@ Convert parsed segments to Vue Router 4 format.
 
 **Returns:** `{ path: string }`
 
-### `toRadix3(segments)`
+### `toRou3(segments)`
 
-Convert parsed segments to Radix3/Nitro format.
+Convert parsed segments to Rou3/Nitro format.
 
 **Parameters:**
 - `segments` (ParsedPathSegment[]): The segments from `parsePath().segments`
diff --git a/package.json b/package.json
@@ -39,7 +39,7 @@
     "bumpp": "10.2.2",
     "eslint": "latest",
     "lint-staged": "latest",
-    "radix3": "1.1.2",
+    "rou3": "^0.7.3",
     "simple-git-hooks": "latest",
     "typescript": "latest",
     "unbuild": "latest",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/converters.ts b/src/converters.ts
@@ -1,12 +1,12 @@
-import escapeStringRegexp from 'escape-string-regexp'
+import type { ParsedPathSegment } from './parse'
 
+import escapeStringRegexp from 'escape-string-regexp'
 import { encodePath, joinURL } from 'ufo'
-import type { ParsedPathSegment } from './parse'
 import { parsePath } from './parse'
 
 /**
  * - [x] support exporting to pure RegExp matcher
- * - [x] support exporting to radix3/Nitro routes
+ * - [x] support exporting to rou3/Nitro routes
  * - [ ] support exporting to `vue-router` routes
  *       with compatibility for [Nuxt](https://github.com/nuxt/nuxt) and
  *       [unplugin-vue-router](https://github.com/posva/unplugin-vue-router)
@@ -15,9 +15,9 @@ import { parsePath } from './parse'
  */
 
 /**
- * TODO: need to implement protection logging + fall back to what radix3 supports.
+ * Convert file path to rou3 route pattern format.
  */
-export function toRadix3(filePath: string | ParsedPathSegment[]) {
+export function toRou3(filePath: string | ParsedPathSegment[]) {
   const segments = typeof filePath === 'string' ? parsePath(filePath).segments : filePath
 
   let route = '/'
@@ -26,24 +26,24 @@ export function toRadix3(filePath: string | ParsedPathSegment[]) {
     if (segment.every(token => token.type === 'group'))
       continue
 
-    let radixSegment = ''
+    let rou3Segment = ''
     for (const token of segment) {
       if (token.type === 'static')
-        radixSegment += token.value
+        rou3Segment += token.value
 
       if (token.type === 'dynamic')
-        radixSegment += token.value ? `:${token.value}` : '*'
+        rou3Segment += token.value ? `:${token.value}` : '*'
 
       if (token.type === 'optional')
-        throw new TypeError('[unrouting] `toRadix3` does not support optional parameters')
+        throw new TypeError('[unrouting] `toRou3` does not support optional parameters')
 
       if (token.type === 'catchall')
-        radixSegment += token.value ? `**:${token.value}` : '**'
+        rou3Segment += token.value ? `**:${token.value}` : '**'
     }
 
     // If a segment has value '' we skip adding it entirely
-    if (radixSegment)
-      route = joinURL(route, radixSegment)
+    if (rou3Segment)
+      route = joinURL(route, rou3Segment)
   }
 
   return route
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,4 @@
-export { toRadix3, toRegExp, toVueRouter4 } from './converters'
+export { toRegExp, toRou3, toVueRouter4 } from './converters'
 
 export type { ParsedPath, ParsedPathSegment, ParsedPathSegmentToken, ParsePathOptions, SegmentType } from './parse'
 export { parsePath } from './parse'
diff --git a/test/unit/converters.spec.ts b/test/unit/converters.spec.ts
@@ -1,9 +1,9 @@
-import { createRouter as createRadixRouter } from 'radix3'
+import { addRoute, createRouter, findRoute } from 'rou3'
 import { describe, expect, it } from 'vitest'
 import { createMemoryHistory, createRouter as createVueRouter } from 'vue-router'
-import { toRadix3, toRegExp, toVueRouter4 } from '../../src'
+import { toRegExp, toRou3, toVueRouter4 } from '../../src'
 
-describe('radix3 support', () => {
+describe('rou3 support', () => {
   const paths = {
     'file.vue': '/file',
     'index.vue': '/',
@@ -13,10 +13,10 @@ describe('radix3 support', () => {
     '/file/[...slug].vue': '/file/here/we/go',
     '[a1_1a].vue': '/file',
     '[b2.2b].vue': '/file',
-    'test:name.vue': '/test:name',
-    // TODO: mixed parameters are not (yet?) supported in radix3
+    // TODO: mixed parameters are not (yet?) supported in rou3
+    // 'test:name.vue': '/test:name',
     // '[b2]_[2b].vue': '/fi_le',
-    // TODO: optional parameters are not (yet?) supported in radix3
+    // TODO: optional parameters are not (yet?) supported in rou3
     // '[[foo]]/index.vue': '/some',
     // '[[sub]]/route-[slug].vue': '/some/route-value',
     // 'optional/[[opt]].vue': '/optional',
@@ -27,12 +27,13 @@ describe('radix3 support', () => {
     // '[[d4-4d]].vue': '/file',
   }
 
-  it('toRadix3', () => {
+  it('toRou3', () => {
     const result = Object.fromEntries(Object.entries(paths).map(([path, example]) => {
-      const routeMatcher = createRadixRouter()
-      routeMatcher.insert(toRadix3(path), { value: example })
-      const result = routeMatcher.lookup(example)
-      return [path, result?.params || result?.value]
+      const router = createRouter<{ value: string }>()
+      addRoute(router, 'GET', toRou3(path), { value: example })
+      const result = findRoute(router, 'GET', example)
+      // Return params if available (for dynamic routes), otherwise return the value from data
+      return [path, result?.params || result?.data.value]
     }))
 
     expect(result).toMatchInlineSnapshot(`
@@ -53,7 +54,6 @@ describe('radix3 support', () => {
         "foo/index.vue": "/foo",
         "index.vue": "/",
         "test.html.vue": "/test.html",
-        "test:name.vue": "/test:name",
       }
     `)
   })
