feat: support for a custom OpenNext config path

Author: james-elicx

.changeset/real-bats-sniff.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": minor
+---
+
+feat: support for a custom OpenNext config path with the `--openNextConfigPath` flag

examples/overrides/r2-incremental-cache/open-next.config.ts renamed to examples/overrides/r2-incremental-cache/.custom-config/my-opennext-config.ts

@@ -7,7 +7,7 @@
 		"build": "next build",
 		"start": "next start",
 		"lint": "next lint",
-		"build:worker": "pnpm opennextjs-cloudflare build",
+		"build:worker": "pnpm opennextjs-cloudflare build --openNextConfigPath=./.custom-config/my-opennext-config.ts",
 		"preview:worker": "pnpm opennextjs-cloudflare preview",
 		"preview": "pnpm build:worker && pnpm preview:worker",
 		"e2e": "playwright test -c e2e/playwright.config.ts"

examples/overrides/r2-incremental-cache/package.json

@@ -88,22 +88,26 @@ export async function getLatestCompatDate(): Promise<string | undefined> {
 }
 
 /**
- * Creates a `open-next.config.ts` file for the user if it doesn't exist, but only after asking for the user's confirmation.
+ * Creates a config file for the user if it doesn't exist, but only after asking for the user's confirmation.
  *
  * If the user refuses an error is thrown (since the file is mandatory).
  *
+ * @param configPath The path to the config file, relative to the source directory
  * @param sourceDir The source directory for the project
  */
-export async function createOpenNextConfigIfNotExistent(sourceDir: string): Promise<void> {
-	const openNextConfigPath = join(sourceDir, "open-next.config.ts");
+export async function createOpenNextConfigIfNotExistent(
+	configPath: string,
+	sourceDir: string
+): Promise<void> {
+	const openNextConfigPath = join(sourceDir, configPath);
 
 	if (!existsSync(openNextConfigPath)) {
 		const answer = await askConfirmation(
-			"Missing required `open-next.config.ts` file, do you want to create one?"
+			`Missing required \`${configPath}\` file, do you want to create one?`
 		);
 
 		if (!answer) {
-			throw new Error("The `open-next.config.ts` file is required, aborting!");
+			throw new Error(`The \`${configPath}\` file is required, aborting!`);
 		}
 
 		cpSync(join(getPackageTemplatesDirPath(), "open-next.config.ts"), openNextConfigPath);

packages/cloudflare/src/cli/build/utils/create-config-files.ts

@@ -22,11 +22,12 @@ async function buildCommand(
 		skipNextBuild: boolean;
 		noMinify: boolean;
 		skipWranglerConfigCheck: boolean;
+		openNextConfigPath: string;
 	}>
 ): Promise<void> {
 	printHeaders("build");
 
-	const { config, buildDir } = await compileConfig();
+	const { config, buildDir } = await compileConfig(args.openNextConfigPath);
 	const options = getNormalizedOptions(config, buildDir);
 
 	const wranglerConfig = readWranglerConfig(args);
@@ -65,6 +66,11 @@ export function addBuildCommand<T extends yargs.Argv>(y: T) {
 					type: "boolean",
 					default: ["1", "true", "yes"].includes(String(process.env.SKIP_WRANGLER_CONFIG_CHECK)),
 					desc: "Skip checking for a Wrangler config",
+				})
+				.option("openNextConfigPath", {
+					type: "string",
+					default: "open-next.config.ts",
+					desc: "Path to OpenNext configuration file, relative to the source directory",
 				}),
 		(args) => buildCommand(withWranglerPassthroughArgs(args))
 	);

packages/cloudflare/src/cli/commands/build.ts

@@ -37,10 +37,10 @@ export function printHeaders(command: string) {
  *
  * @returns OpenNext config.
  */
-export async function compileConfig() {
-	await createOpenNextConfigIfNotExistent(nextAppDir);
+export async function compileConfig(configPath: string) {
+	await createOpenNextConfigIfNotExistent(configPath, nextAppDir);
 
-	const { config, buildDir } = await compileOpenNextConfig(nextAppDir, undefined, { compileEdge: true });
+	const { config, buildDir } = await compileOpenNextConfig(nextAppDir, configPath, { compileEdge: true });
 	ensureCloudflareConfig(config);
 
 	return { config, buildDir };