create-cloudflare 0.0.0-e6ddf8a7 → 0.0.0-e7ccc859

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-cloudflare",
-  "version": "0.0.0-e6ddf8a7",
+  "version": "0.0.0-e7ccc859",
   "description": "A CLI for creating and deploying new applications to Cloudflare.",
   "keywords": [
     "cloudflare",
@@ -31,13 +31,15 @@
     "@clack/prompts": "^0.6.3",
     "@cloudflare/eslint-config-worker": "*",
     "@cloudflare/workers-types": "^4.20230419.0",
+    "@iarna/toml": "^3.0.0",
     "@types/command-exists": "^1.2.0",
     "@types/cross-spawn": "^6.0.2",
+    "@types/deepmerge": "^2.2.0",
+    "@types/degit": "^2.8.6",
     "@types/dns2": "^2.0.3",
     "@types/esprima": "^4.0.3",
     "@types/node": "^18.15.3",
     "@types/semver": "^7.5.1",
-    "@types/shell-quote": "^1.7.2",
     "@types/which-pm-runs": "^1.0.0",
     "@types/yargs": "^17.0.22",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
@@ -45,29 +47,34 @@
     "chalk": "^5.2.0",
     "command-exists": "^1.2.9",
     "cross-spawn": "^7.0.3",
+    "deepmerge": "^4.3.1",
+    "degit": "^2.8.4",
     "dns2": "^2.1.0",
     "esbuild": "^0.17.12",
     "execa": "^7.1.1",
     "glob": "^10.3.3",
     "haikunator": "^2.1.2",
+    "magic-string": "^0.30.5",
     "open": "^8.4.0",
     "pnpm": "^8.10.0",
     "recast": "^0.22.0",
     "semver": "^7.5.1",
-    "shell-quote": "^1.8.1",
     "typescript": "^5.0.2",
-    "undici": "5.20.0",
+    "undici": "5.28.2",
     "vite-tsconfig-paths": "^4.0.8",
     "which-pm-runs": "^1.1.0",
     "yargs": "^17.7.1",
     "yarn": "^1.22.19",
+    "@cloudflare/cli": "1.1.1",
     "@cloudflare/workers-tsconfig": "0.0.0",
-    "wrangler": "3.17.1",
-    "@cloudflare/cli": "1.0.0"
+    "wrangler": "3.28.1"
   },
   "engines": {
     "node": ">=18.14.1"
   },
