create-cloudflare 0.0.0-e0b98fdb6 → 0.0.0-e0efb6f17

package/templates/nuxt/workers/templates/worker-configuration.d.ts

@@ -0,0 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
+interface Env {
+}

package/templates/nuxt/workers/templates/wrangler.jsonc

@@ -0,0 +1,12 @@
+{
+  "name": "<TBD>",
+  "main": "./.output/server/index.mjs",
+  "compatibility_date": "<TBD>",
+  "assets": {
+    "binding": "ASSETS",
+    "directory": "./.output/public/"
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/openapi/c3.ts

@@ -1,4 +1,6 @@
-export default {
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
 	configVersion: 1,
 	id: "openapi",
 	displayName: "API starter (OpenAPI compliant)",
@@ -8,3 +10,5 @@ export default {
 		path: "./ts",
 	},
 };
+
+export default config;

package/templates/openapi/ts/package.json

@@ -16,6 +16,6 @@
 	"devDependencies": {
 		"@types/node": "20.8.3",
 		"@types/service-worker-mock": "^2.0.1",
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/openapi/ts/worker-configuration.d.ts

@@ -1,4 +1,4 @@
 // Generated by Wrangler
-// After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
 interface Env {
 }

package/templates/openapi/ts/wrangler.jsonc

@@ -0,0 +1,8 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.ts",
+  "compatibility_date": "<TBD>",
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/pre-existing/c3.ts

@@ -6,6 +6,7 @@ import { processArgument } from "helpers/args";
 import { runCommand } from "helpers/command";
 import { detectPackageManager } from "helpers/packageManagers";
 import { chooseAccount, wranglerLogin } from "../../src/wrangler/accounts";
+import type { TemplateConfig } from "../../src/templates";
 import type { C3Context } from "types";
 
 export async function copyExistingWorkerFiles(ctx: C3Context) {
@@ -49,24 +50,25 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
 		},
 	);
 
-	// copy src/* files from the downloaded worker
+	// copy src/* files from the downloaded Worker
 	await cp(
 		join(tempdir, ctx.args.existingScript, "src"),
 		join(ctx.project.path, "src"),
 		{ recursive: true },
 	);
 
-	// copy wrangler.toml from the downloaded worker
+	// copy ./wrangler.toml from the downloaded Worker
 	await cp(
 		join(tempdir, ctx.args.existingScript, "wrangler.toml"),
 		join(ctx.project.path, "wrangler.toml"),
 	);
 }
 
-export default {
+const config: TemplateConfig = {
 	configVersion: 1,
 	id: "pre-existing",
 	displayName: "Pre-existing Worker (from Dashboard)",
+	description: "Fetch a Worker initialized from the Cloudflare dashboard.",
 	platform: "workers",
 	hidden: true,
 	copyFiles: {
@@ -79,6 +81,8 @@ export default {
 	}),
 };
 
+export default config;
+
 export interface ConfigureParams {
 	login: (ctx: C3Context) => Promise<boolean>;
 	chooseAccount: (ctx: C3Context) => Promise<void>;
@@ -96,7 +100,7 @@ export function buildConfigure(params: ConfigureParams) {
 		await params.chooseAccount(ctx);
 		await params.copyFiles(ctx);
 
-		// Force no-deploy since the worker is already deployed
+		// Force no-deploy since the Worker is already deployed
 		ctx.args.deploy = false;
 	};
 }

package/templates/pre-existing/js/package.json

@@ -8,6 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/queues/c3.ts

@@ -1,4 +1,6 @@
-export default {
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
 	configVersion: 1,
 	id: "queues",
 	displayName: "Queue consumer & producer Worker",
@@ -26,3 +28,5 @@ export default {
 		],
 	},
 };
+
+export default config;

package/templates/queues/js/package.json

@@ -8,6 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/queues/js/wrangler.jsonc

@@ -0,0 +1,21 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.js",
+  "compatibility_date": "<TBD>",
+  "observability": {
+    "enabled": true
+  },
+  "queues": {
+    "consumers": [
+      {
+        "queue": "my-queue"
+      }
+    ],
+    "producers": [
+      {
+        "binding": "MY_QUEUE",
+        "queue": "my-queue"
+      }
+    ]
+  }
+}

package/templates/queues/ts/package.json

