universal-autorouter-hono

An plugin for Hono to add HMR (Hot Module Replacement) to Hono routes development.

Package required:

• universal-autorouter, used under the hood to autoload routes
• Vite, needed for ViteDevServer instance

⚙️ Install

1yarn add -D universal-autorouter-hono

📖 Usage

Register the Plugin

1// /app.ts
2import path from 'node:path'
3import { serve } from '@hono/node-server'
4import { Hono } from 'hono'
5import type { AutoloadRoutesOptions } from 'universal-autorouter'
6
7const app = new Hono()
8
9let autoloadRoutes
10// Options of "universal-autorouter" or "universal-autorouter-hono" package
11const autoloadRoutesOptions: AutoloadRoutesOptions = {
12  // Pattern to scan route files
13  pattern: '**/*.ts',
14  // Prefix to add to routes
15  prefix: '/api',
16  // Source directory for route handler files
17  routesDir: path.resolve(import.meta.dirname, 'api'),
18  // Directories for files used by route handler files (as default scan all files)
19  externalDirs: ['utils']
20}
21if (process.env.NODE_ENV === 'production') {
22  ({ default: autoloadRoutes } = await import('universal-autorouter'))
23  autoloadRoutesOptions.pattern = '**/*.mjs'
24} else {
25  ({ default: autoloadRoutes } = await import('universal-autorouter-hono'))
26  autoloadRoutesOptions.pattern = '**/*.ts'
27  autoloadRoutesOptions.viteDevServer = '<ViteDevServer_INSTANCE>'
28  // Example with Vike package
29  // autoloadRoutesOptions.viteDevServer = globalThis.__vikeNode!.viteDevServer
30}
31
32await autoloadRoutes(app, autoloadRoutesOptions)
33
34const port = +(process.env.PORT || 3000)
35
36serve({
37  fetch: app.fetch,
38  port
39}, () => console.log(`Server running at http://localhost:${port}`))

License

This project is licensed under the MIT License.