create-cloudflare 0.0.0-e5cdd7fa → 0.0.0-e5dbedd78

package/templates/pre-existing/c3.ts

@@ -1,20 +1,18 @@
 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/packages";
-import { chooseAccount } from "../../src/common";
+import { detectPackageManager } from "helpers/packageManagers";
+import { chooseAccount, wranglerLogin } from "../../src/wrangler/accounts";
 import type { C3Context } from "types";
 
 export async function copyExistingWorkerFiles(ctx: C3Context) {
 	const { dlx } = detectPackageManager();
 
-	await chooseAccount(ctx);
-
 	if (ctx.args.existingScript === undefined) {
-		ctx.args.existingScript = await processArgument<string>(
+		ctx.args.existingScript = await processArgument(
 			ctx.args,
 			"existingScript",
 			{
@@ -23,7 +21,7 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
 					"Please specify the name of the existing worker in this account?",
 				label: "worker",
 				defaultValue: ctx.project.name,
-			}
+			},
 		);
 	}
 
@@ -46,22 +44,22 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
 			env: { CLOUDFLARE_ACCOUNT_ID: ctx.account?.id },
 			startText: "Downloading existing worker files",
 			doneText: `${brandColor("downloaded")} ${dim(
-				`existing "${ctx.args.existingScript}" worker files`
+				`existing "${ctx.args.existingScript}" worker files`,
 			)}`,
-		}
+		},
 	);
 
-	// 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 }
+		{ 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")
+		join(ctx.project.path, "wrangler.toml"),
 	);
 }
 
@@ -74,10 +72,31 @@ export default {
 	copyFiles: {
 		path: "./js",
 	},
-	configure: async (ctx: C3Context) => {
-		await copyExistingWorkerFiles(ctx);
+	configure: buildConfigure({
+		login: wranglerLogin,
+		chooseAccount,
+		copyFiles: copyExistingWorkerFiles,
+	}),
+};
+
+export interface ConfigureParams {
+	login: (ctx: C3Context) => Promise<boolean>;
+	chooseAccount: (ctx: C3Context) => Promise<void>;
+	copyFiles: (ctx: C3Context) => Promise<void>;
+}
+
+export function buildConfigure(params: ConfigureParams) {
+	return async function configure(ctx: C3Context) {
+		const loginSuccess = await params.login(ctx);
 
-		// Force no-deploy since the worker is already deployed
+		if (!loginSuccess) {
+			throw new Error("Failed to login to Cloudflare");
+		}
+
+		await params.chooseAccount(ctx);
+		await params.copyFiles(ctx);
+
+		// Force no-deploy since the Worker is already deployed
 		ctx.args.deploy = false;
-	},
-};
+	};
+}

package/templates/pre-existing/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/pre-existing/js/package.json

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

package/templates/queues/c3.ts