@@ -10,6 +10,6 @@
 	},
 	"devDependencies": {
 		"typescript": "^5.5.2",
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/queues/ts/src/index.ts

@@ -8,7 +8,7 @@
  * - Open a browser tab at http://localhost:8787/ to see your worker in action
  * - Run `npm run deploy` to publish your worker
  *
- * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
+ * Bind resources to your worker in `wrangler.jsonc`. After adding bindings, a type definition for the
  * `Env` object can be regenerated with `npm run cf-typegen`.
  *
  * Learn more at https://developers.cloudflare.com/workers/

package/templates/queues/ts/worker-configuration.d.ts

@@ -1,5 +1,5 @@
 // Generated by Wrangler
-// After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
 interface Env {
 	MY_QUEUE: Queue;
 }

package/templates/queues/ts/wrangler.jsonc

@@ -0,0 +1,21 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.ts",
+  "compatibility_date": "<TBD>",
+  "observability": {
+    "enabled": true
+  },
+  "queues": {
+    "consumers": [
+      {
+        "queue": "my-queue"
+      }
+    ],
+    "producers": [
+      {
+        "binding": "MY_QUEUE",
+        "queue": "my-queue"
+      }
+    ]
+  }
+}

package/templates/qwik/c3.ts

@@ -1,147 +1,9 @@
-import { endSection } from "@cloudflare/cli";
-import { brandColor } from "@cloudflare/cli/colors";
-import { spinner } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "frameworks/index";
-import { loadTemplateSnippets, transformFile } from "helpers/codemod";
-import { quoteShellArgs, runCommand } from "helpers/command";
-import { usesTypescript } from "helpers/files";
-import { detectPackageManager } from "helpers/packageManagers";
-import * as recast from "recast";
-import type { TemplateConfig } from "../../src/templates";
-import type { C3Context } from "types";
+import pages from "./pages/c3";
+import workers from "./workers/c3";
+import type { MultiPlatformTemplateConfig } from "../../src/templates";
 
-const { npm, npx } = detectPackageManager();
-
-const generate = async (ctx: C3Context) => {
-	await runFrameworkGenerator(ctx, ["playground", ctx.project.name]);
-};
-
-const configure = async (ctx: C3Context) => {
-	// Add the pages integration
-	const cmd = [npx, "qwik", "add", "cloudflare-pages"];
-	endSection(`Running ${quoteShellArgs(cmd)}`);
-	await runCommand(cmd);
-
-	addBindingsProxy(ctx);
-	populateCloudflareEnv();
-};
-
-const addBindingsProxy = (ctx: C3Context) => {
-	// Qwik only has a typescript template atm.
-	// This check is an extra precaution
-	if (!usesTypescript(ctx)) {
-		return;
-	}
-
-	const s = spinner();
-	s.start("Updating `vite.config.ts`");
-
-	const snippets = loadTemplateSnippets(ctx);
-	const b = recast.types.builders;
-
-	transformFile("vite.config.ts", {
-		// Insert the env declaration after the last import (but before the rest of the body)
-		visitProgram: function (n) {
-			const lastImportIndex = n.node.body.findLastIndex(
-				(t) => t.type === "ImportDeclaration",
-			);
-			const lastImport = n.get("body", lastImportIndex);
-			lastImport.insertAfter(...snippets.getPlatformProxyTs);
-
-			return this.traverse(n);
-		},
-		// Pass the `platform` object from the declaration to the `qwikCity` plugin
-		visitCallExpression: function (n) {
-			const callee = n.node.callee as recast.types.namedTypes.Identifier;
-			if (callee.name !== "qwikCity") {
-				return this.traverse(n);
-			}
-
-			// The config object passed to `qwikCity`
-			const configArgument = n.node.arguments[0] as
-				| recast.types.namedTypes.ObjectExpression
-				| undefined;
-
-			const platformPropery = b.objectProperty.from({
-				key: b.identifier("platform"),
-				value: b.identifier("platform"),
-				shorthand: true,
-			});
-
-			if (!configArgument) {
-				n.node.arguments = [b.objectExpression([platformPropery])];
-
-				return false;
-			}
-
-			if (configArgument.type !== "ObjectExpression") {
-				throw new Error("Failed to update `vite.config.ts`");
-			}
-
-			// Add the `platform` object to the object
-			configArgument.properties.push(platformPropery);
-
-			return false;
-		},
-	});
-
-	s.stop(`${brandColor("updated")} \`vite.config.ts\``);
-};
-
-const populateCloudflareEnv = () => {
-	const entrypointPath = "src/entry.cloudflare-pages.tsx";
-
-	const s = spinner();
-	s.start(`Updating \`${entrypointPath}\``);
-
-	transformFile(entrypointPath, {
-		visitTSInterfaceDeclaration: function (n) {
-			const b = recast.types.builders;
-			const id = n.node.id as recast.types.namedTypes.Identifier;
-			if (id.name !== "QwikCityPlatform") {
-				this.traverse(n);
-			}
-
-			const newBody = [
-				["env", "Env"],
-				// Qwik doesn't supply `cf` to the platform object. Should they do so, uncomment this
-				// ["cf", "CfProperties"],
-			].map(([varName, type]) =>
-				b.tsPropertySignature(
-					b.identifier(varName),
-					b.tsTypeAnnotation(b.tsTypeReference(b.identifier(type))),
-				),
-			);
-
-			n.node.body.body = newBody;
-
-			return false;
-		},
-	});
-
-	s.stop(`${brandColor("updated")} \`${entrypointPath}\``);
-};
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "qwik",
-	frameworkCli: "create-qwik",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Qwik",
-	platform: "pages",
-	copyFiles: {
-		path: "./templates",
-	},
-	generate,
-	configure,
-	transformPackageJson: async () => ({
-		scripts: {
-			deploy: `${npm} run build && wrangler pages deploy`,
-			preview: `${npm} run build && wrangler pages dev`,
-			"cf-typegen": `wrangler types`,
-		},
-	}),
-	devScript: "dev",
-	deployScript: "deploy",
-	previewScript: "preview",
+	platformVariants: { pages, workers },
 };
 export default config;

