create-cloudflare 0.0.0-d1cdcff3 → 0.0.0-d1d5b5313

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

@@ -1,16 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
 interface Env {
-	// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
-	// MY_KV_NAMESPACE: KVNamespace;
-	//
-	// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
-	// MY_DURABLE_OBJECT: DurableObjectNamespace;
-	//
-	// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
-	// MY_BUCKET: R2Bucket;
-	//
-	// Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
-	// MY_SERVICE: Fetcher;
-	//
-	// Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
-	// MY_QUEUE: Queue;
 }

package/templates/common/ts/wrangler.jsonc

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

package/templates/docusaurus/c3.ts

@@ -1,27 +1,9 @@
-import { runFrameworkGenerator } from "helpers/command";
-import { compatDateFlag } from "helpers/files";
-import { detectPackageManager } from "helpers/packages";
-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) => {
-	await runFrameworkGenerator(ctx, [ctx.project.name, "classic"]);
-};
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "docusaurus",
-	platform: "pages",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Docusaurus",
-	generate,
-	transformPackageJson: async () => ({
-		scripts: {
-			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --proxy 3000 -- ${npm} run start`,
-			"pages:deploy": `${npm} run build && wrangler pages deploy ./build`,
-		},
-	}),
-	testFlags: [`--package-manager`, npm],
+	platformVariants: { pages, workers },
 };
 export default config;

package/templates/docusaurus/pages/c3.ts

@@ -0,0 +1,30 @@
+import { runFrameworkGenerator } from "frameworks/index";
+import { detectPackageManager } from "helpers/packageManagers";
+import type { TemplateConfig } from "../../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name, "classic"]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "docusaurus",
+	frameworkCli: "create-docusaurus",
+	platform: "pages",
+	displayName: "Docusaurus",
+	path: "templates/docusaurus/pages",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			preview: `${npm} run build && wrangler pages dev ./build`,
+			deploy: `${npm} run build && wrangler pages deploy ./build`,
+		},
+	}),
+	devScript: "preview",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates/docusaurus/workers/c3.ts

@@ -0,0 +1,33 @@
+import { runFrameworkGenerator } from "frameworks/index";
+import { detectPackageManager } from "helpers/packageManagers";
+import type { TemplateConfig } from "../../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name, "classic"]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "docusaurus",
+	frameworkCli: "create-docusaurus",
+	platform: "workers",
+	displayName: "Docusaurus",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates/docusaurus/workers",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler deploy`,
+			preview: `${npm} run build && wrangler dev`,
+		},
+	}),
+	devScript: "start",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates/docusaurus/workers/templates/wrangler.jsonc

