fixups

Author: emily-shen

.changeset/nasty-kiwis-talk.md

@@ -8,4 +8,4 @@ Include runtime types in the output of `wrangler types` by default
 
 This behaviour was previously gated behind `--experimental-include-runtime`. That flag is no longer necessary and has been removed. It has been replaced by `--include-runtime` and `--include-env`, both of which are set to `true` by default. If you were previously using `--x-include-runtime`, you can drop that flag and remove the separate `runtime.d.ts` file.
 
-If you were previously using `@cloudflare/workers-types` we recommend you run uninstall and run `wrangler types` instead. Note that `@cloudflare/workers-types` will continue to be published.
+If you were previously using `@cloudflare/workers-types` we recommend you run uninstall (e.g. `npm uninstall @cloudflare/workers-types`) and run `wrangler types` instead. Note that `@cloudflare/workers-types` will continue to be published.

packages/wrangler/e2e/types.test.ts

@@ -170,7 +170,7 @@ describe("types", () => {
 			`;
 		await helper.seed(seed);
 		const worker = helper.runLongLived("wrangler dev");
-		await worker.readUntil(/❓ It looks like your types might be out of date./);
+		await worker.readUntil(/❓ Your types might be out of date./);
 		seed["wrangler.toml"] = dedent`
 			name = "test-worker"
 			main = "src/index.ts"
@@ -181,6 +181,6 @@ describe("types", () => {
 			ASDf = "ADSfadsf"
 		`;
 		await helper.seed(seed);
-		await worker.readUntil(/❓ It looks like your types might be out of date./);
+		await worker.readUntil(/❓ Your types might be out of date./);
 	});
 });

packages/wrangler/src/__tests__/type-generation.test.ts

@@ -1204,104 +1204,5 @@ describe("generate types", () => {
 				"
 			`);
 		});
-		it("prints something helpful about node compat", async () => {
-			fs.writeFileSync(
-				"./wrangler.toml",
-				TOML.stringify({
-					compatibility_date: "2022-12-12",
-					compatibility_flags: ["nodejs_compat"],
-					vars: {
-						"var-a": "a",
-					},
-				} as TOML.JsonMap),
-				"utf-8"
-			);
-			fs.writeFileSync(
-				"./tsconfig.json",
-				JSON.stringify({
-					compilerOptions: {
-						types: ["worker-configuration.d.ts"],
-					},
-				})
-			);
-			await runWrangler("types --include-env=false");
-			expect(std.out).toMatchInlineSnapshot(`
-				"Generating runtime types...
-
-				Runtime types generated.
-
-				────────────────────────────────────────────────────────────
-				✨ Types written to worker-configuration.d.ts
-
-				Action required Install @types/node
-				Since you have the \`nodejs_compat\` flag, you should install Node.js types by running \\"npm i --save-dev @types/node\\".
-
-				📖 Read about runtime types
-				https://developers.cloudflare.com/workers/languages/typescript/#generate-types
-				📣 Remember to rerun 'wrangler types' after you change your wrangler.toml file.
-				"
-			`);
-		});
-		it("prints all the relevant stuff if you having nothing set up", async () => {
-			fs.writeFileSync(
-				"./wrangler.toml",
-				TOML.stringify({
-					compatibility_date: "2022-12-12",
-					compatibility_flags: ["nodejs_compat"],
-					vars: {
-						"var-a": "a",
-					},
-				} as TOML.JsonMap),
-				"utf-8"
-			);
-			fs.writeFileSync(
-				"./tsconfig.json",
-				JSON.stringify({
-					compilerOptions: {
-						types: ["irrelevant.d.ts"],
-					},
-				})
-			);
-			await runWrangler("types --path=custom.d.ts --include-env=false");
-			expect(std.out).toMatchInlineSnapshot(`
-				"Generating runtime types...
-
-				Runtime types generated.
-
-				────────────────────────────────────────────────────────────
-				✨ Types written to custom.d.ts
-
-				Action required Install @types/node
-				Since you have the \`nodejs_compat\` flag, you should install Node.js types by running \\"npm i --save-dev @types/node\\".
-
-				📖 Read about runtime types
-				https://developers.cloudflare.com/workers/languages/typescript/#generate-types
-				📣 Remember to rerun 'wrangler types' after you change your wrangler.toml file.
-				"
-			`);
-		});
-		it("should not recommend to install @types/node if 'node' exists in types array", async () => {
-			fs.writeFileSync(
-				"./wrangler.toml",
-				TOML.stringify({
-					compatibility_date: "2022-12-12",
-					compatibility_flags: ["nodejs_compat"],
-				} as TOML.JsonMap),
-				"utf-8"
-			);
-			fs.writeFileSync(
-				"./tsconfig.json",
-				JSON.stringify({
-					compilerOptions: {
-						types: ["node"],
-					},
-				})
-			);
-			await runWrangler(`types`);
-
-			expect(std.out).not.toContain(
-				`Since you have the \`nodejs_compat\` flag, you should install Node.js`
-			);
-		});
 	});
 });

