Plugin for Elysia which autoload all routes in directory and code-generate types for Eden with Bun.build support!
Start new project with create-elysiajs
bun create elysiajs <directory-name>and select Autoload in plugins
bun install elysia-autoloadimport { Elysia } from "elysia";
import { autoload } from "elysia-autoload";
const app = new Elysia().use(await autoload()).listen(3000);
export type ElysiaApp = typeof app;// routes/index.ts
import type { ElysiaApp } from "app";
export default (app: ElysiaApp) => app.get("", { hello: "world" });Guide how elysia-autoload match routes
├── app.ts
├── routes
├── index.ts // index routes
├── posts
├── index.ts
└── [id].ts // dynamic params
├── likes
└── [...].ts // wildcard
├── domains
├── @[...] // wildcard with @ prefix
└──index.ts
├── frontend
└──index.tsx // usage of tsx extension
├── events
└──(post).ts // post and get will not be in the link
└──(get).ts
└── users.ts
└── package.json
- /routes/index.ts → /
- /routes/posts/index.ts → /posts
- /routes/posts/[id].ts → /posts/:id
- /routes/users.ts → /users
- /routes/likes/[...].ts → /likes/*
- /routes/domains/@[...]/index.ts → /domains/@*
- /routes/frontend/index.tsx → /frontend
- /routes/events/(post).ts → /events
- /routes/events/(get).ts → /events
| Key | Type | Default | Description |
|---|---|---|---|
| pattern? | string | "**/*.{ts,tsx,js,jsx,mjs,cjs}" | Glob patterns |
| dir? | string | "./routes" | The folder where routes are located |
| prefix? | string | Prefix for routes | |
| types? | boolean | Types Options | false | Options to configure type code-generation. if boolean - enables/disables generation |
| schema? | Function | Handler for providing routes guard schema |
| Key | Type | Default | Description |
|---|---|---|---|
| output? | string | string[] | "./routes-types.ts" | Type code-generation output. It can be an array |
| typeName? | string | "Routes" | Name for code-generated global type for Eden |
| useExport? | boolean | false | Use export instead of global type |
Usage of types code-generation for Eden
// app.ts
import { Elysia } from "elysia";
import { autoload } from "elysia-autoload";
const app = new Elysia()
.use(
await autoload({
types: {
output: "./routes.ts",
typeName: "Routes",
}, // or pass true for use default params
})
)
.listen(3000);
export type ElysiaApp = typeof app;// client.ts
import { treaty } from "@elysiajs/eden";
// Routes are a global type so you don't need to import it.
const app = treaty<Routes>("http://localhost:3002");
const { data } = await app.test["some-path-param"].get({
query: {
key: 2,
},
});
console.log(data);routes.ts will be:
// @filename: routes.ts
import type { ElysiaWithBaseUrl } from "elysia-autoload";
import type Route0 from "./routes/index";
import type Route1 from "./routes/test/[some]/index";
declare global {
export type Routes = ElysiaWithBaseUrl<"/api", typeof Route0> &
ElysiaWithBaseUrl<"/api/test/:some", typeof Route1>;
}Example of app with types code-generation you can see in example
Bun build usage
You can use this plugin with Bun.build, thanks to esbuild-plugin-autoload!
// @filename: build.ts
import { autoload } from "esbuild-plugin-autoload"; // default import also supported
await Bun.build({
entrypoints: ["src/index.ts"],
target: "bun",
outdir: "out",
plugins: [autoload()],
}).then(console.log);Then, build it with bun build.ts and run with bun out/index.ts.
Bun compile usage
You can bundle and then compile it into a single executable binary file
import { autoload } from "esbuild-plugin-autoload"; // default import also supported
await Bun.build({
entrypoints: ["src/index.ts"],
target: "bun",
outdir: "out",
plugins: [autoload()],
}).then(console.log);
await Bun.$`bun build --compile out/index.js`;Warning
You cannot use it in bun build --compile mode without extra step (Feature issue)
import swagger from "@elysiajs/swagger";
import Elysia from "elysia";
import { autoload } from "elysia-autoload";
const app = new Elysia()
.use(
await autoload({
schema: ({ path, url }) => {
const tag = url.split("/").at(1)!;
return {
beforeHandle: ({ request }) => {
console.log(request.url);
},
detail: {
description: `Route autoloaded from ${path}`,
tags: [tag],
},
};
},
})
)
.use(swagger());
export type ElysiaApp = typeof app;
app.listen(3001, console.log);