orpc-file-based-router 0.1.4 → 0.1.5

package/README.md

@@ -9,10 +9,6 @@ structure, inspired by Next.js and express-file-routing approaches.
 - 🔄 **Zero Configuration**: Generate routes automatically based on your directory structure
 - ⚡️ **Development Speed**: Eliminate boilerplate code and reduce maintenance overhead
 - 🔍 **Dynamic Routing**: Support for path parameters using `{param}` syntax in file names
-- 📑 **Index Routes**: Support for index routes via `index.ts` files
-
-> ⚠️ **IMPORTANT:** At this time, the plugin's functionality is only guaranteed
-> in nodejs runtime
 
 ## Quickstart
 
@@ -103,6 +99,8 @@ generateRouter(routesDir, outputFile);
 
 2. Generated router is ready to use in client:
 
+> ⚠️ If you don't want plugin to generate openapi `route({})` suffix, just set parameter `includeRoute` to `false`
+
 ```typescript
 // router.ts
 import { me } from "./routes/auth/me";
@@ -131,6 +129,7 @@ export const router = {
   sse: sse.route({ path: "/sse" }),
 };
 
+
 // lib/orpc.ts
 const client: RouterClient<typeof router> = createORPCClient(link)
 
@@ -143,6 +142,7 @@ When using `generateRouter`, you can provide additional options to customize the
 | Field              | Type      | Required | Default Value | Description                                                                                                                     |
 |-------------------|----------|--------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------|
 | `importExtension` | string   | false         | `""`(No extension) | File extension to append to import statements in the generated router. Useful when your build setup requires specific extensions. <br>Example: `.js` → `import { me } from "./routes/auth/me.js"` |
+| `includeRoute` | boolean   | false         | `true` | When set to true, each route will be wrapped with openapi `.route({ path: '...' })` call   |
 
 
 

package/dist/index.cjs

@@ -56,7 +56,10 @@ async function generateRouter(routesDir, outputFile, options) {
   const exports = await generateRoutes(files);
   const importPaths = exports.map((x) => path.relative(path.dirname(outputFile), routesDir).concat(x.path));
   const content = buildRouter(exports, (r, e) => {
-    return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    if (options?.includeRoute ?? true) {
+      return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    }
+    return e;
   });
   let routerContent = `// This file is auto-generated
 

package/dist/index.d.cts

@@ -11,6 +11,12 @@ type GeneratorOptions = {
      * @default "" (no extension)
      */
     importExtension?: string;
+    /**
+     * Include openapi route paths in the generated router.
+     * When set to true, each route will have its openapi path
+     * @default true
+     */
+    includeRoute?: boolean;
 };
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;

package/dist/index.d.mts

@@ -11,6 +11,12 @@ type GeneratorOptions = {
      * @default "" (no extension)
      */
     importExtension?: string;
+    /**
+     * Include openapi route paths in the generated router.
+     * When set to true, each route will have its openapi path
+     * @default true
+     */
+    includeRoute?: boolean;
 };
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;

package/dist/index.d.ts

@@ -11,6 +11,12 @@ type GeneratorOptions = {
      * @default "" (no extension)
      */
     importExtension?: string;
+    /**
+     * Include openapi route paths in the generated router.
+     * When set to true, each route will have its openapi path
+     * @default true
+     */
+    includeRoute?: boolean;
 };
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;

package/dist/index.mjs

@@ -50,7 +50,10 @@ async function generateRouter(routesDir, outputFile, options) {
   const exports = await generateRoutes(files);
   const importPaths = exports.map((x) => relative(dirname(outputFile), routesDir).concat(x.path));
   const content = buildRouter(exports, (r, e) => {
-    return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    if (options?.includeRoute ?? true) {
+      return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    }
+    return e;
   });
   let routerContent = `// This file is auto-generated
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orpc-file-based-router",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "File-based router plugin for oRPC - automatically generate oRPC router from your file structure",
   "author": "zeeeeby",
   "license": "MIT",