feat(create-cloudflare): Update openapi template to include better ts types and lint command (#7796)

* Update openapi C3 template

* Update .changeset/perfect-geckos-tell.md

Co-authored-by: Pete Bacon Darwin <[email protected]>

---------

Co-authored-by: Pete Bacon Darwin <[email protected]>

Author: G4brym

.changeset/perfect-geckos-tell.md

@@ -0,0 +1,5 @@
+---
+"create-cloudflare": patch
+---
+
+Update openapi C3 template to include better ts types and lint command

packages/create-cloudflare/templates/openapi/ts/.gitignore

@@ -169,3 +169,4 @@ dist
 # wrangler project
 
 .dev.vars
+.wrangler/

packages/create-cloudflare/templates/openapi/ts/package.json

@@ -9,13 +9,14 @@
 		"cf-typegen": "wrangler types"
 	},
 	"dependencies": {
-		"chanfana": "^2.0.2",
-		"zod": "^3.23.8",
-		"hono": "^4.4.7"
+		"chanfana": "^2.6.3",
+		"hono": "^4.6.20",
+		"zod": "^3.24.1"
 	},
 	"devDependencies": {
-		"@types/node": "20.8.3",
-		"@types/service-worker-mock": "^2.0.1",
-		"wrangler": "^3.101.0"
+		"@cloudflare/workers-types": "^4.20250129.0",
+		"@types/node": "22.13.0",
+		"@types/service-worker-mock": "^2.0.4",
+		"wrangler": "^3.107.2"
 	}
 }

packages/create-cloudflare/templates/openapi/ts/src/endpoints/taskCreate.ts

@@ -1,6 +1,6 @@
 import { Bool, OpenAPIRoute } from "chanfana";
 import { z } from "zod";
-import { Task } from "../types";
+import { type AppContext, Task } from "../types";
 
 export class TaskCreate extends OpenAPIRoute {
 	schema = {
@@ -34,7 +34,7 @@ export class TaskCreate extends OpenAPIRoute {
 		},
 	};
 
-	async handle(c) {
+	async handle(c: AppContext) {
 		// Get validated data
 		const data = await this.getValidatedData<typeof this.schema>();
 

packages/create-cloudflare/templates/openapi/ts/src/endpoints/taskDelete.ts

@@ -1,6 +1,6 @@
 import { Bool, OpenAPIRoute, Str } from "chanfana";
 import { z } from "zod";
-import { Task } from "../types";
+import { type AppContext, Task } from "../types";
 
 export class TaskDelete extends OpenAPIRoute {
 	schema = {
@@ -30,7 +30,7 @@ export class TaskDelete extends OpenAPIRoute {
 		},
 	};
 
-	async handle(c) {
+	async handle(c: AppContext) {
 		// Get validated data
 		const data = await this.getValidatedData<typeof this.schema>();
 

packages/create-cloudflare/templates/openapi/ts/src/endpoints/taskFetch.ts

@@ -1,6 +1,6 @@
 import { Bool, OpenAPIRoute, Str } from "chanfana";
 import { z } from "zod";
-import { Task } from "../types";
+import { type AppContext, Task } from "../types";
 
 export class TaskFetch extends OpenAPIRoute {
 	schema = {
@@ -43,7 +43,7 @@ export class TaskFetch extends OpenAPIRoute {
 		},
 	};
 
-	async handle(c) {
+	async handle(c: AppContext) {
 		// Get validated data
 		const data = await this.getValidatedData<typeof this.schema>();
 

packages/create-cloudflare/templates/openapi/ts/src/endpoints/taskList.ts

@@ -1,6 +1,6 @@
 import { Bool, Num, OpenAPIRoute } from "chanfana";
 import { z } from "zod";
-import { Task } from "../types";
+import { type AppContext, Task } from "../types";
 
 export class TaskList extends OpenAPIRoute {
 	schema = {
@@ -37,7 +37,7 @@ export class TaskList extends OpenAPIRoute {
 		},
 	};
 
-	async handle(c) {
+	async handle(c: AppContext) {
 		// Get validated data
 		const data = await this.getValidatedData<typeof this.schema>();
 

packages/create-cloudflare/templates/openapi/ts/src/index.ts

@@ -6,7 +6,7 @@ import { TaskFetch } from "./endpoints/taskFetch";
 import { TaskList } from "./endpoints/taskList";
 
 // Start a Hono app
-const app = new Hono();
+const app = new Hono<{ Bindings: Env }>();
 
 // Setup OpenAPI registry
 const openapi = fromHono(app, {
@@ -19,5 +19,8 @@ openapi.post("/api/tasks", TaskCreate);
 openapi.get("/api/tasks/:taskSlug", TaskFetch);
 openapi.delete("/api/tasks/:taskSlug", TaskDelete);
 
+// You may also register routes for non OpenAPI directly on Hono
+// app.get('/test', (c) => c.text('Hono!'))
+
 // Export the Hono app
 export default app;

packages/create-cloudflare/templates/openapi/ts/src/types.ts

@@ -1,6 +1,9 @@
 import { DateTime, Str } from "chanfana";
+import type { Context } from "hono";
 import { z } from "zod";
 
+export type AppContext = Context<{ Bindings: Env }>;
+
 export const Task = z.object({
 	name: Str({ example: "lorem" }),
 	slug: Str(),

packages/create-cloudflare/templates/openapi/ts/tsconfig.json

@@ -1,32 +1,30 @@
 {
 	"compilerOptions": {
-		"allowJs": true,
-		"allowSyntheticDefaultImports": true,
-		"baseUrl": "src",
-		"declaration": true,
-		"sourceMap": true,
+		/* Base Options: */
 		"esModuleInterop": true,
-		"inlineSourceMap": false,
-		"lib": ["esnext"],
-		"listEmittedFiles": false,
-		"listFiles": false,
-		"moduleResolution": "node",
-		"noFallthroughCasesInSwitch": true,
-		"pretty": true,
-		"resolveJsonModule": true,
-		"rootDir": ".",
 		"skipLibCheck": true,
-		"strict": false,
-		"traceResolution": false,
-		"outDir": "",
-		"target": "esnext",
-		"module": "esnext",
+		"target": "es2022",
+		"verbatimModuleSyntax": false,
+		"allowJs": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		/* Strictness */
+		"noImplicitAny": false,
+		"noImplicitThis": true,
+		"strictNullChecks": false,
+		"strict": true,
+		"noUncheckedIndexedAccess": true,
+		/* If NOT transpiling with TypeScript: */
+		"moduleResolution": "Bundler",
+		"module": "es2022",
+		"noEmit": true,
+		"lib": ["es2022"],
 		"types": [
 			"@types/node",
 			"@types/service-worker-mock",
 			"@cloudflare/workers-types"
 		]
 	},
 	"exclude": ["node_modules", "dist", "tests"],
-	"include": ["src", "scripts"]
+	"include": ["src", "worker-configuration.d.ts"]
 }