@hono-filebased-route/core 0.2.1 → 0.2.3

package/package.json

@@ -1,48 +1,48 @@
-{
-  "name": "@hono-filebased-route/core",
-  "version": "0.2.1",
-  "type": "module",
-  "description": "A core utility for file-based routing in Hono applications.",
-  "author": "HM Suiji <hmsuiji@gmail.com>",
-  "keywords": [
-    "hono",
-    "router",
-    "file-based",
-    "routing",
-    "backend",
-    "framework",
-    "typescript",
-    "file-based-route"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/HM-Suiji/hono-filebased-route.git"
-  },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "bun run build.ts",
-    "clean": "rm -rf dist"
-  },
-  "dependencies": {
-    "fast-glob": "^3.3.3",
-    "fs": "0.0.1-security",
-    "hono": "^4.9.2",
-    "path": "^0.12.7"
-  },
-  "devDependencies": {
-    "@types/bun": "^1.2.20",
-    "@types/node": "^24.3.0",
-    "bun-plugin-dts": "^0.3.0",
-    "typescript": "^5.0.0"
-  },
-  "peerDependenciesMeta": {
-    "hono": {
-      "optional": false
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  }
+{
+  "name": "@hono-filebased-route/core",
+  "version": "0.2.3",
+  "type": "module",
+  "description": "A core utility for file-based routing in Hono applications.",
+  "author": "HM Suiji <hmsuiji@gmail.com>",
+  "keywords": [
+    "hono",
+    "router",
+    "file-based",
+    "routing",
+    "backend",
+    "framework",
+    "typescript",
+    "file-based-route"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HM-Suiji/hono-filebased-route.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "bun run build.ts",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "fast-glob": "^3.3.3",
+    "fs": "0.0.1-security",
+    "hono": "^4.9.2",
+    "path": "^0.12.7"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.20",
+    "@types/node": "^24.3.0",
+    "bun-plugin-dts": "^0.3.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "hono": {
+      "optional": false
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/scripts/generate-routes.ts

@@ -1,14 +1,16 @@
 import { writeFile } from 'fs/promises'
-import { getFiles, getRoutePath } from '../utils/load-routes-utils'
+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
+	output: string = OUTPUT_FILE,
+	write: boolean = true
 ) {
 	console.log('Generating routes file...', dir, output)
 	const absoluteRoutesDir = path.resolve(dir)
@@ -16,7 +18,6 @@ export async function generateRoutesFile(
 
 	const importStatements: string[] = []
 	const routeDefinitions: string[] = []
-	const methods = ['GET', 'POST']
 
 	importStatements.push(`import { Hono } from 'hono';`)
 
@@ -36,10 +37,10 @@ export async function generateRoutesFile(
 		const tempHonoVar = `honoApp${moduleName}`
 		routeDefinitions.push(`  const ${tempHonoVar} = new Hono();`)
 
-		for await (const method of methods) {
-			const fileUrl = pathToFileURL(file).href
-			const module = await import(fileUrl)
-			if (typeof module[method] === 'function') {
+		const exportedMethods = getExportedHttpMethods(file);
+
+		for (const method of METHODS) {
+			if (exportedMethods[method]) {
 				if (routePath.endsWith('/*')) {
 					const len = routePath.replace(/\/\*$/g, '').length + 1
 					routeDefinitions.push(
@@ -52,11 +53,7 @@ export async function generateRoutesFile(
 			}
 		}
 
-		if (routePath === '/') {
-			routeDefinitions.push(`  mainApp.route('${routePath}', ${tempHonoVar});`)
-		} else {
-			routeDefinitions.push(`  mainApp.route('${routePath}', ${tempHonoVar});`)
-		}
+		routeDefinitions.push(`  mainApp.route('${routePath}', ${tempHonoVar});`)
 	}
 
 	const fileContent = `
@@ -73,7 +70,11 @@ ${routeDefinitions.join('\n')}
 }
 `
 
-	await writeFile(output, fileContent.trimStart())
+	if (write) {
+		await writeFile(output, fileContent.trimStart())
+	}
 
 	console.log(`Generated routes file: ${output} with ${files.length} routes.`)
+
+	return fileContent.trimStart()
 }

package/tsconfig.json

@@ -1,18 +1,19 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": ".",
-    "outDir": "./dist",
-    "composite": true
-  },
-  "include": [
-    "utils/**/*.ts",
-    "scripts/**/*.ts",
-    "index.ts"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist",
-    "**/*.test.ts"
-  ]
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "./dist",
+    "composite": true
+  },
+  "include": [
+    "utils/**/*.ts",
+    "scripts/**/*.ts",
+    "types/**/*.ts",
+    "index.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.test.ts"
+  ]
 }

package/types/index.ts

@@ -0,0 +1,6 @@
+export const METHODS = ['GET', 'POST'] as const
+export type Method = (typeof METHODS)[number]
+
+export type ExportedMethods = {
+  [key in Method]: boolean;
+}

package/utils/load-routes-utils.ts

@@ -1,5 +1,8 @@
 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'
 
 /**
  * 遍历指定目录并获取所有文件路径
@@ -39,3 +42,34 @@ export function getRoutePath(filePath: string, baseDir: string): string {
 
 	return `/${routeName}`
 }
+
+/**
+ * 从文件中提取导出的 HTTP 方法
+ * @param filePath 文件的绝对路径
+ * @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;
+}