create-cloudflare 2.9.2 → 2.10.0

package/templates/nuxt/c3.ts

@@ -0,0 +1,59 @@
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag, 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) => {
+	const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
+
+	await runFrameworkGenerator(ctx, [
+		"init",
+		ctx.project.name,
+		"--packageManager",
+		npm,
+		gitFlag,
+	]);
+
+	writeFile("./.node-version", "17");
+
+	logRaw(""); // newline
+};
+
+const configure = async (ctx: C3Context) => {
+	const configFileName = "nuxt.config.ts";
+	const configFilePath = resolve(configFileName);
+	const s = spinner();
+	s.start(`Updating \`${configFileName}\``);
+	// Add the cloudflare preset into the configuration file.
+	const originalConfigFile = readFileSync(configFilePath, "utf8");
+	const updatedConfigFile = originalConfigFile.replace(
+		"defineNuxtConfig({",
+		"defineNuxtConfig({\n  nitro: {\n    preset: 'cloudflare-pages'\n  },"
+	);
+	writeFile(configFilePath, updatedConfigFile);
+	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFileName}\``)}`);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "nuxt",
+	platform: "pages",
+	displayName: "Nuxt",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --proxy 3000 -- ${npm} run dev`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./dist`,
+		},
+	}),
+};
+export default config;

package/templates/openapi/c3.ts

@@ -0,0 +1,9 @@
+export default {
+	configVersion: 1,
+	id: "openapi",
+	displayName: "API starter (OpenAPI compliant)",
+	platform: "workers",
+	copyFiles: {
+		path: "./ts",
+	},
+};

package/templates/openapi/ts/src/endpoints/taskList.ts

@@ -1,9 +1,9 @@
-import { Task } from "../types";
 import {
 	OpenAPIRoute,
 	OpenAPIRouteSchema,
 	Query,
 } from "@cloudflare/itty-router-openapi";
+import { Task } from "../types";
 
 export class TaskList extends OpenAPIRoute {
 	static schema: OpenAPIRouteSchema = {

package/templates/openapi/ts/src/index.ts

@@ -1,8 +1,8 @@
 import { OpenAPIRouter } from "@cloudflare/itty-router-openapi";
-import { TaskList } from "./endpoints/taskList";
 import { TaskCreate } from "./endpoints/taskCreate";
-import { TaskFetch } from "./endpoints/taskFetch";
 import { TaskDelete } from "./endpoints/taskDelete";
+import { TaskFetch } from "./endpoints/taskFetch";
+import { TaskList } from "./endpoints/taskList";
 
 export const router = OpenAPIRouter({
 	docs_url: "/",

package/templates/pre-existing/c3.ts

@@ -0,0 +1,84 @@
+import { cp, mkdtemp, readdir, rm } from "fs/promises";
+import { tmpdir } from "os";
+import { join } from "path";
+import { crash } from "@cloudflare/cli";
+import { processArgument } from "@cloudflare/cli/args";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { runCommand } from "helpers/command";
+import { detectPackageManager } from "helpers/packages";
+import { chooseAccount } from "../../src/common";
+import type { C3Context } from "types";
+
+export async function copyExistingWorkerFiles(ctx: C3Context) {
+	const { dlx, npm } = detectPackageManager();
+
+	await chooseAccount(ctx);
+
+	if (ctx.args.existingScript === undefined) {
+		ctx.args.existingScript = await processArgument<string>(
+			ctx.args,
+			"existingScript",
+			{
+				type: "text",
+				question:
+					"Please specify the name of the existing worker in this account?",
+				label: "worker",
+				defaultValue: ctx.project.name,
+			}
+		);
+	}
+
+	// `wrangler init --from-dash` bails if you opt-out of creating a package.json
+	// so run it (with -y) in a tempdir and copy the src files after
+	const tempdir = await mkdtemp(join(tmpdir(), "c3-wrangler-init--from-dash-"));
+	await runCommand(
+		[
+			...dlx,
+			"wrangler@3",
+			"init",
+			"--from-dash",
+			ctx.args.existingScript,
+			"-y",
+			"--no-delegate-c3",
+		],
+		{
+			silent: true,
+			cwd: tempdir, // use a tempdir because we don't want all the files
+			env: { CLOUDFLARE_ACCOUNT_ID: ctx.account?.id },
+			startText: "Downloading existing worker files",
+			doneText: `${brandColor("downloaded")} ${dim(
+				`existing "${ctx.args.existingScript}" worker files`
+			)}`,
+		}
+	);
+
+	// 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
+	await cp(
+		join(tempdir, ctx.args.existingScript, "wrangler.toml"),
+		join(ctx.project.path, "wrangler.toml")
+	);
+}
+
+export default {
+	configVersion: 1,
+	id: "pre-existing",
+	displayName: "Pre-existing Worker (from Dashboard)",
+	platform: "workers",
+	hidden: true,
+	copyFiles: {
+		path: "./js",
+	},
+	configure: async (ctx: C3Context) => {
+		await copyExistingWorkerFiles(ctx);
+
+		// Force no-deploy since the worker is already deployed
+		ctx.args.deploy = false;
+	},
+};

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

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

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

@@ -0,0 +1,3 @@
+name = "<TBD>"
+main = "src/index.js"
+compatibility_date = "<TBD>"

package/templates/queues/c3.ts

@@ -0,0 +1,24 @@
+export default {
+	configVersion: 1,
+	id: "queues",
+	displayName: "Queue consumer & producer Worker",
+	platform: "workers",
+	copyFiles: {
+		js: {
+			path: "./js",
+		},
+		ts: {
+			path: "./ts",
+		},
+	},
+	bindings: {
+		queues: [
+			{
+				boundVariable: "MY_QUEUE",
+				defaultValue: "my-queue",
+				producer: true,
+				consumer: true,
+			},
+		],
+	},
+};

package/templates/qwik/c3.ts

@@ -0,0 +1,36 @@
+import { endSection } from "@cloudflare/cli";
+import { runCommand, runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import { quoteShellArgs } from "../../src/common";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+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);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "qwik",
+	displayName: "Qwik",
+	platform: "pages",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:dev": `wrangler pages dev ${await compatDateFlag()} -- ${npm} run dev`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./dist`,
+		},
+	}),
+};
+export default config;