package/templates/qwik/pages/c3.ts

@@ -0,0 +1,149 @@
+import { endSection } from "@cloudflare/cli";
+import { brandColor } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { loadTemplateSnippets, transformFile } from "helpers/codemod";
+import { quoteShellArgs, runCommand } from "helpers/command";
+import { usesTypescript } from "helpers/files";
+import { detectPackageManager } from "helpers/packageManagers";
+import * as recast from "recast";
+import type { TemplateConfig } from "../../../src/templates";
+import type { C3Context } from "types";
+
+const { npm, npx, name } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, ["playground", ctx.project.name]);
+};
+
+const configure = async (ctx: C3Context) => {
+	// Add the pages integration
+	// For some reason `pnpx qwik add` fails for qwik so we use `pnpm qwik add` instead.
+	const cmd = [name === "pnpm" ? npm : npx, "qwik", "add", "cloudflare-pages"];
+	endSection(`Running ${quoteShellArgs(cmd)}`);
+	await runCommand(cmd);
+
+	addBindingsProxy(ctx);
+	populateCloudflareEnv();
+};
+
+const addBindingsProxy = (ctx: C3Context) => {
+	// Qwik only has a typescript template atm.
+	// This check is an extra precaution
+	if (!usesTypescript(ctx)) {
+		return;
+	}
+
+	const s = spinner();
+	s.start("Updating `vite.config.ts`");
+
+	const snippets = loadTemplateSnippets(ctx);
+	const b = recast.types.builders;
+
+	transformFile("vite.config.ts", {
+		// Insert the env declaration after the last import (but before the rest of the body)
+		visitProgram: function (n) {
+			const lastImportIndex = n.node.body.findLastIndex(
+				(t) => t.type === "ImportDeclaration",
+			);
+			const lastImport = n.get("body", lastImportIndex);
+			lastImport.insertAfter(...snippets.getPlatformProxyTs);
+
+			return this.traverse(n);
+		},
+		// Pass the `platform` object from the declaration to the `qwikCity` plugin
+		visitCallExpression: function (n) {
+			const callee = n.node.callee as recast.types.namedTypes.Identifier;
+			if (callee.name !== "qwikCity") {
+				return this.traverse(n);
+			}
+
+			// The config object passed to `qwikCity`
+			const configArgument = n.node.arguments[0] as
+				| recast.types.namedTypes.ObjectExpression
+				| undefined;
+
+			const platformPropery = b.objectProperty.from({
+				key: b.identifier("platform"),
+				value: b.identifier("platform"),
+				shorthand: true,
+			});
+
+			if (!configArgument) {
+				n.node.arguments = [b.objectExpression([platformPropery])];
+
+				return false;
+			}
+
+			if (configArgument.type !== "ObjectExpression") {
+				throw new Error("Failed to update `vite.config.ts`");
+			}
+
+			// Add the `platform` object to the object
+			configArgument.properties.push(platformPropery);
+
+			return false;
+		},
+	});
+
+	s.stop(`${brandColor("updated")} \`vite.config.ts\``);
+};
+
+const populateCloudflareEnv = () => {
+	const entrypointPath = "src/entry.cloudflare-pages.tsx";
+
+	const s = spinner();
+	s.start(`Updating \`${entrypointPath}\``);
+
+	transformFile(entrypointPath, {
+		visitTSInterfaceDeclaration: function (n) {
+			const b = recast.types.builders;
+			const id = n.node.id as recast.types.namedTypes.Identifier;
+			if (id.name !== "QwikCityPlatform") {
+				this.traverse(n);
+			}
+
+			const newBody = [
+				["env", "Env"],
+				// Qwik doesn't supply `cf` to the platform object. Should they do so, uncomment this
+				// ["cf", "CfProperties"],
+			].map(([varName, type]) =>
+				b.tsPropertySignature(
+					b.identifier(varName),
+					b.tsTypeAnnotation(b.tsTypeReference(b.identifier(type))),
+				),
+			);
+
+			n.node.body.body = newBody;
+
+			return false;
+		},
+	});
+
+	s.stop(`${brandColor("updated")} \`${entrypointPath}\``);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "qwik",
+	frameworkCli: "create-qwik",
+	displayName: "Qwik",
+	platform: "pages",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates/qwik/pages",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler pages deploy`,
+			preview: `${npm} run build && wrangler pages dev`,
+			"cf-typegen": `wrangler types`,
+		},
+	}),
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates/qwik/pages/templates/worker-configuration.d.ts

