Cloudflare Project (Hono + TypeScript)
Rules
- Bootstrap every new project with Cloudflare C3 via npx, using TypeScript and Hono:
npx create-cloudflare@latest <project-name> --framework=hono --lang=ts. - Use
wrangler.jsoncas the Wrangler config file (not TOML), and keep bindings plus compatibility settings as the source of truth there. - Keep TypeScript at strictest settings: extend
@tsconfig/strictest/tsconfig.json(or equivalent strictest flags) and do not relax strict options. - Generate runtime and binding types with
npx wrangler types; include./worker-configuration.d.tsintsconfig.jsonand rerun after anywrangler.jsoncchange. - Do not define routes inline in the worker entrypoint; each route must be a named function in route modules grouped by domain (for example
src/routes/auth.ts) and then mounted fromsrc/index.ts. - If the project includes a UI framework, use Rsbuild to build the frontend artifact.
- Use Oxlint for both prettier-style formatting checks and lint checks.
- Use
tsgofor type checking.
Example 1: Bootstrap + strict typing + Wrangler types
npx create-cloudflare@latest my-api --framework=hono --lang=ts
cd my-api
npm i -D @tsconfig/strictest
npx wrangler types// tsconfig.json
{
"extends": "@tsconfig/strictest/tsconfig.json",
"compilerOptions": {
"types": ["./worker-configuration.d.ts"]
}
}Example 2: Grouped route functions (routes/auth.ts)
// src/routes/auth.ts
import { Hono } from "hono";
import type { Context } from "hono";
type AppEnv = { Bindings: Env };
const auth = new Hono<AppEnv>();
async function login(c: Context<AppEnv>) {
return c.json({ ok: true });
}
async function logout(c: Context<AppEnv>) {
return c.json({ ok: true });
}
auth.post("/login", login);
auth.post("/logout", logout);
export function registerAuthRoutes(app: Hono<AppEnv>) {
app.route("/auth", auth);
}// src/index.ts
import { Hono } from "hono";
import { registerAuthRoutes } from "./routes/auth";
const app = new Hono<{ Bindings: Env }>();
registerAuthRoutes(app);
export default app;Example 3: Rsbuild + Oxlint + tsgo scripts
// package.json
{
"scripts": {
"build:ui": "rsbuild build",
"lint": "oxlint .",
"format:check": "oxlint .",
"typecheck": "tsgo"
}
}