npm - create-cloudflare - Versions diffs - 0.0.0-efd7f9764 → 0.0.0-efdba4f7f - Mend

create-cloudflare 0.0.0-efd7f9764 → 0.0.0-efdba4f7f

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (253) hide show

package/templates/hello-world-with-assets/py/__dot__gitignore ADDED Viewed

@@ -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-with-assets/py/package.json ADDED Viewed

@@ -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-experimental/hello-world-with-assets/ts → templates/hello-world-with-assets/py}/public/index.html RENAMED Viewed

@@ -7,8 +7,9 @@
 	</head>
 	<body>
 		<h1 id="heading"></h1>
-		<button id="button">Fetch a random UUID</button>
-		<div id="random"></div>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
+		<button id="button" type="button">Fetch a random UUID</button>
+		<output id="random" for="button"></output>
 		<script>
 			fetch('/message')
 				.then((resp) => resp.text())

package/templates/hello-world-with-assets/py/pyproject.toml ADDED Viewed

@@ -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-with-assets/py/src/entry.py ADDED Viewed

@@ -0,0 +1,11 @@
+from workers import Response
+from uuid import uuid4
+from urllib.parse import urlparse
+async def on_fetch(request, env):
+    url = urlparse(request.url)
+    if url.path == '/message':
+        return Response('Hello, World!')
+    if url.path == '/random':
+        return Response(uuid4())
+    return Response('Not Found', status=404)

package/templates/hello-world-with-assets/py/uv.lock ADDED Viewed

@@ -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-experimental → templates}/hello-world-with-assets/py/wrangler.jsonc RENAMED Viewed

@@ -6,7 +6,7 @@
     "python_workers"
   ],
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "observability": {

package/{templates-experimental → templates}/hello-world-with-assets/ts/package.json RENAMED Viewed

@@ -10,9 +10,9 @@
 		"cf-typegen": "wrangler types"
 	},
 	"devDependencies": {
-		"@cloudflare/vitest-pool-workers": "^0.6.4",
+		"@cloudflare/vitest-pool-workers": "^0.8.19",
 		"typescript": "^5.5.2",
-		"vitest": "~2.1.9",
+		"vitest": "~3.0.7",
 		"wrangler": "^3.101.0"
 	}
 }

package/{templates-experimental/hello-world-with-assets/js → templates/hello-world-with-assets/ts}/public/index.html RENAMED Viewed

@@ -7,8 +7,9 @@
 	</head>
 	<body>
 		<h1 id="heading"></h1>
-		<button id="button">Fetch a random UUID</button>
-		<div id="random"></div>
+		<p>This page comes from a static asset stored at `public/index.html` as configured in `wrangler.jsonc`.</p>
+		<button id="button" type="button">Fetch a random UUID</button>
+		<output id="random" for="button"></output>
 		<script>
 			fetch('/message')
 				.then((resp) => resp.text())

package/templates/hello-world-with-assets/ts/test/env.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+declare module 'cloudflare:test' {
+	interface ProvidedEnv extends Env {}
+}

package/templates/hello-world-with-assets/ts/test/tsconfig.json ADDED Viewed

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

package/{templates-experimental → templates}/hello-world-with-assets/ts/tsconfig.json RENAMED Viewed

@@ -13,8 +13,6 @@
 		"module": "es2022",
     /* Specify how TypeScript looks up a file from a given module specifier. */
 		"moduleResolution": "Bundler",
-    /* Specify type package names to be included without being referenced in a source file. */
-		"types": ["@cloudflare/workers-types"],
     /* Enable importing .json files */
 		"resolveJsonModule": true,

package/{templates-experimental → templates}/hello-world-with-assets/ts/wrangler.jsonc RENAMED Viewed

