use workersTypes enum instead

Author: emily-shen

packages/create-cloudflare/src/__tests__/workers.test.ts

@@ -24,8 +24,7 @@ describe("updateTsConfig", () => {
 	beforeEach(() => {
 		ctx = createTestContext();
 		ctx.args.ts = true;
-		ctx.template.installWorkersTypes = false;
-		ctx.template.skipWranglerTypegen = false;
+		ctx.template.workersTypes = "generated";
 
 		vi.mocked(existsSync).mockImplementation(() => true);
 		vi.mocked(getLatestTypesEntrypoint).mockReturnValue(mockCompatDate);
@@ -37,8 +36,8 @@ describe("updateTsConfig", () => {
 	});
 
 	test("installing workers types", async () => {
-		ctx.template.installWorkersTypes = true;
-		ctx.template.skipWranglerTypegen = true;
+		ctx.template.workersTypes = "installed";
+
 		await updateTsConfig(ctx);
 
 		expect(writeFile).toHaveBeenCalled();
@@ -55,17 +54,16 @@ describe("updateTsConfig", () => {
 	});
 
 	test("latest entrypoint not found", async () => {
-		ctx.template.installWorkersTypes = true;
-		ctx.template.skipWranglerTypegen = true;
+		ctx.template.workersTypes = "installed";
+
 		vi.mocked(getLatestTypesEntrypoint).mockReturnValue(null);
 		await updateTsConfig(ctx);
 
 		expect(writeFile).not.toHaveBeenCalled();
 	});
 
 	test("don't clobber existing entrypoints", async () => {
-		ctx.template.installWorkersTypes = true;
-		ctx.template.skipWranglerTypegen = true;
+		ctx.template.workersTypes = "installed";
 		vi.mocked(readFile).mockImplementation(
 			() =>
 				`{ "compilerOptions": { "types" : ["@cloudflare/workers-types/2021-03-20"]} }`,

packages/create-cloudflare/src/cli.ts

@@ -167,10 +167,9 @@ const configure = async (ctx: C3Context) => {
 	addWranglerToGitIgnore(ctx);
 
 	await updatePackageScripts(ctx);
-	if (ctx.template.installWorkersTypes) {
+	if (ctx.template.workersTypes === "installed") {
 		await installWorkersTypes(ctx);
-	}
-	if (!ctx.template.skipWranglerTypegen) {
+	} else if (ctx.template.workersTypes === "generated") {
 		await generateWorkersTypes(ctx);
 	}
 

packages/create-cloudflare/src/templates.ts

@@ -150,11 +150,8 @@ export type TemplateConfig = {
 
 	bindings?: Record<string, unknown>;
 
-	/** Default false. For frameworks that are pinned to Wrangler 3. */
-	installWorkersTypes?: boolean;
-
 	/** Default false. To accomodate SSG frameworks etc. */
-	skipWranglerTypegen?: boolean;
+	workersTypes?: "generated" | "installed" | "none";
 };
 
 type CopyFiles = (StaticFileMap | VariantInfo) & {
@@ -614,6 +611,9 @@ export const createContext = async (
 	const directory = dirname(path);
 	const originalCWD = process.cwd();
 
+	// set default to generate types
+	template.workersTypes ??= "generated";
+	template.typesPath ??= "worker-configuration.d.ts";
 	return {
 		project: { name, path },
 		// We need to maintain a reference to the original args

packages/create-cloudflare/src/workers.ts

@@ -32,7 +32,7 @@ export async function generateWorkersTypes(ctx: C3Context) {
 		cwd: ctx.project.path,
 		silent: true,
 		startText: "Generating types for your application",
-		doneText: `${brandColor("generated")} ${dim(`to \`${ctx.template.typesPath ?? "worker-configuration.d.ts"}\` via \`${typesCmd.join(" ")}\``)}`,
+		doneText: `${brandColor("generated")} ${dim(`to \`${ctx.template.typesPath}\` via \`${typesCmd.join(" ")}\``)}`,
 	});
 
 	if (ctx.template.compatibilityFlags?.includes("nodejs_compat")) {
@@ -66,7 +66,7 @@ export async function updateTsConfig(ctx: C3Context) {
 		const config = jsonc.parse(tsconfig);
 		const currentTypes = config.compilerOptions?.types ?? [];
 		let newTypes: string[] = [...currentTypes];
-		if (ctx.template.installWorkersTypes) {
+		if (ctx.template.workersTypes === "installed") {
 			const entrypointVersion = getLatestTypesEntrypoint(ctx);
 			if (entrypointVersion === null) {
 				return;
@@ -84,7 +84,7 @@ export async function updateTsConfig(ctx: C3Context) {
 				newTypes.push(typesEntrypoint);
 			}
 		}
-		if (!ctx.template.skipWranglerTypegen) {
+		if (ctx.template.workersTypes === "generated") {
 			newTypes.push(ctx.template.typesPath ?? "./worker-configuration.d.ts");
 			// if generated types include runtime types, remove @cloudflare/workers-types
 			const typegen = readFile(

packages/create-cloudflare/templates/docusaurus/pages/c3.ts

@@ -27,6 +27,6 @@ const config: TemplateConfig = {
 	devScript: "preview",
 	deployScript: "deploy",
 	previewScript: "preview",
-	skipWranglerTypegen: false,
+	workersTypes: "none",
 };
 export default config;

packages/create-cloudflare/templates/docusaurus/workers/c3.ts

@@ -29,6 +29,6 @@ const config: TemplateConfig = {
 	devScript: "start",
 	deployScript: "deploy",
 	previewScript: "preview",
-	skipWranglerTypegen: true,
+	workersTypes: "none",
 };
 export default config;

packages/create-cloudflare/templates/gatsby/pages/c3.ts

@@ -47,6 +47,6 @@ const config: TemplateConfig = {
 	devScript: "develop",
 	deployScript: "deploy",
 	previewScript: "preview",
-	skipWranglerTypegen: true,
+	workersTypes: "none",
 };
 export default config;

packages/create-cloudflare/templates/gatsby/workers/c3.ts

@@ -49,6 +49,6 @@ const config: TemplateConfig = {
 	devScript: "develop",
 	deployScript: "deploy",
 	previewScript: "preview",
-	skipWranglerTypegen: true,
+	workersTypes: "none",
 };
 export default config;

packages/create-cloudflare/templates/qwik/pages/c3.ts

@@ -146,6 +146,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
-	installWorkersTypes: true,
+	workersTypes: "installed",
 };
 export default config;

packages/create-cloudflare/templates/qwik/pages/templates/worker-configuration.d.ts

@@ -0,0 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
+interface Env {
+}