create-cloudflare 2.27.2 → 2.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cloudflare",
-  "version": "2.27.2",
+  "version": "2.28.0",
   "description": "A CLI for creating and deploying new applications to Cloudflare.",
   "keywords": [
     "cloudflare",
@@ -64,11 +64,12 @@
     "vite-tsconfig-paths": "^4.0.8",
     "which-pm-runs": "^1.1.0",
     "wrap-ansi": "^9.0.0",
+    "xdg-app-paths": "^8.3.0",
     "yargs": "^17.7.2",
+    "@cloudflare/cli": "1.1.1",
     "@cloudflare/eslint-config-worker": "1.1.0",
     "@cloudflare/workers-tsconfig": "0.0.0",
-    "wrangler": "3.78.4",
-    "@cloudflare/cli": "1.1.1"
+    "wrangler": "3.78.8"
   },
   "engines": {
     "node": ">=18.14.1"

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

@@ -13,27 +13,6 @@ import { DurableObject } from "cloudflare:workers";
  * Learn more at https://developers.cloudflare.com/durable-objects
  */
 
-
-/**
- * Associate bindings declared in wrangler.toml with the TypeScript type system
- */
-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<MyDurableObject>;
-	//
-	// 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;
-}
-
 /** A Durable Object's behavior is defined in an exported Javascript class */
 export class MyDurableObject extends DurableObject {
 	/**

package/templates/hello-world-durable-object/ts/worker-configuration.d.ts

@@ -1,6 +1,5 @@
-// Generated by Wrangler
-// After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
+// Generated by Wrangler by running `wrangler types`
+
 interface Env {
-	MY_DURABLE_OBJECT: DurableObjectNamespace;
+	MY_DURABLE_OBJECT: DurableObjectNamespace<import("./src/index").MyDurableObject>;
 }
-

package/templates/next/c3.ts

@@ -1,8 +1,7 @@
 import { join } from "path";
-import { crash, updateStatus, warn } from "@cloudflare/cli";
-import { processArgument } from "@cloudflare/cli/args";
+import { updateStatus, warn } from "@cloudflare/cli";
 import { brandColor, dim } from "@cloudflare/cli/colors";
-import { spinner } from "@cloudflare/cli/interactive";
+import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
 import { runFrameworkGenerator } from "frameworks/index";
 import {
 	copyFile,
@@ -18,7 +17,7 @@ import { detectPackageManager } from "helpers/packageManagers";
 import { installPackages } from "helpers/packages";
 import { getTemplatePath } from "../../src/templates";
 import type { TemplateConfig } from "../../src/templates";
-import type { C3Args, C3Context } from "types";
+import type { C3Context } from "types";
 
 const { npm, npx } = detectPackageManager();
 
@@ -42,7 +41,7 @@ const generate = async (ctx: C3Context) => {
 		// This should never happen to users, it is a check mostly so that
 		// if the toml file is changed in a way that breaks the "KV Example" addition
 		// the C3 Next.js e2e runs will fail with this
-		crash("Failed to properly generate the wrangler.toml file");
+		throw new Error("Failed to properly generate the wrangler.toml file");
 	}
 
 	writeFile(join(ctx.project.path, "wrangler.toml"), newTomlContent);
@@ -89,7 +88,7 @@ const configure = async (ctx: C3Context) => {
 	]);
 
 	if (!path) {
-		crash("Could not find the `/api` or `/app` directory");
+		throw new Error("Could not find the `/api` or `/app` directory");
 	}
 
 	const usesTs = usesTypescript(ctx);
@@ -135,7 +134,7 @@ export const shouldInstallNextOnPagesEslintPlugin = async (
 		return false;
 	}
 
-	return await processArgument(ctx.args, "eslint-plugin" as keyof C3Args, {
+	return await inputPrompt({
 		type: "confirm",
 		question: "Do you want to use the next-on-pages eslint-plugin?",
 		label: "eslint-plugin",

package/templates/pre-existing/c3.ts

@@ -1,8 +1,8 @@
 import { cp, mkdtemp } from "fs/promises";
 import { tmpdir } from "os";
 import { join } from "path";
-import { processArgument } from "@cloudflare/cli/args";
 import { brandColor, dim } from "@cloudflare/cli/colors";
+import { processArgument } from "helpers/args";
 import { runCommand } from "helpers/command";
 import { detectPackageManager } from "helpers/packageManagers";
 import { chooseAccount } from "../../src/wrangler/accounts";
@@ -14,7 +14,7 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
 	await chooseAccount(ctx);
 
 	if (ctx.args.existingScript === undefined) {
-		ctx.args.existingScript = await processArgument<string>(
+		ctx.args.existingScript = await processArgument(
 			ctx.args,
 			"existingScript",
 			{

package/templates/qwik/c3.ts

@@ -1,4 +1,4 @@
-import { crash, endSection } from "@cloudflare/cli";
+import { endSection } from "@cloudflare/cli";
 import { brandColor } from "@cloudflare/cli/colors";
 import { spinner } from "@cloudflare/cli/interactive";
 import { runFrameworkGenerator } from "frameworks/index";
@@ -13,7 +13,7 @@ import type { C3Context } from "types";
 const { npm, npx } = detectPackageManager();
 
 const generate = async (ctx: C3Context) => {
-	await runFrameworkGenerator(ctx, ["basic", ctx.project.name]);
+	await runFrameworkGenerator(ctx, ["playground", ctx.project.name]);
 };
 
 const configure = async (ctx: C3Context) => {
@@ -75,7 +75,7 @@ const addBindingsProxy = (ctx: C3Context) => {
 			}
 
 			if (configArgument.type !== "ObjectExpression") {
-				crash("Failed to update `vite.config.ts`");
+				throw new Error("Failed to update `vite.config.ts`");
 			}
 
 			// Add the `platform` object to the object

package/templates/qwik/templates/wrangler.toml

@@ -2,6 +2,7 @@
 name = "<TBD>"
 compatibility_date = "<TBD>"
 pages_build_output_dir = "./dist"
+compatibility_flags = ["nodejs_compat"]
 
 # Automatically place your workloads in an optimal location to minimize latency.
 # If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure

package/templates/react/c3.ts

@@ -1,5 +1,5 @@
 import { logRaw } from "@cloudflare/cli";
-import { processArgument } from "@cloudflare/cli/args";
+import { inputPrompt } from "@cloudflare/cli/interactive";
 import { runFrameworkGenerator } from "frameworks/index";
 import { detectPackageManager } from "helpers/packageManagers";
 import type { TemplateConfig } from "../../src/templates";
@@ -8,7 +8,7 @@ import type { C3Context } from "types";
 const { npm } = detectPackageManager();
 
 const generate = async (ctx: C3Context) => {
-	const variant = await processArgument<string>(ctx.args, "variant", {
+	const variant = await inputPrompt({
 		type: "select",
 		question: "Select a variant:",
 		label: "variant",

package/templates-experimental/hello-world-assets-only/c3.ts

@@ -0,0 +1,15 @@
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "hello-world-assets-only",
+	path: "templates-experimental/hello-world-assets-only",
+	displayName: "Hello World - Assets-only",
+	description: "Get started with a basic Worker that only serves static assets",
+	platform: "workers",
+	copyFiles: {
+		path: "./templates",
+	},
+};
+
+export default config;

package/templates-experimental/hello-world-assets-only/templates/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.78.5"
+	}
+}

package/templates-experimental/hello-world-assets-only/templates/public/index.html

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Hello, World!</title>
+	</head>
+	<body>
+		<h1 id="heading">Hello, World!</h1>
+	</body>
+</html>

package/templates-experimental/hello-world-assets-only/templates/wrangler.toml

@@ -0,0 +1,4 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+experimental_assets = { directory = "./public" }

package/templates-experimental/hello-world-durable-object-with-assets/c3.ts

@@ -0,0 +1,23 @@
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "hello-world-durable-object-with-assets",
+	path: "templates-experimental/hello-world-durable-object-with-assets",
+	displayName: "Hello World - Worker Using Durable Objects with Assets",
+	description:
+		"Get started with a basic stateful app to build projects like real-time chats, collaborative apps, and multiplayer games, which hosts assets",
+	platform: "workers",
+	copyFiles: {
+		variants: {
+			js: {
+				path: "./js",
+			},
+			ts: {
+				path: "./ts",
+			},
+		},
+	},
+};
+
+export default config;

package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space

package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc

@@ -0,0 +1,6 @@
+{
+	"printWidth": 140,
+	"singleQuote": true,
+	"semi": true,
+	"useTabs": true
+}

package/templates-experimental/hello-world-durable-object-with-assets/js/__dot__gitignore

@@ -0,0 +1,172 @@
+# 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
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+\*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+\*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+\*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.cache
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+.cache/
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+.cache
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.\*
+
+# wrangler project
+
+.dev.vars
+.wrangler/

package/templates-experimental/hello-world-durable-object-with-assets/js/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.60.3"
+	}
+}

package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Hello, World!</title>
+	</head>
+	<body>
+		<h1 id="heading"></h1>
+		<script>
+			fetch('/message')
+				.then((resp) => resp.text())
+				.then((text) => {
+					const h1 = document.getElementById('heading');
+					h1.textContent = text;
+				});
+		</script>
+	</body>
+</html>

package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js

@@ -0,0 +1,69 @@
+import { DurableObject } from "cloudflare:workers";
+
+/**
+ * Welcome to Cloudflare Workers! This is your first Durable Objects application.
+ *
+ * - Run `npm run dev` in your terminal to start a development server
+ * - Open a browser tab at http://localhost:8787/ to see your Durable Object in action
+ * - Run `npm run deploy` to publish your application
+ *
+ * Learn more at https://developers.cloudflare.com/durable-objects
+ */
+
+/**
+ * Env provides a mechanism to reference bindings declared in wrangler.toml within JavaScript
+ *
+ * @typedef {Object} Env
+ * @property {DurableObjectNamespace} MY_DURABLE_OBJECT - The Durable Object namespace binding
+ */
+
+/** A Durable Object's behavior is defined in an exported Javascript class */
+export class MyDurableObject extends DurableObject {
+	/**
+	 * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
+	 * 	`DurableObjectStub::get` for a given identifier (no-op constructors can be omitted)
+	 *
+	 * @param {DurableObjectState} ctx - The interface for interacting with Durable Object state
+	 * @param {Env} env - The interface to reference bindings declared in wrangler.toml
+	 */
+	constructor(ctx, env) {
+		super(ctx, env);
+	}
+
+	/**
+	 * The Durable Object exposes an RPC method sayHello which will be invoked when when a Durable
+	 *  Object instance receives a request from a Worker via the same method invocation on the stub
+	 *
+	 * @param {string} name - The name provided to a Durable Object instance from a Worker
+	 * @returns {Promise<string>} The greeting to be sent back to the Worker
+	 */
+	async sayHello(name) {
+		return `Hello, ${name}!`;
+	}
+}
+
+export default {
+	/**
+	 * This is the standard fetch handler for a Cloudflare Worker
+	 *
+	 * @param {Request} request - The request submitted to the Worker from the client
+	 * @param {Env} env - The interface to reference bindings declared in wrangler.toml
+	 * @param {ExecutionContext} ctx - The execution context of the Worker
+	 * @returns {Promise<Response>} The response to be sent back to the client
+	 */
+	async fetch(request, env, ctx) {
+		// We will create a `DurableObjectId` using the pathname from the Worker request
+		// This id refers to a unique instance of our 'MyDurableObject' class above
+		let id = env.MY_DURABLE_OBJECT.idFromName(new URL(request.url).pathname);
+
+		// This stub creates a communication channel with the Durable Object instance
+		// The Durable Object constructor will be invoked upon the first call for a given id
+		let stub = env.MY_DURABLE_OBJECT.get(id);
+
+		// We call the `sayHello()` RPC method on the stub to invoke the method on the remote
+		// Durable Object instance
+		let greeting = await stub.sayHello("world");
+
+		return new Response(greeting);
+	},
+};

package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml

@@ -0,0 +1,19 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+main = "src/index.js"
+compatibility_date = "<TBD>"
+experimental_assets = { directory = "./public", binding = "ASSETS" }
+
+# Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
+# Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
+# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
+[[durable_objects.bindings]]
+name = "MY_DURABLE_OBJECT"
+class_name = "MyDurableObject"
+
+# Durable Object migrations.
+# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
+[[migrations]]
+tag = "v1"
+new_classes = ["MyDurableObject"]
+

package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space

package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc

@@ -0,0 +1,6 @@
+{
+	"printWidth": 140,
+	"singleQuote": true,
+	"semi": true,
+	"useTabs": true
+}