package/templates/react/c3.ts

@@ -0,0 +1,29 @@
+import { logRaw } from "@cloudflare/cli";
+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]);
+
+	logRaw("");
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "react",
+	displayName: "React",
+	platform: "pages",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --port 3000 -- ${npm} start`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./build`,
+		},
+	}),
+};
+export default config;

package/templates/remix/c3.ts

@@ -0,0 +1,33 @@
+import { logRaw } from "@cloudflare/cli";
+import { runFrameworkGenerator } from "helpers/command.js";
+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,
+		"--template",
+		"https://github.com/remix-run/remix/tree/main/templates/cloudflare-pages",
+	]);
+
+	logRaw(""); // newline
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "remix",
+	displayName: "Remix",
+	platform: "pages",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./public`,
+		},
+	}),
+	devScript: "dev",
+	testFlags: ["--typescript", "--no-install", "--no-git-init"],
+};
+export default config;

package/templates/scheduled/c3.ts

@@ -0,0 +1,14 @@
+export default {
+	configVersion: 1,
+	id: "scheduled",
+	displayName: "Scheduled Worker (Cron Trigger)",
+	platform: "workers",
+	copyFiles: {
+		js: {
+			path: "./js",
+		},
+		ts: {
+			path: "./ts",
+		},
+	},
+};

package/templates/solid/c3.ts

@@ -0,0 +1,37 @@
+import { logRaw, updateStatus } from "@cloudflare/cli";
+import { blue, brandColor, dim } from "@cloudflare/cli/colors";
+import { installPackages, 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) => {
+	// Run the create-solid command
+	await runFrameworkGenerator(ctx, [ctx.project.name]);
+
+	logRaw("");
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "solid",
+	displayName: "Solid",
+	platform: "pages",
+	copyFiles: {
+		js: { path: "./js" },
+		ts: { path: "./ts" },
+	},
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:preview": `${npm} run build && npx wrangler pages dev dist ${await compatDateFlag()} --compatibility-flag nodejs_compat`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy ./dist`,
+		},
+	}),
+	devScript: "dev",
+	compatibilityFlags: ["nodejs_compat"],
+};
+export default config;