@@ -0,0 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
+interface Env {
+}

package/templates/qwik/pages/templates/wrangler.jsonc

@@ -0,0 +1,8 @@
+{
+  "name": "<TBD>",
+  "compatibility_date": "<TBD>",
+  "compatibility_flags": [
+    "nodejs_compat"
+  ],
+  "pages_build_output_dir": "./dist"
+}

package/{templates-experimental/qwik → templates/qwik/workers}/c3.ts

@@ -7,10 +7,10 @@ import { quoteShellArgs, runCommand } from "helpers/command";
 import { removeFile, usesTypescript } from "helpers/files";
 import { detectPackageManager } from "helpers/packageManagers";
 import * as recast from "recast";
-import type { TemplateConfig } from "../../src/templates";
+import type { TemplateConfig } from "../../../src/templates";
 import type { C3Context } from "types";
 
-const { npm, npx } = detectPackageManager();
+const { npm, npx, name } = detectPackageManager();
 
 const generate = async (ctx: C3Context) => {
 	await runFrameworkGenerator(ctx, ["playground", ctx.project.name]);
@@ -18,7 +18,8 @@ const generate = async (ctx: C3Context) => {
 
 const configure = async (ctx: C3Context) => {
 	// Add the pages integration
-	const cmd = [npx, "qwik", "add", "cloudflare-pages"];
+	// For some reason `pnpx qwik add` fails for qwik so we use `pnpm qwik add` instead.
+	const cmd = [name === "pnpm" ? npm : npx, "qwik", "add", "cloudflare-pages"];
 	endSection(`Running ${quoteShellArgs(cmd)}`);
 	await runCommand(cmd);
 
@@ -136,7 +137,7 @@ const config: TemplateConfig = {
 	copyFiles: {
 		path: "./templates",
 	},
-	path: "templates-experimental/qwik",
+	path: "templates/qwik/workers",
 	generate,
 	configure,
 	transformPackageJson: async () => ({

package/templates/qwik/workers/templates/worker-configuration.d.ts

@@ -0,0 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
+interface Env {
+}

package/templates/qwik/workers/templates/wrangler.jsonc

@@ -0,0 +1,15 @@
+{
+  "name": "<TBD>",
+  "main": "./dist/_worker.js",
+  "compatibility_date": "<TBD>",
+  "compatibility_flags": [
+    "nodejs_compat"
+  ],
+  "assets": {
+    "binding": "ASSET",
+    "directory": "./dist"
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/react/c3.ts

@@ -1,61 +1,9 @@
-import { logRaw } from "@cloudflare/cli";
-import { inputPrompt } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "frameworks/index";
-import { detectPackageManager } from "helpers/packageManagers";
-import type { TemplateConfig } from "../../src/templates";
-import type { C3Context } from "types";
+import pages from "./pages/c3";
+import workers from "./workers/c3";
+import type { MultiPlatformTemplateConfig } from "../../src/templates";
 
-const { npm } = detectPackageManager();
-
-const generate = async (ctx: C3Context) => {
-	const variant = await inputPrompt({
-		type: "select",
-		question: "Select a variant:",
-		label: "variant",
-		options: variantsOptions,
-		defaultValue: variantsOptions[0].value,
-	});
-
-	await runFrameworkGenerator(ctx, [ctx.project.name, "--template", variant]);
-
-	logRaw("");
-};
-
-const variantsOptions = [
-	{
-		value: "react-ts",
-		label: "TypeScript",
-	},
-	{
-		value: "react-swc-ts",
-		label: "TypeScript + SWC",
-	},
-	{
-		value: "react",
-		label: "JavaScript",
-	},
-	{
-		value: "react-swc",
-		label: "JavaScript + SWC",
-	},
-];
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "react",
-	// React's documentation now recommends using create-vite.
-	frameworkCli: "create-vite",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "React",
-	platform: "pages",
-	generate,
-	transformPackageJson: async () => ({
-		scripts: {
-			deploy: `${npm} run build && wrangler pages deploy ./dist`,
-			preview: `${npm} run build && wrangler pages dev ./dist`,
-		},
-	}),
-	devScript: "dev",
-	deployScript: "deploy",
-	previewScript: "preview",
+	platformVariants: { pages, workers },
 };
 export default config;