@@ -2,13 +2,17 @@ export default {
 	configVersion: 1,
 	id: "queues",
 	displayName: "Queue consumer & producer Worker",
+	description:
+		"Get started with a Worker that processes background tasks and message batches with Cloudflare Queues",
 	platform: "workers",
 	copyFiles: {
-		js: {
-			path: "./js",
-		},
-		ts: {
-			path: "./ts",
+		variants: {
+			js: {
+				path: "./js",
+			},
+			ts: {
+				path: "./ts",
+			},
 		},
 	},
 	bindings: {

package/templates/queues/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/queues/js/package.json

@@ -8,6 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"wrangler": "^3.0.0"
+		"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/.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/queues/ts/package.json

@@ -5,10 +5,11 @@
 	"scripts": {
 		"deploy": "wrangler deploy",
 		"dev": "wrangler dev",
-		"start": "wrangler dev"
+		"start": "wrangler dev",
+		"cf-typegen": "wrangler types"
 	},
 	"devDependencies": {
-		"typescript": "^5.0.4",
-		"wrangler": "^3.0.0"
+		"typescript": "^5.5.2",
+		"wrangler": "^3.101.0"
 	}
 }

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

@@ -8,19 +8,17 @@
  * - 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 a Queue. Learn more at https://developers.cloudflare.com/queues/javascript-apis/
-	MY_QUEUE: Queue;
-}
-
 export default {
 	// Our fetch handler is invoked on a HTTP request: we can send a message to a queue
 	// during (or after) a request.
 	// https://developers.cloudflare.com/queues/platform/javascript-apis/#producer
-	async fetch(req: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+	async fetch(req, env, ctx): Promise<Response> {
 		// To send a message on a queue, we need to create the queue first
 		// https://developers.cloudflare.com/queues/get-started/#3-create-a-queue
 		await env.MY_QUEUE.send({
@@ -32,7 +30,7 @@ export default {
 	},
 	// The queue handler is invoked when a batch of messages is ready to be delivered
 	// https://developers.cloudflare.com/queues/platform/javascript-apis/#messagebatch
-	async queue(batch: MessageBatch<Error>, env: Env): Promise<void> {
+	async queue(batch, env): Promise<void> {
 		// A queue consumer can make requests to other endpoints on the Internet,
 		// write to R2 object storage, query a D1 Database, and much more.
 		for (let message of batch.messages) {
@@ -40,4 +38,4 @@ export default {
 			console.log(`message ${message.id} processed: ${JSON.stringify(message.body)}`);
 		}
 	},
-};
+} satisfies ExportedHandler<Env, Error>;

package/templates/queues/ts/tsconfig.json

@@ -2,100 +2,41 @@
 	"compilerOptions": {
 		/* Visit https://aka.ms/tsconfig.json to read more about this file */
 
-		/* Projects */
-		// "incremental": true,                              /* Enable incremental compilation */
-		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-		// "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
-		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
-		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-		/* Language and Environment */
-		"target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-		"lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
-		"jsx": "react" /* Specify what JSX code is generated. */,
-		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
-		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
-		// "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
-		// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-
-		/* Modules */
-		"module": "es2022" /* Specify what module code is generated. */,
-		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
-		"moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
-		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
-		"types": ["@cloudflare/workers-types"] /* Specify type package names to be included without being referenced in a source file. */,
-		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-		"resolveJsonModule": true /* Enable importing .json files */,
-		// "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
-
-		/* JavaScript Support */
-		"allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
-		"checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
-		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
-
-		/* Emit */
-		// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-		// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-		// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-		// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-		// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
-		// "outDir": "./",                                   /* Specify an output folder for all emitted files. */
-		// "removeComments": true,                           /* Disable emitting comments. */
-		"noEmit": true /* Disable emitting files from a compilation. */,
-		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
-		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-		// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-		// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-		// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-		// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-		// "newLine": "crlf",                                /* Set the newline character for emitting files. */
-		// "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
-		// "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
-		// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-		// "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
-		// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-		// "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-		/* Interop Constraints */
-		"isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
-		"allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
-		// "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
-		// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-
-		/* Type Checking */
-		"strict": true /* Enable all strict type-checking options. */,
-		// "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
-		// "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
-		// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-		// "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
-		// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-		// "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
-		// "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
-		// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-		// "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
-		// "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
-		// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-		// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-		// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-		// "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
-		// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-		// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
-		// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-		// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-		/* Completeness */
-		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-		"skipLibCheck": true /* Skip type checking all .d.ts files. */
+    /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		"target": "es2021",
+    /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+		"lib": ["es2021"],
+    /* Specify what JSX code is generated. */
+		"jsx": "react-jsx",
+
+    /* Specify what module code is generated. */
+		"module": "es2022",
+    /* Specify how TypeScript looks up a file from a given module specifier. */
+		"moduleResolution": "node",
+    /* Specify type package names to be included without being referenced in a source file. */
+		"types": ["@cloudflare/workers-types"],
+    /* Enable importing .json files */
+		"resolveJsonModule": true,
+
+    /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+		"allowJs": true,
+    /* Enable error reporting in type-checked JavaScript files. */
+		"checkJs": false,
+
+    /* Disable emitting files from a compilation. */
+		"noEmit": true,
+
+    /* Ensure that each file can be safely transpiled without relying on other imports. */
+		"isolatedModules": true,
+    /* Allow 'import x from y' when a module doesn't have a default export. */
+		"allowSyntheticDefaultImports": true,
+    /* Ensure that casing is correct in imports. */
+		"forceConsistentCasingInFileNames": true,
+
+    /* Enable all strict type-checking options. */
+		"strict": true,
+
+    /* Skip type checking all .d.ts files. */
+		"skipLibCheck": true
 	}
 }

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

@@ -0,0 +1,5 @@
+// Generated by Wrangler
+// 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,92 +1,9 @@
-import { endSection } from "@cloudflare/cli";
-import { brandColor } from "@cloudflare/cli/colors";
-import { spinner } from "@cloudflare/cli/interactive";
-import { parseTs, transformFile } from "helpers/codemod";
-import { runCommand, runFrameworkGenerator } from "helpers/command";
-import { usesTypescript } from "helpers/files";
-import { detectPackageManager } from "helpers/packages";
-import { quoteShellArgs } from "../../src/common";
-import type { TemplateConfig } from "../../src/templates";
-import type * as recast from "recast";
-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, ["basic", 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);
-};
-
-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`");
-
-	// Insert the env declaration after the last import (but before the rest of the body)
-	const envDeclaration = `
-let env = {};
-
-if(process.env.NODE_ENV === 'development') {
-  const { getBindingsProxy } = await import('wrangler');
-  const { bindings } = await getBindingsProxy();
-  env = bindings;
-}
-`;
-
-	transformFile("vite.config.ts", {
-		visitProgram: function (n) {
-			const lastImportIndex = n.node.body.findLastIndex(
-				(t) => t.type === "ImportDeclaration"
-			);
-			n.get("body").insertAt(lastImportIndex + 1, envDeclaration);
-
-			return false;
-		},
-	});
-
-	// Populate the `qwikCity` plugin with the platform object containing the `env` defined above.
-	const platformObject = parseTs(`{ platform: { env } }`);
-
-	transformFile("vite.config.ts", {
-		visitCallExpression: function (n) {
-			const callee = n.node.callee as recast.types.namedTypes.Identifier;
-			if (callee.name === "qwikCity") {
-				n.node.arguments = [platformObject];
-			}
-
-			this.traverse(n);
-		},
-	});
-
-	s.stop(`${brandColor("updated")} \`vite.config.ts\``);
-};
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "qwik",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Qwik",
-	platform: "pages",
-	devScript: "dev",
-	deployScript: "deploy",
-	generate,
-	configure,
-	transformPackageJson: async () => ({
-		scripts: {
-			deploy: `${npm} run build && wrangler pages deploy ./dist`,
-		},
-	}),
+	platformVariants: { pages, workers },
 };
 export default config;