@@ -0,0 +1,10 @@
+{
+  "name": "<TBD>",
+  "compatibility_date": "<TBD>",
+  "assets": {
+    "directory": "./build"
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/gatsby/c3.ts

@@ -1,7 +1,6 @@
 import { inputPrompt } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "helpers/command";
-import { compatDateFlag } from "helpers/files";
-import { detectPackageManager } from "helpers/packages";
+import { runFrameworkGenerator } from "frameworks/index";
+import { detectPackageManager } from "helpers/packageManagers";
 import type { TemplateConfig } from "../../src/templates";
 import type { C3Context } from "types";
 
@@ -33,14 +32,18 @@ const generate = async (ctx: C3Context) => {
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "gatsby",
+	frameworkCli: "gatsby",
 	platform: "pages",
 	displayName: "Gatsby",
 	generate,
 	transformPackageJson: async () => ({
 		scripts: {
-			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --proxy 8000 -- ${npm} run develop`,
-			"pages:deploy": `${npm} run build && wrangler pages deploy ./public`,
+			deploy: `${npm} run build && wrangler pages deploy ./public`,
+			preview: `${npm} run build && wrangler pages dev ./public`,
 		},
 	}),
+	devScript: "develop",
+	deployScript: "deploy",
+	previewScript: "preview",
 };
 export default config;

package/templates/hello-world/c3.ts

@@ -1,15 +1,36 @@
+import { readFile, writeFile } from "node:fs/promises";
+import { resolve } from "node:path";
+import type { TemplateConfig } from "../../src/templates";
+
 export default {
 	configVersion: 1,
 	id: "hello-world",
-	displayName: '"Hello World" Worker',
+	displayName: "Hello World Worker",
+	description: "Get started with a basic Worker in the language of your choice",
 	platform: "workers",
-	languages: ["js", "ts"],
+	async configure(ctx) {
+		if (ctx.args.lang === "python") {
+			for (const file of ["pyproject.toml", "uv.lock"]) {
+				const contents = await readFile(
+					resolve(ctx.project.path, file),
+					"utf8",
+				);
+				const updated = contents.replaceAll(/<TBD>/g, ctx.project.name);
+				await writeFile(resolve(ctx.project.path, file), updated);
+			}
+		}
+	},
 	copyFiles: {
-		js: {
-			path: "./js",
-		},
-		ts: {
-			path: "./ts",
+		variants: {
+			js: {
+				path: "./js",
+			},
+			ts: {
+				path: "./ts",
+			},
+			python: {
+				path: "./py",
+			},
 		},
 	},
-};
+} satisfies TemplateConfig;

package/templates/hello-world/js/.editorconfig

@@ -3,7 +3,6 @@ root = true
 
 [*]
 indent_style = tab
-tab_width = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

package/templates/hello-world/js/package.json

@@ -5,9 +5,12 @@
 	"scripts": {
 		"deploy": "wrangler deploy",
 		"dev": "wrangler dev",
-		"start": "wrangler dev"
+		"start": "wrangler dev",
+		"test": "vitest"
 	},
 	"devDependencies": {
-		"wrangler": "^3.0.0"
+		"@cloudflare/vitest-pool-workers": "^0.6.4",
+		"wrangler": "^3.101.0",
+		"vitest": "~2.1.9"
 	}
 }

package/templates/hello-world/js/test/index.spec.js

@@ -0,0 +1,20 @@
+import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
+import { describe, it, expect } from 'vitest';
+import worker from '../src';
+
+describe('Hello World worker', () => {
+	it('responds with Hello World! (unit style)', async () => {
+		const request = new Request('http://example.com');
+		// Create an empty context to pass to `worker.fetch()`.
+		const ctx = createExecutionContext();
+		const response = await worker.fetch(request, env, ctx);
+		// Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
+		await waitOnExecutionContext(ctx);
+		expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
+	});
+
+	it('responds with Hello World! (integration style)', async () => {
+		const response = await SELF.fetch('http://example.com');
+		expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
+	});
+});

package/templates/hello-world/js/vitest.config.js

@@ -0,0 +1,11 @@
+import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
+
+export default defineWorkersConfig({
+	test: {
+		poolOptions: {
+			workers: {
+				wrangler: { configPath: './wrangler.jsonc' },
+			},
+		},
+	},
+});

package/templates/hello-world/js/wrangler.jsonc

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

package/templates/hello-world/py/.python-version

@@ -0,0 +1 @@
+3.12

package/templates/hello-world/py/README.md

@@ -0,0 +1,23 @@
+## Usage
+
+You can run the worker defined by your new project by executing `wrangler dev` in this
+directory. This will start up an HTTP server and will allow you to iterate on your
+worker without having to restart `wrangler`.
+
+### Types and autocomplete
+
+This project also includes a pyproject.toml and uv.lock file with some requirements which
+set up autocomplete and type hints for this Python Workers project.
+
+To get these installed you'll need `uv`, which you can install by following
+https://docs.astral.sh/uv/getting-started/installation/.
+
+Once `uv` is installed, you can run the following:
+
+```
+uv venv
+uv sync
+```
+
+Then point your editor's Python plugin at the `.venv` directory. You should then have working
+autocomplete and type information in your editor.

package/templates/hello-world/py/__dot__gitignore

@@ -0,0 +1,68 @@
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+\*.pid.lock
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# public
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# wrangler project
+
+.dev.vars
+.wrangler/

package/templates/hello-world/py/package.json

@@ -0,0 +1,13 @@
+{
+	"name": "<TBD>",
+	"version": "0.0.0",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
+		"start": "wrangler dev"
+	},
+	"devDependencies": {
+		"wrangler": "^3.101.0"
+	}
+}

package/templates/hello-world/py/pyproject.toml

@@ -0,0 +1,9 @@
+[project]
+name = "<TBD>"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "webtypy>=0.1.7",
+]

package/templates/hello-world/py/src/entry.py

@@ -0,0 +1,4 @@
+from js import Response
+
+async def on_fetch(request, env):
+    return Response.new("Hello World!")

package/templates/hello-world/py/uv.lock

@@ -0,0 +1,22 @@
+version = 1
+requires-python = ">=3.12"
+
+[[package]]
+name = "<TBD>"
+version = "0.1.0"
+source = { virtual = "." }
+dependencies = [
+    { name = "webtypy" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "webtypy", specifier = ">=0.1.7" }]
+
+[[package]]
+name = "webtypy"
+version = "0.1.7"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/5e/89/c7a0311fdc73809fc2415be97767f085ff3e00c86546430034dc8465fee7/webtypy-0.1.7.tar.gz", hash = "sha256:1b7212719a949c802f3d60fac5f0d952eb503a92121409cf1ad9847d7c76a336", size = 104505 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/61/91/c731bdaa605279e00b28bfd2bf0ae67f48061d16890fb1c026924bfbd242/webtypy-0.1.7-py3-none-any.whl", hash = "sha256:f35e6d73a4e08783e23adfac271a11cda3a2bd1105499db70e4819244efed0ae", size = 103519 },
+]

package/templates/hello-world/py/wrangler.jsonc

@@ -0,0 +1,9 @@
+{
+	"name": "<TBD>",
+	"main": "src/entry.py",
+	"compatibility_date": "<TBD>",
+	"compatibility_flags": ["python_workers"],
+	"observability": {
+		"enabled": true,
+	},
+}

package/templates/hello-world/ts/.editorconfig

@@ -3,7 +3,6 @@ root = true
 
 [*]
 indent_style = tab
-tab_width = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

package/templates/hello-world/ts/package.json

@@ -5,10 +5,14 @@
 	"scripts": {
 		"deploy": "wrangler deploy",
 		"dev": "wrangler dev",
-		"start": "wrangler dev"
+		"start": "wrangler dev",
+		"test": "vitest",
+		"cf-typegen": "wrangler types"
 	},
 	"devDependencies": {
-		"typescript": "^5.0.4",
-		"wrangler": "^3.0.0"
+		"@cloudflare/vitest-pool-workers": "^0.6.4",
+		"typescript": "^5.5.2",
+		"vitest": "~2.1.9",
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/hello-world/ts/src/index.ts

@@ -5,28 +5,14 @@
  * - 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.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/
  */
 
-export interface Env {
-	// Example binding to KV. Learn more at https://developers.cloudflare.com/workers/runtime-apis/kv/
-	// MY_KV_NAMESPACE: KVNamespace;
-	//
-	// Example binding to Durable Object. Learn more at https://developers.cloudflare.com/workers/runtime-apis/durable-objects/
-	// MY_DURABLE_OBJECT: DurableObjectNamespace;
-	//
-	// Example binding to R2. Learn more at https://developers.cloudflare.com/workers/runtime-apis/r2/
-	// MY_BUCKET: R2Bucket;
-	//
-	// Example binding to a Service. Learn more at https://developers.cloudflare.com/workers/runtime-apis/service-bindings/
-	// MY_SERVICE: Fetcher;
-	//
-	// Example binding to a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
-	// MY_QUEUE: Queue;
-}
-
 export default {
-	async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+	async fetch(request, env, ctx): Promise<Response> {
 		return new Response('Hello World!');
 	},
-};
+} satisfies ExportedHandler<Env>;

package/templates/hello-world/ts/test/index.spec.ts

@@ -0,0 +1,25 @@
+// test/index.spec.ts
+import { env, createExecutionContext, waitOnExecutionContext, SELF } from 'cloudflare:test';
+import { describe, it, expect } from 'vitest';
+import worker from '../src/index';
+
+// For now, you'll need to do something like this to get a correctly-typed
+// `Request` to pass to `worker.fetch()`.
+const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
+
+describe('Hello World worker', () => {
+	it('responds with Hello World! (unit style)', async () => {
+		const request = new IncomingRequest('http://example.com');
+		// Create an empty context to pass to `worker.fetch()`.
+		const ctx = createExecutionContext();
+		const response = await worker.fetch(request, env, ctx);
+		// Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
+		await waitOnExecutionContext(ctx);
+		expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
+	});
+
+	it('responds with Hello World! (integration style)', async () => {
+		const response = await SELF.fetch('https://example.com');
+		expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
+	});
+});

package/templates/hello-world/ts/test/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../tsconfig.json",
+	"compilerOptions": {
+		"types": ["@cloudflare/workers-types/experimental", "@cloudflare/vitest-pool-workers"]
+	},
+	"include": ["./**/*.ts", "../worker-configuration.d.ts"],
+	"exclude": []
+}