Enable require-description-when-disabling lint rule on create-cloudflare (#13710)

Author: dario-piotrowicz

.oxlintrc.jsonc

@@ -202,7 +202,6 @@
 		// TODO: Remove the following overrides.
 		{
 			"files": [
-				"packages/create-cloudflare/**",
 				"packages/local-explorer-ui/**",
 				"packages/miniflare/**",
 				"packages/quick-edit-extension/**",

packages/create-cloudflare/e2e/helpers/framework-helpers.ts

@@ -76,7 +76,7 @@ export async function runC3ForFrameworkTest(
 
 	const match = output.replaceAll("\n", "").match(deployedUrlRe);
 	if (!match || !match[1]) {
-		// eslint-disable-next-line no-console
+		// eslint-disable-next-line no-console -- we dump raw C3 output for tests debugging
 		console.error(output);
 		expect(false, "Couldn't find deployment url in C3 output").toBe(true);
 		return "";
@@ -87,8 +87,7 @@ export async function runC3ForFrameworkTest(
 
 export function updateWranglerConfig(
 	projectPath: string,
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	handleUpdate: <T extends Record<string, any>>(config: T) => T
+	handleUpdate: <T extends Record<string, unknown>>(config: T) => T
 ) {
 	const wranglerTomlPath = join(projectPath, "wrangler.toml");
 	const wranglerJsoncPath = join(projectPath, "wrangler.jsonc");
@@ -131,7 +130,7 @@ export async function addTestVarsToWranglerToml(projectPath: string) {
 		return {
 			...config,
 			vars: {
-				...config.vars,
+				...(config.vars as Record<string, unknown>),
 				TEST: "C3_TEST",
 			},
 		};
@@ -223,7 +222,7 @@ export async function verifyDevScript(
 			restoreConfig = updateWranglerConfig(projectPath, (config) => ({
 				...config,
 				vars: {
-					...config.vars,
+					...(config.vars as Record<string, unknown>),
 					...updatedVars,
 				},
 			}));

packages/create-cloudflare/e2e/helpers/index.ts

@@ -91,17 +91,15 @@ export const test = originalTest.extend<{
 		const { logPath, logStream } = createTestLogStream(task);
 
 		onTestFailed(() => {
-			// eslint-disable-next-line no-console
+			// eslint-disable no-console -- raw console outputs for testing logs
 			console.error("##[group]Logs from failed test:", logPath);
 			try {
-				// eslint-disable-next-line no-console
 				console.error(readFileSync(logPath, "utf8"));
 			} catch {
-				// eslint-disable-next-line no-console
 				console.error("Unable to read log file");
 			}
-			// eslint-disable-next-line no-console
 			console.error("##[endgroup]");
+			// eslint-enable no-console
 		});
 
 		await use(logStream);

packages/create-cloudflare/e2e/helpers/log-stream.ts

@@ -20,14 +20,15 @@ export function createTestLogStream(task: RunnerTask) {
 
 export function recreateLogFolder(suite: RunnerTestSuite) {
 	// Clean the old folder if exists (useful for dev)
-	//
-	// Note: this is intentionally inlined rather than importing `removeDirSync`
-	// from `@cloudflare/workers-utils`. That package's barrel export pulls in CJS
-	// dependencies (e.g. `xdg-app-paths`) that break when Vite bundles the vitest
-	// config (which imports this file) into ESM — the shimmed `require()` calls
-	// throw "Dynamic require of 'path' is not supported".
-	// Keep aligned with `removeDirSync()` in `packages/workers-utils/src/fs-helpers.ts`.
-	// eslint-disable-next-line workers-sdk/no-direct-recursive-rm
+
+	/* eslint-disable-next-line workers-sdk/no-direct-recursive-rm --
+	   Note: this is intentionally inlined rather than importing `removeDirSync`
+	   from `@cloudflare/workers-utils`. That package's barrel export pulls in CJS
+	   dependencies (e.g. `xdg-app-paths`) that break when Vite bundles the vitest
+	   config (which imports this file) into ESM — the shimmed `require()` calls
+	   throw "Dynamic require of 'path' is not supported".
+	   Keep aligned with `removeDirSync()` in `packages/workers-utils/src/fs-helpers.ts`.
+	*/
 	rmSync(getLogPath(suite), {
 		recursive: true,
 		force: true,

packages/create-cloudflare/e2e/helpers/to-exist.ts

@@ -6,9 +6,9 @@ declare module "vitest" {
 	interface CustomMatchers<R = unknown> {
 		toExist(): R;
 	}
-	// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+	// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- required by vitest's module augmentation pattern
 	interface Assertion<T> extends CustomMatchers<T> {}
-	// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+	// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- required by vitest's module augmentation pattern
 	interface AsymmetricMatchersContaining extends CustomMatchers {}
 }
 

packages/create-cloudflare/e2e/tests/cli/cli.test.ts

@@ -509,7 +509,7 @@ describe("Create Cloudflare CLI", () => {
 						throw new Error("Remote worker not found");
 					}
 				} catch {
-					// eslint-disable-next-line no-console
+					// eslint-disable-next-line no-console -- e2e setup logging for worker redeployment
 					console.log(
 						"Redeploying the existing-script-test-do-not-delete worker"
 					);

packages/create-cloudflare/src/cli.ts

@@ -52,7 +52,7 @@ export const main = async (argv: string[]) => {
 		}
 
 		if (result.errorMessage) {
-			// eslint-disable-next-line no-console
+			// eslint-disable-next-line no-console -- display raw error message before exit
 			console.error(`\n${result.errorMessage}`);
 		}
 

packages/create-cloudflare/src/helpers/packageManagers.ts

@@ -105,14 +105,15 @@ export const rectifyPmMismatch = async (ctx: C3Context) => {
 
 	const nodeModulesPath = nodePath.join(ctx.project.path, "node_modules");
 	if (existsSync(nodeModulesPath)) {
-		// Note: this is intentionally inlined rather than importing `removeDirSync`
-		// from `@cloudflare/workers-utils`. That package's barrel export pulls in CJS
-		// dependencies (e.g. `xdg-app-paths`) that break when Vite bundles code into
-		// ESM — the shimmed `require()` calls throw "Dynamic require of 'path' is not
-		// supported". While the production build (esbuild → CJS) would handle this
-		// fine, the e2e tests import this file through Vitest which uses Vite's bundler.
-		// Keep aligned with `removeDirSync()` in `packages/workers-utils/src/fs-helpers.ts`.
-		// eslint-disable-next-line workers-sdk/no-direct-recursive-rm
+		/* eslint-disable-next-line workers-sdk/no-direct-recursive-rm --
+		   Note: this is intentionally inlined rather than importing `removeDirSync`
+		   from `@cloudflare/workers-utils`. That package's barrel export pulls in CJS
+		   dependencies (e.g. `xdg-app-paths`) that break when Vite bundles code into
+		   ESM — the shimmed `require()` calls throw "Dynamic require of 'path' is not
+		   supported". While the production build (esbuild → CJS) would handle this
+		   fine, the e2e tests import this file through Vitest which uses Vite's bundler.
+		   Keep aligned with `removeDirSync()` in `packages/workers-utils/src/fs-helpers.ts`.
+		*/
 		rmSync(nodeModulesPath, {
 			recursive: true,
 			force: true,

packages/create-cloudflare/src/helpers/sparrow.ts

@@ -18,7 +18,7 @@ export function hasSparrowSourceKey() {
 
 export async function sendEvent(payload: EventPayload, enableLog?: boolean) {
 	if (enableLog) {
-		// eslint-disable-next-line no-console
+		// eslint-disable-next-line no-console -- intentional raw debug logging for telemetry diagnostics
 		console.log("[telemetry]", JSON.stringify(payload, null, 2));
 	}
 
@@ -34,7 +34,7 @@ export async function sendEvent(payload: EventPayload, enableLog?: boolean) {
 	} catch (error) {
 		// Ignore any network errors
 		if (enableLog) {
-			// eslint-disable-next-line no-console
+			// eslint-disable-next-line no-console -- intentional raw debug logging for telemetry diagnostics
 			console.log("[telemetry]", error);
 		}
 	}