@@ -3,10 +3,10 @@
   "main": "src/index.ts",
   "compatibility_date": "<TBD>",
   "compatibility_flags": [
-    "nodejs_compat"
+    "global_fetch_strictly_public"
   ],
   "assets": {
-    "binding": "ASSETS",
+    // The path to the directory containing the `index.html` file to be served at `/`
     "directory": "./public"
   },
   "observability": {

package/templates/hono/c3.ts CHANGED Viewed

@@ -1,69 +1,9 @@
-import { logRaw } from "@cloudflare/cli";
-import { brandColor, dim } from "@cloudflare/cli/colors";
-import { spinner } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "frameworks/index";
-import { loadTemplateSnippets, transformFile } from "helpers/codemod";
-import { detectPackageManager } from "helpers/packageManagers";
-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 generate = async (ctx: C3Context) => {
-	const { name: pm } = detectPackageManager();
-	await runFrameworkGenerator(ctx, [
-		ctx.project.name,
-		"--template",
-		"cloudflare-workers",
-		"--install",
-		"--pm",
-		pm,
-	]);
-	logRaw(""); // newline
-};
-const configure = async (ctx: C3Context) => {
-	const indexFile = "src/index.ts";
-	const s = spinner();
-	s.start(`Updating \`${indexFile}\``);
-	const snippets = loadTemplateSnippets(ctx);
-	transformFile(indexFile, {
-		visitVariableDeclarator(n) {
-			if (n.node.id.type === "Identifier" && n.node.id.name === "app") {
-				n.node.init = snippets
-					.appDeclarationTs[0] as recast.types.namedTypes.NewExpression;
-				return false;
-			}
-		},
-	});
-	s.stop(`${brandColor("updated")} \`${dim(indexFile)}\``);
-};
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "hono",
-	frameworkCli: "create-hono",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Hono",
-	copyFiles: {
-		path: "./templates",
-	},
-	platform: "workers",
-	generate,
-	configure,
-	transformPackageJson: async () => ({
-		scripts: {
-			dev: "wrangler dev",
-			deploy: "wrangler deploy --minify",
-			"cf-typegen": "wrangler types --env-interface CloudflareBindings",
-		},
-	}),
-	devScript: "dev",
-	deployScript: "deploy",
+	platformVariants: { pages, workers },
 };
 export default config;

package/templates/hono/pages/c3.ts ADDED Viewed

@@ -0,0 +1,47 @@
+import { logRaw } from "@cloudflare/cli";
+import { runFrameworkGenerator } from "frameworks/index";
+import { detectPackageManager } from "helpers/packageManagers";
+import type { TemplateConfig } from "../../../src/templates";
+import type { C3Context } from "types";
+const generate = async (ctx: C3Context) => {
+	const { name: pm } = detectPackageManager();
+	await runFrameworkGenerator(ctx, [
+		ctx.project.name,
+		"--template",
+		"cloudflare-pages",
+		"--install",
+		"--pm",
+		pm,
+	]);
+	logRaw(""); // newline
+};
+const envInterfaceName = "CloudflareBindings";
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "hono",
+	frameworkCli: "create-hono",
+	displayName: "Hono",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates/hono/pages",
+	platform: "pages",
+	hidden: true,
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			"cf-typegen": `wrangler types --env-interface ${envInterfaceName}`,
+			preview: "vite build && wrangler pages dev",
+		},
+	}),
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+	envInterfaceName,
+};
+export default config;

package/templates/hono/pages/templates/src/index.tsx ADDED Viewed

@@ -0,0 +1,12 @@
+import { Hono } from 'hono'
+import { renderer } from './renderer'
+const app = new Hono<{ Bindings: CloudflareBindings }>();
+app.use(renderer)
+app.get('/', (c) => {
+  return c.render(<h1>Hello!</h1>)
+})
+export default app

package/templates/hono/{templates → pages/templates}/wrangler.jsonc RENAMED Viewed

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

package/{templates-experimental/hono → templates/hono/workers}/c3.ts RENAMED Viewed

@@ -1,7 +1,7 @@
 import { logRaw } from "@cloudflare/cli";
 import { runFrameworkGenerator } from "frameworks/index";
 import { detectPackageManager } from "helpers/packageManagers";