+  "workers-sdk": {
+    "prerelease": true
+  },
   "scripts": {
     "build": "node -r esbuild-register scripts/build.ts",
     "check:lint": "eslint .",

package/templates/angular/c3.ts

@@ -0,0 +1,99 @@
+import { resolve } from "node:path";
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { installPackages, runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag, readFile, readJSON, writeFile } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+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, "--ssr"]);
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	updateAngularJson(ctx);
+	await updateAppCode();
+	await installCFWorker();
+};
+
+async function installCFWorker() {
+	await installPackages(
+		["@cloudflare/workers-types", "@miniflare/tre@next", "wrangler@beta"],
+		{
+			dev: true,
+			startText: "Installing adapter dependencies",
+			doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
+		}
+	);
+}
+async function updateAppCode() {
+	const s = spinner();
+	s.start(`Updating application code`);
+
+	// Update an app config file to:
+	// - add the `provideHttpClient(withFetch())` call to enable `fetch` usage in `HttpClient`
+	const appConfigPath = "src/app/app.config.ts";
+	const appConfig = readFile(resolve(appConfigPath));
+	const newAppConfig =
+		"import { provideHttpClient, withFetch } from '@angular/common/http';\n" +
+		appConfig.replace(
+			"providers: [",
+			"providers: [provideHttpClient(withFetch()), "
+		);
+	writeFile(resolve(appConfigPath), newAppConfig);
+	s.stop(`${brandColor(`updated`)} ${dim(appConfigPath)}`);
+
+	// Remove unwanted dependencies
+	s.start(`Updating package.json`);
+	const packageJsonPath = resolve("package.json");
+	const packageManifest = readJSON(packageJsonPath);
+
+	delete packageManifest["dependencies"]["@angular/ssr"];
+	delete packageManifest["dependencies"]["express"];
+
+	writeFile(packageJsonPath, JSON.stringify(packageManifest, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`package.json\``)}`);
+}
+
+function updateAngularJson(ctx: C3Context) {
+	const s = spinner();
+	s.start(`Updating angular.json config`);
+	const angularJson = readJSON(resolve("angular.json"));
+	// Update builder
+	const architectSection = angularJson.projects[ctx.project.name].architect;
+	architectSection.build.options.outputPath = "dist";
+	architectSection.build.options.assets.push("src/_routes.json");
+
+	writeFile(resolve("angular.json"), JSON.stringify(angularJson, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`angular.json\``)}`);
+}
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "angular",
+	displayName: "Angular",
+	platform: "pages",
+	copyFiles: {
+		path: "./templates",
+	},
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			start: `${npm} run pages:build && wrangler pages dev dist/cloudflare ${await compatDateFlag()} --experimental-local`,
+			process:
+				"node ./tools/copy-files.mjs && node ./tools/alter-polyfills.mjs",
+			"pages:build": `ng build && ${npm} run process`,
+			deploy: `${npm} run pages:build && wrangler pages deploy dist/cloudflare`,
+		},
+	}),
+	deployScript: "deploy",
+	devScript: "start",
+	testFlags: ["--style", "sass"],
+};
+export default config;

package/{dist → templates}/angular/templates/tools/alter-polyfills.mjs

@@ -1,5 +1,5 @@
-import { EOL } from "node:os";
 import fs from "node:fs";
+import { EOL } from "node:os";
 import { join } from "node:path";
 import { worker } from "./paths.mjs";
 
@@ -13,7 +13,7 @@ import { worker } from "./paths.mjs";
 const serverPolyfillsFile = join(worker, "polyfills.server.mjs");
 const serverPolyfillsData = fs
 	.readFileSync(serverPolyfillsFile, "utf8")
-	.split(EOL);
+	.split(/\r?\n/);
 
 for (let index = 0; index < 2; index++) {
 	if (serverPolyfillsData[index].includes("createRequire")) {

package/{dist → templates}/angular/templates/tools/copy-files.mjs

@@ -1,7 +1,7 @@
 // Copy the files over so that they can be uploaded by the pages publish command.
 import fs from "node:fs";
 import { join } from "node:path";
-import { client, cloudflare, worker, ssr } from "./paths.mjs";
+import { client, cloudflare, ssr, worker } from "./paths.mjs";
 
 fs.cpSync(client, cloudflare, { recursive: true });
 fs.cpSync(ssr, worker, { recursive: true });

package/templates/astro/c3.ts

@@ -0,0 +1,50 @@
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { runCommand, 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";
+
+const { npx } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name, "--no-install"]);
+
+	logRaw(""); // newline
+};
+
+const configure = async () => {
+	await runCommand([npx, "astro", "add", "cloudflare", "-y"], {
+		silent: true,
+		startText: "Installing adapter",
+		doneText: `${brandColor("installed")} ${dim(
+			`via \`${npx} astro add cloudflare\``
+		)}`,
+	});
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "astro",
+	platform: "pages",
+	displayName: "Astro",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:dev": `wrangler pages dev ${await compatDateFlag()} -- astro dev`,
+			"pages:deploy": `astro build && wrangler pages deploy ./dist`,
+		},
+	}),
+	testFlags: [
+		"--skip-houston",
+		"--no-install",
+		"--no-git",
+		"--template",
+		"blog",
+		"--typescript",
+		"strict",
+	],
+};
+export default config;

package/templates/common/c3.ts

@@ -0,0 +1,14 @@
+export default {
+	configVersion: 1,
+	id: "common",
+	displayName: "Example router & proxy Worker",
+	platform: "workers",
+	copyFiles: {
+		js: {
+			path: "./js",
+		},
+		ts: {
+			path: "./ts",
+		},
+	},
+};

package/templates/common/ts/package.json

@@ -8,7 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"@cloudflare/workers-types": "^4.20230419.0",
 		"itty-router": "^3.0.12",
 		"typescript": "^5.0.4",
 		"wrangler": "^3.0.0"

package/templates/docusaurus/c3.ts

@@ -0,0 +1,27 @@
+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";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name, "classic"]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "docusaurus",
+	platform: "pages",
+	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],
+};
+export default config;

package/templates/gatsby/c3.ts

@@ -0,0 +1,46 @@
+import { inputPrompt } from "@cloudflare/cli/interactive";
+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";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	const defaultTemplate = "https://github.com/gatsbyjs/gatsby-starter-blog";
+
+	const useTemplate = await inputPrompt({
+		type: "confirm",
+		question: "Would you like to use a template?",
+		label: "template",
+		defaultValue: true,
+	});
+
+	let templateUrl = "";
+	if (useTemplate) {
+		templateUrl = await inputPrompt({
+			type: "text",
+			question: `Please specify the url of the template you'd like to use`,
+			label: "template",
+			defaultValue: defaultTemplate,
+		});
+	}
+
+	await runFrameworkGenerator(ctx, ["new", ctx.project.name, templateUrl]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "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`,
+		},
+	}),
+};
+export default config;

