@hono-filebased-route/core 0.2.3 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono-filebased-route/core",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "type": "module",
   "description": "A core utility for file-based routing in Hono applications.",
   "author": "HM Suiji <hmsuiji@gmail.com>",
@@ -40,6 +40,9 @@
   "peerDependenciesMeta": {
     "hono": {
       "optional": false
+    },
+    "typescript": {
+      "optional": false
     }
   },
   "publishConfig": {

package/scripts/generate-routes.ts

@@ -1,62 +1,63 @@
 import { writeFile } from 'fs/promises'
 import { getExportedHttpMethods, getFiles, getRoutePath } from '../utils/load-routes-utils'
 import path from 'path'
-import { pathToFileURL } from 'url'
-import { METHODS } from '../types'
-
-const ROUTES_DIR = './src/routes'
-const OUTPUT_FILE = './src/generated-routes.ts'
-
-export async function generateRoutesFile(
-	dir: string = ROUTES_DIR,
-	output: string = OUTPUT_FILE,
-	write: boolean = true
-) {
-	console.log('Generating routes file...', dir, output)
-	const absoluteRoutesDir = path.resolve(dir)
-	const files = await getFiles(absoluteRoutesDir)
-
-	const importStatements: string[] = []
-	const routeDefinitions: string[] = []
-
-	importStatements.push(`import { Hono } from 'hono';`)
-
-	let counter = 0
-	for (const file of files) {
-		const routePath = getRoutePath(file, absoluteRoutesDir)
-			.replace(/\\/g, '/')
-			.replace(/\/index$/, '')
-		const relativePath = path
-			.relative(path.dirname(output), file)
-			.replace(/\.(ts)$/, '')
-			.replace(/\\/g, '/')
-		const moduleName = `routeModule${counter++}`
-
-		importStatements.push(`import * as ${moduleName} from './${relativePath}';`)
-
-		const tempHonoVar = `honoApp${moduleName}`
-		routeDefinitions.push(`  const ${tempHonoVar} = new Hono();`)
-
-		const exportedMethods = getExportedHttpMethods(file);
-
-		for (const method of METHODS) {
-			if (exportedMethods[method]) {
-				if (routePath.endsWith('/*')) {
-					const len = routePath.replace(/\/\*$/g, '').length + 1
-					routeDefinitions.push(
-						`  ${tempHonoVar}.${method.toLowerCase()}('/', async (c) => ${moduleName}.${method}(c, c.req.path.substring(${len}).split('/')));`
-					)
-				} else
-					routeDefinitions.push(
-						`  ${tempHonoVar}.${method.toLowerCase()}('/', ${moduleName}.${method});`
-					)
-			}
-		}
-
-		routeDefinitions.push(`  mainApp.route('${routePath}', ${tempHonoVar});`)
-	}
-
-	const fileContent = `
+import { Config, METHODS } from '../types'
+import { createLogger } from '../utils/logger'
+
+const defaultConfig: Config = {
+  dir: './src/routes',
+  output: './src/generated-routes.ts',
+  write: true,
+  verbose: false,
+  externals: [],
+} as const
+
+export async function generateRoutesFile(config?: Partial<Config>) {
+  const { dir, output, write, verbose, externals } = { ...defaultConfig, ...config }
+  const logger = createLogger(verbose)
+  logger.info(`Generating routes file..., ${dir}, ${output}`)
+  const absoluteRoutesDir = path.resolve(dir)
+  const files = await getFiles(absoluteRoutesDir, externals)
+
+  const importStatements: string[] = []
+  const routeDefinitions: string[] = []
+
+  importStatements.push(`import { Hono } from 'hono';`)
+
+  let counter = 0
+  for (const file of files) {
+    const routePath = getRoutePath(file, absoluteRoutesDir)
+      .replace(/\\/g, '/')
+      .replace(/\/index$/, '')
+    const relativePath = path
+      .relative(path.dirname(output), file)
+      .replace(/\.(ts)$/, '')
+      .replace(/\\/g, '/')
+    const moduleName = `routeModule${counter++}`
+
+    importStatements.push(`import * as ${moduleName} from './${relativePath}';`)
+
+    const tempHonoVar = `honoApp${moduleName}`
+    routeDefinitions.push(`  const ${tempHonoVar} = new Hono();`)
+
+    const exportedMethods = getExportedHttpMethods(file)
+
+    for (const method of METHODS) {
+      if (exportedMethods[method]) {
+        if (routePath.endsWith('/*')) {
+          const len = routePath.replace(/\/\*$/g, '').length + 1
+          routeDefinitions.push(
+            `  ${tempHonoVar}.${method.toLowerCase()}('/', async (c) => ${moduleName}.${method}(c, c.req.path.substring(${len}).split('/')));`
+          )
+        } else routeDefinitions.push(`  ${tempHonoVar}.${method.toLowerCase()}('/', ${moduleName}.${method});`)
+        logger.info(`Generated route: ${method} ${routePath}`)
+      }
+    }
+
+    routeDefinitions.push(`  mainApp.route('${routePath}', ${tempHonoVar});`)
+  }
+
+  const fileContent = `
 // THIS FILE IS AUTO-GENERATED BY scripts/generate-routes.ts. DO NOT EDIT.
 
 ${importStatements.join('\n')}
@@ -70,11 +71,10 @@ ${routeDefinitions.join('\n')}
 }
 `
 
-	if (write) {
-		await writeFile(output, fileContent.trimStart())
-	}
-
-	console.log(`Generated routes file: ${output} with ${files.length} routes.`)
+  if (write) {
+    await writeFile(output, fileContent.trimStart())
+    logger.info(`Generated routes file: ${output} with ${files.length} routes.`)
+  }
 
-	return fileContent.trimStart()
+  return fileContent.trimStart()
 }

package/types/index.ts

@@ -2,5 +2,13 @@ export const METHODS = ['GET', 'POST'] as const
 export type Method = (typeof METHODS)[number]
 
 export type ExportedMethods = {
-  [key in Method]: boolean;
-}
+  [key in Method]: boolean
+}
+
+export type Config = {
+  dir: string
+  output: string
+  write: boolean
+  verbose: boolean
+  externals: string[]
+}

package/utils/load-routes-utils.ts

@@ -2,23 +2,31 @@ import path from 'path'
 import fg from 'fast-glob'
 import { readFileSync } from 'fs'
 import { ExportedMethods, Method, METHODS } from '../types'
-import { createSourceFile, ScriptTarget, isVariableStatement, isFunctionDeclaration, SyntaxKind, isIdentifier } from 'typescript'
+import {
+  createSourceFile,
+  ScriptTarget,
+  isVariableStatement,
+  isFunctionDeclaration,
+  SyntaxKind,
+  isIdentifier,
+} from 'typescript'
 
 /**
  * 遍历指定目录并获取所有文件路径
  * @param dir 要遍历的目录
  * @returns 目录内所有文件绝对路径的数组
  */
-export async function getFiles(dir: string): Promise<string[]> {
-	const absoluteDir = path.resolve(dir)
-	const pattern = path.join(absoluteDir, '**', '*.{ts,js}').replace(/\\/g, '/')
+export async function getFiles(dir: string, externals?: string[]): Promise<string[]> {
+  const absoluteDir = path.resolve(dir)
+  const pattern = path.join(absoluteDir, '**', '*.{ts,js}').replace(/\\/g, '/')
 
-	const files = await fg(pattern, {
-		absolute: true,
-		onlyFiles: true
-	})
+  const files = await fg(pattern, {
+    absolute: true,
+    onlyFiles: true,
+    ignore: externals,
+  })
 
-	return files
+  return files
 }
 
 /**
@@ -28,19 +36,19 @@ export async function getFiles(dir: string): Promise<string[]> {
  * @returns 转换后的 Hono 路由路径
  */
 export function getRoutePath(filePath: string, baseDir: string): string {
-	let routeName = path.relative(baseDir, filePath).replace(/\.(ts|js)$/, '')
+  let routeName = path.relative(baseDir, filePath).replace(/\.(ts|js)$/, '')
 
-	routeName = routeName
-		.replace(/\[\.\.\.(\w+)\]/g, '*') // 捕获所有：[...slug] => *
-		.replace(/\[(\w+)\]/g, ':$1') // 动态参数：[id] => :id
+  routeName = routeName
+    .replace(/\[\.\.\.(\w+)\]/g, '*') // 捕获所有：[...slug] => *
+    .replace(/\[(\w+)\]/g, ':$1') // 动态参数：[id] => :id
 
-	if (routeName === 'index') {
-		return '/'
-	} else if (routeName.endsWith('/index')) {
-		return `/${routeName.slice(0, -6)}`
-	}
+  if (routeName === 'index') {
+    return '/'
+  } else if (routeName.endsWith('/index')) {
+    return `/${routeName.slice(0, -6)}`
+  }
 
-	return `/${routeName}`
+  return `/${routeName}`
 }
 
 /**
@@ -49,27 +57,26 @@ export function getRoutePath(filePath: string, baseDir: string): string {
  * @returns 导出的 HTTP 方法对象
  */
 export function getExportedHttpMethods(filePath: string): ExportedMethods {
-	const fileContent = readFileSync(filePath, 'utf8');
-	const sourceFile = createSourceFile(
-		filePath,
-		fileContent,
-		ScriptTarget.ESNext,
-		true
-	);
-	const methods: ExportedMethods = {} as ExportedMethods
-	sourceFile.forEachChild(node => {
-		// 寻找 export const GET = ... 或 export function POST() { ... } 形式
-		if (isVariableStatement(node) && node.modifiers && node.modifiers.some(m => m.kind === SyntaxKind.ExportKeyword)) {
-			for (const declaration of node.declarationList.declarations) {
-				if (isIdentifier(declaration.name) && METHODS.includes(declaration.name.text as Method)) {
-					methods[declaration.name.text as Method] = true;
-				}
-			}
-		} else if (isFunctionDeclaration(node) && node.modifiers && node.modifiers.some(m => m.kind === SyntaxKind.ExportKeyword)) {
-			if (node.name && METHODS.includes(node.name.text as Method)) {
-				methods[node.name.text as Method] = true;
-			}
-		}
-	});
-	return methods;
+  const fileContent = readFileSync(filePath, 'utf8')
+  const sourceFile = createSourceFile(filePath, fileContent, ScriptTarget.ESNext, true)
+  const methods: ExportedMethods = {} as ExportedMethods
+  sourceFile.forEachChild(node => {
+    // 寻找 export const GET = ... 或 export function POST() { ... } 形式
+    if (isVariableStatement(node) && node.modifiers && node.modifiers.some(m => m.kind === SyntaxKind.ExportKeyword)) {
+      for (const declaration of node.declarationList.declarations) {
+        if (isIdentifier(declaration.name) && METHODS.includes(declaration.name.text as Method)) {
+          methods[declaration.name.text as Method] = true
+        }
+      }
+    } else if (
+      isFunctionDeclaration(node) &&
+      node.modifiers &&
+      node.modifiers.some(m => m.kind === SyntaxKind.ExportKeyword)
+    ) {
+      if (node.name && METHODS.includes(node.name.text as Method)) {
+        methods[node.name.text as Method] = true
+      }
+    }
+  })
+  return methods
 }

package/utils/logger.ts

@@ -0,0 +1,18 @@
+import pino, { Logger } from 'pino'
+
+export const createLogger = (verbose: boolean = false) =>
+  verbose
+    ? pino({
+        transport: {
+          target: 'pino-pretty',
+          options: {
+            colorize: true,
+          },
+        },
+      })
+    : ({
+      info: () => { },
+      debug: () => { },
+      error: () => { },
+      warn: () => { },
+    } as unknown as Logger)