-import type { TemplateConfig } from "../../src/templates";
+import type { TemplateConfig } from "../../../src/templates";
 import type { C3Context } from "types";
 const generate = async (ctx: C3Context) => {
@@ -19,6 +19,7 @@ const generate = async (ctx: C3Context) => {
 	logRaw(""); // newline
 };
+const envInterfaceName = "CloudflareBindings";
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "hono",
@@ -28,16 +29,16 @@ const config: TemplateConfig = {
 		path: "./templates",
 	},
 	platform: "workers",
-	path: "templates-experimental/hono",
+	path: "templates/hono/workers",
 	generate,
 	transformPackageJson: async () => ({
 		scripts: {
-			dev: "wrangler dev",
-			deploy: "wrangler deploy --minify",
-			"cf-typegen": "wrangler types --env-interface CloudflareBindings",
+			"cf-typegen": `wrangler types --env-interface ${envInterfaceName}`,
 		},
 	}),
 	devScript: "dev",
 	deployScript: "deploy",
+	previewScript: "dev",
+	envInterfaceName,
 };
 export default config;

package/templates/next/c3.ts CHANGED Viewed

@@ -1,220 +1,9 @@
-import { join } from "path";
-import { updateStatus, warn } from "@cloudflare/cli";
-import { brandColor, dim } from "@cloudflare/cli/colors";
-import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "frameworks/index";
-import {
-	copyFile,
-	probePaths,
-	readFile,
-	readJSON,
-	usesEslint,
-	usesTypescript,
-	writeFile,
-	writeJSON,
-} from "helpers/files";
-import { detectPackageManager } from "helpers/packageManagers";
-import { installPackages } from "helpers/packages";
-import { getTemplatePath } from "../../src/templates";
-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, npx } = detectPackageManager();
-const generate = async (ctx: C3Context) => {
-	const projectName = ctx.project.name;
-	await runFrameworkGenerator(ctx, [projectName]);
-	const wranglerConfig = readFile(join(getTemplatePath(ctx), "wrangler.jsonc"));
-	writeFile(join(ctx.project.path, "wrangler.jsonc"), wranglerConfig);
-	updateStatus("Created wrangler.jsonc file");
-};
-const updateNextConfig = (usesTs: boolean) => {
-	const s = spinner();
-	const configFile = `next.config.${usesTs ? "ts" : "mjs"}`;
-	s.start(`Updating \`${configFile}\``);
-	const configContent = readFile(configFile);
-	const updatedConfigFile =
-		`import { setupDevPlatform } from '@cloudflare/next-on-pages/next-dev';
-		// Here we use the @cloudflare/next-on-pages next-dev module to allow us to
-		// use bindings during local development (when running the application with
-		// \`next dev\`). This function is only necessary during development and
-		// has no impact outside of that. For more information see:
-		// https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md
-		setupDevPlatform().catch(console.error);
-		`.replace(/\n\t*/g, "\n") + configContent;
-	writeFile(configFile, updatedConfigFile);
-	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
-};
-const configure = async (ctx: C3Context) => {
-	const projectPath = ctx.project.path;
-	// Add a compatible function handler example
-	const path = probePaths([
-		`${projectPath}/pages/api`,
-		`${projectPath}/src/pages/api`,
-		`${projectPath}/src/app/api`,
-		`${projectPath}/app/api`,
-		`${projectPath}/src/app`,
-		`${projectPath}/app`,
-	]);
-	if (!path) {
-		throw new Error("Could not find the `/api` or `/app` directory");
-	}
-	const usesTs = usesTypescript(ctx);
-	if (usesTs) {
-		copyFile(
-			join(getTemplatePath(ctx), "env.d.ts"),
-			join(projectPath, "env.d.ts"),
-		);
-		updateStatus("Created an env.d.ts file");
-	}
-	const installEslintPlugin = await shouldInstallNextOnPagesEslintPlugin(ctx);
-	if (installEslintPlugin) {
-		await writeEslintrc(ctx);
-	}
-	updateNextConfig(usesTs);
-	copyFile(
-		join(getTemplatePath(ctx), "README.md"),
-		join(projectPath, "README.md"),
-	);
-	updateStatus("Updated the README file");
-	await addDevDependencies(installEslintPlugin);
-};
-export const shouldInstallNextOnPagesEslintPlugin = async (
-	ctx: C3Context,
-): Promise<boolean> => {
-	const eslintUsage = usesEslint(ctx);
-	if (!eslintUsage.used) {
-		return false;
-	}
-	if (eslintUsage.configType !== ".eslintrc.json") {
-		warn(
-			`Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`,
-		);
-		return false;
-	}
-	return await inputPrompt({
-		type: "confirm",
-		question: "Do you want to use the next-on-pages eslint-plugin?",
-		label: "eslint-plugin",
-		defaultValue: true,
-	});
-};
-export const writeEslintrc = async (ctx: C3Context): Promise<void> => {
-	const eslintConfig = readJSON(`${ctx.project.path}/.eslintrc.json`);
-	eslintConfig.plugins ??= [];
-	eslintConfig.plugins.push("eslint-plugin-next-on-pages");
-	if (typeof eslintConfig.extends === "string") {
-		eslintConfig.extends = [eslintConfig.extends];
-	}
-	eslintConfig.extends ??= [];
-	eslintConfig.extends.push("plugin:eslint-plugin-next-on-pages/recommended");
-	writeJSON(`${ctx.project.path}/.eslintrc.json`, eslintConfig);
-};
-const addDevDependencies = async (installEslintPlugin: boolean) => {
-	const packages = [
-		"@cloudflare/next-on-pages@1",
-		"@cloudflare/workers-types",
-		"vercel",
-		...(installEslintPlugin ? ["eslint-plugin-next-on-pages"] : []),
-	];
-	await installPackages(packages, {
-		dev: true,
-		startText: "Adding the Cloudflare Pages adapter",
-		doneText: `${brandColor(`installed`)} ${dim(packages.join(", "))}`,
-	});
-};
-export default {
-	configVersion: 1,
-	id: "next",
-	frameworkCli: "create-next-app",
-	platform: "pages",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Next.js",
-	generate,
-	configure,
-	copyFiles: {
-		async selectVariant(ctx) {
-			const isApp = probePaths([
-				`${ctx.project.path}/src/app`,
-				`${ctx.project.path}/app`,
-			]);
-			const isTypescript = usesTypescript(ctx);
-			const dir = isApp ? "app" : "pages";
-			return `${dir}/${isTypescript ? "ts" : "js"}`;
-		},
-		destinationDir(ctx) {
-			const srcPath = probePaths([`${ctx.project.path}/src`]);
-			return srcPath ? "./src" : "./";
-		},
-		variants: {
-			"app/ts": {
-				path: "./app/ts",
-			},
-			"app/js": {
-				path: "./app/js",
-			},
-			"pages/ts": {
-				path: "./pages/ts",
-			},
-			"pages/js": {
-				path: "./pages/js",
-			},
-		},
-	},
-	transformPackageJson: async (_, ctx) => {
-		const isNpm = npm === "npm";
-		const isBun = npm === "bun";
-		const isNpmOrBun = isNpm || isBun;
-		const nextOnPagesScope = isNpmOrBun ? "@cloudflare/" : "";
-		const nextOnPagesCommand = `${nextOnPagesScope}next-on-pages`;
-		const pmCommand = isNpmOrBun ? npx : npm;
-		const pagesBuildRunCommand = `${
-			isNpm ? "npm run" : isBun ? "bun" : pmCommand
-		} pages:build`;
-		return {
-			scripts: {
-				"pages:build": `${pmCommand} ${nextOnPagesCommand}`,
-				preview: `${pagesBuildRunCommand} && wrangler pages dev`,
-				deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
-				...(usesTypescript(ctx) && {
-					"cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
-				}),
-			},
-		};
-	},
-	devScript: "dev",
-	previewScript: "preview",
-	deployScript: "deploy",
-	compatibilityFlags: ["nodejs_compat"],
-} as TemplateConfig;
+	platformVariants: { pages, workers },
+};
+export default config;