package/templates/hello-world/c3.ts

@@ -0,0 +1,14 @@
+export default {
+	configVersion: 1,
+	id: "hello-world",
+	displayName: '"Hello World" Worker',
+	platform: "workers",
+	copyFiles: {
+		js: {
+			path: "./js",
+		},
+		ts: {
+			path: "./ts",
+		},
+	},
+};

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

@@ -8,7 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"@cloudflare/workers-types": "^4.20230419.0",
 		"typescript": "^5.0.4",
 		"wrangler": "^3.0.0"
 	}

package/templates/hello-world-durable-object/c3.ts

@@ -0,0 +1,14 @@
+export default {
+	configVersion: 1,
+	id: "hello-world-durable-object",
+	displayName: '"Hello World" Durable Object',
+	platform: "workers",
+	copyFiles: {
+		js: {
+			path: "./js",
+		},
+		ts: {
+			path: "./ts",
+		},
+	},
+};

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

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

package/templates/hello-world-durable-object/js/.prettierrc

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

package/templates/{chatgptPlugin/ts → hello-world-durable-object/js}/__dot__gitignore

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

package/templates/hello-world-durable-object/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.0.0"
+	}
+}

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

@@ -0,0 +1,65 @@
+/**
+ * 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 {
+	/**
+	 * The constructor is invoked once upon creation of the Durable Object, i.e. the first call to
+	 * 	`DurableObjectStub::get` for a given identifier
+	 *
+	 * @param {DurableObjectState} state - The interface for interacting with Durable Object state
+	 * @param {Env} env - The interface to reference bindings declared in wrangler.toml
+	 */
+	constructor(state, env) {}
+
+	/**
+	 * The Durable Object fetch handler will be invoked when a Durable Object instance receives a
+	 * 	request from a Worker via an associated stub
+	 *
+	 * @param {Request} request - The request submitted to a Durable Object instance from a Worker
+	 * @returns {Promise<Response>} The response to be sent back to the Worker
+	 */
+	async fetch(request) {
+		return new Response('Hello World');
+	}
+}
+
+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 `fetch()` on the stub to send a request to the Durable Object instance
+		// The Durable Object instance will invoke its fetch handler to handle the request
+		let response = await stub.fetch(request);
+
+		return response;
+	},
+};

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

@@ -0,0 +1,51 @@
+name = "<TBD>"
+main = "src/index.js"
+compatibility_date = "<TBD>"
+
+# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
+# Note: Use secrets to store sensitive data.
+# Docs: https://developers.cloudflare.com/workers/platform/environment-variables
+# [vars]
+# MY_VARIABLE = "production_value"
+
+# Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
+# Docs: https://developers.cloudflare.com/workers/runtime-apis/kv
+# [[kv_namespaces]]
+# binding = "MY_KV_NAMESPACE"
+# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+
+# Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
+# Docs: https://developers.cloudflare.com/r2/api/workers/workers-api-usage/
+# [[r2_buckets]]
+# binding = "MY_BUCKET"
+# bucket_name = "my-bucket"
+
+# Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
+# Docs: https://developers.cloudflare.com/queues/get-started
+# [[queues.producers]]
+# binding = "MY_QUEUE"
+# queue = "my-queue"
+
+# Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
+# Docs: https://developers.cloudflare.com/queues/get-started
+# [[queues.consumers]]
+# queue = "my-queue"
+
+# Bind another Worker service. Use this binding to call another Worker without network overhead.
+# Docs: https://developers.cloudflare.com/workers/platform/services
+# [[services]]
+# binding = "MY_SERVICE"
+# service = "my-service"
+
+# 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/runtime-apis/durable-objects
+[[durable_objects.bindings]]
+name = "MY_DURABLE_OBJECT"
+class_name = "MyDurableObject"
+
+# Durable Object migrations.
+# Docs: https://developers.cloudflare.com/workers/learning/using-durable-objects#configure-durable-object-classes-with-migrations
+[[migrations]]
+tag = "v1"
+new_classes = ["MyDurableObject"]

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

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

package/templates/hello-world-durable-object/ts/.prettierrc

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