add eslint disable (#8903)

Author: emily-shen

.changeset/wild-books-melt.md

@@ -0,0 +1,5 @@
+---
+"wrangler": patch
+---
+
+disable eslint in generated types file

packages/wrangler/e2e/types.test.ts

@@ -73,7 +73,8 @@ describe("types", () => {
 			"utf8"
 		);
 		expect(file).toMatchInlineSnapshot(`
-			"// Generated by Wrangler by running \`wrangler types --include-runtime=false\` (hash: 7915eccca244b8d5c107e358ee5929e8)
+			"/* eslint-disable */
+			// Generated by Wrangler by running \`wrangler types --include-runtime=false\` (hash: 7915eccca244b8d5c107e358ee5929e8)
 			declare namespace Cloudflare {
 				interface Env {
 					MY_VAR: "my-var-value";
@@ -94,10 +95,10 @@ describe("types", () => {
 			"utf8"
 		).split("\n");
 
-		expect(lines[0]).toMatchInlineSnapshot(
+		expect(lines[1]).toMatchInlineSnapshot(
 			`"// Generated by Wrangler by running \`wrangler types ./types.d.ts\` (hash: 7915eccca244b8d5c107e358ee5929e8)"`
 		);
-		expect(lines[1]).match(
+		expect(lines[2]).match(
 			/\/\/ Runtime types generated with workerd@1\.\d{8}\.\d \d{4}-\d{2}-\d{2} ([a-z_]+,?)*/
 		);
 	});
@@ -121,10 +122,10 @@ describe("types", () => {
 			"utf8"
 		).split("\n");
 
-		expect(lines[0]).toMatchInlineSnapshot(
-			`"// Generated by Wrangler by running \`wrangler types -c wranglerA.toml --env-interface MyCloudflareEnv ./cflare-env.d.ts\` (hash: 2f74a5a99f09ae4d994228b5bb959d24)"`
+		expect(lines[1]).toMatchInlineSnapshot(
+			`"// Generated by Wrangler by running \`wrangler types -c wranglerA.toml --env-interface MyCloudflareEnv ./cflare-env.d.ts\` (hash: fb913b8eb739817c9664fa1da8bdf499)"`
 		);
-		expect(lines[1]).match(
+		expect(lines[2]).match(
 			/\/\/ Runtime types generated with workerd@1\.\d{8}\.\d \d{4}-\d{2}-\d{2} ([a-z_]+,?)*/
 		);
 	});
@@ -142,6 +143,7 @@ describe("types", () => {
 			[
 				file[0],
 				file[1],
+				file[2],
 				"FAKE ENV",
 				"// Begin runtime types",
 				"FAKE RUNTIME",

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

@@ -582,7 +582,8 @@ describe("generate types", () => {
 		expect(fs.existsSync("./worker-configuration.d.ts")).toBe(true);
 		expect(fs.readFileSync("./worker-configuration.d.ts", "utf-8"))
 			.toMatchInlineSnapshot(`
-				"// Generated by Wrangler by running \`wrangler\` (hash: a123396658ac84465faf6f0f82c0337b)
+				"/* eslint-disable */
+				// Generated by Wrangler by running \`wrangler\` (hash: a123396658ac84465faf6f0f82c0337b)
 				// Runtime types generated with workerd@
 				declare namespace Cloudflare {
 					interface Env {
@@ -646,7 +647,8 @@ describe("generate types", () => {
 			await runWrangler("types");
 			expect(fs.readFileSync("./worker-configuration.d.ts", "utf8"))
 				.toMatchInlineSnapshot(`
-					"// Runtime types generated with workerd@
+					"/* eslint-disable */
+					// Runtime types generated with workerd@
 					// Begin runtime types
 					<runtime types go here>"
 				`);
@@ -683,14 +685,10 @@ describe("generate types", () => {
 
 			await runWrangler("types --include-runtime=false");
 
-			expect(fs.readFileSync("./worker-configuration.d.ts", "utf-8")).toContain(
-				`\t// eslint-disable-next-line @typescript-eslint/no-empty-interface,@typescript-eslint/no-empty-object-type\n\tinterface Env {\n\t}`
-			);
 			expect(std.out).toMatchInlineSnapshot(`
 				"Generating project types...
 
 				declare namespace Cloudflare {
-					// eslint-disable-next-line @typescript-eslint/no-empty-interface,@typescript-eslint/no-empty-object-type
 					interface Env {
 					}
 				}
@@ -1206,7 +1204,8 @@ describe("generate types", () => {
 
 				expect(fs.readFileSync("./cloudflare-env.d.ts", "utf-8"))
 					.toMatchInlineSnapshot(`
-						"// Generated by Wrangler by running \`wrangler\` (hash: a123396658ac84465faf6f0f82c0337b)
+						"/* eslint-disable */
+						// Generated by Wrangler by running \`wrangler\` (hash: a123396658ac84465faf6f0f82c0337b)
 						// Runtime types generated with workerd@
 						declare namespace Cloudflare {
 							interface Env {
@@ -1263,7 +1262,8 @@ describe("generate types", () => {
 
 			expect(fs.readFileSync("./my-cloudflare-env-interface.d.ts", "utf-8"))
 				.toMatchInlineSnapshot(`
-					"// Generated by Wrangler by running \`wrangler\` (hash: 7e48a0a15b531f54ca31c564fe6cb101)
+					"/* eslint-disable */
+					// Generated by Wrangler by running \`wrangler\` (hash: 7e48a0a15b531f54ca31c564fe6cb101)
 					// Runtime types generated with workerd@
 					declare namespace Cloudflare {
 						interface Env {

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

@@ -137,7 +137,7 @@ export const typesCommand = createCommand({
 		}
 		const entrypointFormat = entrypoint?.format ?? "modules";
 
-		const header = [];
+		const header = ["/* eslint-disable */"];
 		const content = [];
 		if (args.includeEnv) {
 			logger.log(`Generating project types...\n`);
@@ -622,22 +622,17 @@ function generateTypeStrings(
 	compatibilityFlags: string[] | undefined
 ): { fileContent: string; consoleOutput: string } {
 	let baseContent = "";
-	let eslintDisable = "";
 	let processEnv = "";
 
 	if (formatType === "modules") {
-		if (envTypeStructure.length === 0) {
-			eslintDisable =
-				"\t// eslint-disable-next-line @typescript-eslint/no-empty-interface,@typescript-eslint/no-empty-object-type\n";
-		}
 		if (
 			isProcessEnvPopulated(compatibilityDate, compatibilityFlags) &&
 			stringKeys.length > 0
 		) {
 			// StringifyValues ensures that json vars are correctly types as strings, not objects on process.env
 			processEnv = `\ntype StringifyValues<EnvType extends Record<string, unknown>> = {\n\t[Binding in keyof EnvType]: EnvType[Binding] extends string ? EnvType[Binding] : string;\n};\ndeclare namespace NodeJS {\n\tinterface ProcessEnv extends StringifyValues<Pick<Cloudflare.Env, ${stringKeys.map((k) => `"${k}"`).join(" | ")}>> {}\n}`;
 		}
-		baseContent = `declare namespace Cloudflare {\n${eslintDisable}\tinterface Env {${envTypeStructure.map((value) => `\n\t\t${value}`).join("")}\n\t}\n}\ninterface ${envInterface} extends Cloudflare.Env {}${processEnv}`;
+		baseContent = `declare namespace Cloudflare {\n\tinterface Env {${envTypeStructure.map((value) => `\n\t\t${value}`).join("")}\n\t}\n}\ninterface ${envInterface} extends Cloudflare.Env {}${processEnv}`;
 	} else {
 		baseContent = `export {};\ndeclare global {\n${envTypeStructure.map((value) => `\tconst ${value}`).join("\n")}\n}`;
 	}