packages/wrangler/src/api/startDevWorker/ConfigController.ts

@@ -381,7 +381,12 @@ async function resolveConfig(
 	}
 
 	// prompt user to update their types if we detect that it is out of date
-	await checkTypesDiff(config, entry);
+	const typesChanged = await checkTypesDiff(config, entry);
+	if (typesChanged) {
+		logger.log(
+			"❓ Your types might be out of date. Re-run `wrangler types` to ensure your types are correct."
+		);
+	}
 
 	return resolved;
 }

packages/wrangler/src/type-generation/helpers.ts

@@ -62,9 +62,5 @@ export const checkTypesDiff = async (config: Config, entry: Entry) => {
 	const runtimeOutOfDate =
 		existingRuntimeHeader && existingRuntimeHeader !== newRuntimeHeader;
 
-	if (envOutOfDate || runtimeOutOfDate) {
-		logger.log(
-			"❓ It looks like your types might be out of date. Have you updated your config file since last running `wrangler types`?"
-		);
-	}
+	return envOutOfDate || runtimeOutOfDate;
 };

packages/wrangler/src/type-generation/index.ts

@@ -167,6 +167,7 @@ export const typesCommand = createCommand({
 
 		logHorizontalRule();
 
+		// don't write an empty Env type for service worker syntax
 		if ((header.length && content.length) || entrypointFormat === "modules") {
 			fs.writeFileSync(
 				outputPath,
@@ -183,7 +184,7 @@ export const typesCommand = createCommand({
 			config.compatibility_flags
 		);
 		if (args.includeRuntime) {
-			logRuntimeTypesMessage(outputPath, tsconfigTypes, mode !== null);
+			logRuntimeTypesMessage(tsconfigTypes, mode !== null);
 		}
 		logger.log(
 			`📣 Remember to rerun 'wrangler types' after you change your ${configFileName(config.configPath)} file.\n`

packages/wrangler/src/type-generation/runtime/log-runtime-types-message.ts

@@ -1,19 +1,20 @@
 import { existsSync } from "node:fs";
+import { join } from "node:path";
 import chalk from "chalk";
+import { findUpMultipleSync } from "find-up";
 import { logger } from "../../logger";
 
 /**
  * Constructs a comprehensive log message for the user after generating runtime types.
  */
 export function logRuntimeTypesMessage(
-	outFile: string,
 	tsconfigTypes: string[],
 	isNodeCompat = false
 ) {
 	const isWorkersTypesInstalled = tsconfigTypes.find((type) =>
 		type.startsWith("@cloudflare/workers-types")
 	);
-	const isNodeTypesInstalled = tsconfigTypes.find((type) => type === "node");
+
 	const maybeHasOldRuntimeFile = existsSync("./.wrangler/types/runtime.d.ts");
 	if (maybeHasOldRuntimeFile) {
 		logAction("Remove the old runtime.d.ts file");
@@ -36,6 +37,21 @@ export function logRuntimeTypesMessage(
 		logger.log("");
 	}
 
+	let isNodeTypesInstalled = Boolean(
+		tsconfigTypes.find((type) => type === "node")
+	);
+
+	if (!isNodeTypesInstalled && isNodeCompat) {
+		const nodeModules = findUpMultipleSync("node_modules", {
+			type: "directory",
+		});
+		for (const folder of nodeModules) {
+			if (nodeModules && existsSync(join(folder, "@types/node"))) {
+				isNodeTypesInstalled = true;
+				break;
+			}
+		}
+	}
 	if (isNodeCompat && !isNodeTypesInstalled) {
 		logAction("Install @types/node");
 		logger.log(