package/templates/solid/js/vite.config.js

@@ -0,0 +1,12 @@
+import { defineConfig } from "@solidjs/start/config";
+
+export default defineConfig({
+    start: {
+        server: {
+            preset: "cloudflare-pages",
+            rollupConfig: {
+                external: ["node:async_hooks"]
+            },
+        }
+    }
+});

package/templates/solid/ts/vite.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from "@solidjs/start/config";
+
+export default defineConfig({
+    start: {
+        server: {
+            preset: "cloudflare-pages",
+            rollupConfig: {
+                external: ["node:async_hooks"]
+            },
+        }
+    }
+});

package/templates/svelte/c3.ts

@@ -0,0 +1,75 @@
+import { logRaw, updateStatus } from "@cloudflare/cli";
+import { blue, brandColor, dim } from "@cloudflare/cli/colors";
+import { parseTs, transformFile } from "helpers/codemod";
+import { installPackages, runFrameworkGenerator } from "helpers/command";
+import { compatDateFlag, usesTypescript } from "helpers/files";
+import { detectPackageManager } from "helpers/packages";
+import { platformInterface } from "./templates";
+import type { TemplateConfig } from "../../src/templates";
+import type * as recast from "recast";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name]);
+
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	// Install the adapter
+	const pkg = `@sveltejs/adapter-cloudflare`;
+	await installPackages([pkg], {
+		dev: true,
+		startText: "Adding the Cloudflare Pages adapter",
+		doneText: `${brandColor(`installed`)} ${dim(pkg)}`,
+	});
+
+	// Change the import statement in svelte.config.js
+	transformFile("svelte.config.js", {
+		visitImportDeclaration: function (n) {
+			// importSource is the `x` in `import y from "x"`
+			const importSource = n.value.source;
+			if (importSource.value === "@sveltejs/adapter-auto") {
+				importSource.value = "@sveltejs/adapter-cloudflare";
+			}
+
+			// stop traversing this node
+			return false;
+		},
+	});
+	updateStatus(`Changing adapter in ${blue("svelte.config.js")}`);
+
+	// If using typescript, add the platform interface to the `App` interface
+	if (usesTypescript(ctx)) {
+		transformFile("src/app.d.ts", {
+			visitTSModuleDeclaration(n) {
+				if (n.value.id.name === "App") {
+					const patchAst = parseTs(platformInterface);
+					const body = n.node.body as recast.types.namedTypes.TSModuleBlock;
+					body.body.push(patchAst.program.body[0]);
+				}
+
+				this.traverse(n);
+			},
+		});
+		updateStatus(`Updating global type definitions in ${blue("app.d.ts")}`);
+	}
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "svelte",
+	displayName: "Svelte",
+	platform: "pages",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --proxy 5173 -- ${npm} run dev`,
+			"pages:deploy": `${npm} run build && wrangler pages deploy .svelte-kit/cloudflare`,
+		},
+	}),
+};
+export default config;

package/templates/svelte/templates.ts

@@ -0,0 +1,13 @@
+export const platformInterface = `
+interface Platform {
+  env: {
+    COUNTER: DurableObjectNamespace;
+  };
+  context: {
+    waitUntil(promise: Promise<any>): void;
+  };
+  caches: CacheStorage & { default: Cache }
+}
+`;
+
+// interface["Platform"] #context #waitUntil:nth(2)