feat(nextjs): add experimental-build-mode option to support compile o…

…nly (#26465) ## Current Behavior The nextjs build executor does not support all build flags such as `--experimental-build-mode` (see https://nextjs.org/docs/app/api-reference/next-cli#build). ## Expected Behavior For certain deployment models (e.g. mult-environment builds), it is helpful to only compile but not generate pages at build time. See vercel/next.js#46544 for a discussion. --------- Co-authored-by: Emily Xiong <[email protected]> Co-authored-by: Craigory Coppola <[email protected]>
nrwl · Jun 26, 2024 · 0ca7df7 · 0ca7df7
1 parent 86412cb
commit 0ca7df7
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/docs/generated/packages/next/executors/build.json b/docs/generated/packages/next/executors/build.json
@@ -72,6 +72,11 @@
       "experimentalAppOnly": {
         "type": "boolean",
         "description": "Only build 'app' routes"
+      },
+      "experimentalBuildMode": {
+        "type": "string",
+        "description": "Change the build mode.",
+        "enum": ["compile", "generate"]
       }
     },
     "required": ["outputPath"],

diff --git a/packages/next/src/executors/build/build.impl.ts b/packages/next/src/executors/build/build.impl.ts
@@ -124,13 +124,24 @@ function runCliBuild(
   projectRoot: string,
   options: NextBuildBuilderOptions
 ) {
-  const { experimentalAppOnly, profile, debug, outputPath } = options;
+  const {
+    experimentalAppOnly,
+    experimentalBuildMode,
+    profile,
+    debug,
+    outputPath,
+  } = options;
 
   // Set output path here since it can also be set via CLI
   // We can retrieve it inside plugins/with-nx
   process.env.NX_NEXT_OUTPUT_PATH ??= outputPath;
 
-  const args = createCliOptions({ experimentalAppOnly, profile, debug });
+  const args = createCliOptions({
+    experimentalAppOnly,
+    experimentalBuildMode,
+    profile,
+    debug,
+  });
   return new Promise((resolve, reject) => {
     childProcess = fork(
       require.resolve('next/dist/bin/next'),

diff --git a/packages/next/src/executors/build/schema.json b/packages/next/src/executors/build/schema.json
@@ -69,6 +69,11 @@
     "experimentalAppOnly": {
       "type": "boolean",
       "description": "Only build 'app' routes"
+    },
+    "experimentalBuildMode": {
+      "type": "string",
+      "description": "Change the build mode.",
+      "enum": ["compile", "generate"]
     }
   },
   "required": ["outputPath"],

diff --git a/packages/next/src/utils/types.ts b/packages/next/src/utils/types.ts
@@ -39,6 +39,7 @@ export interface NextBuildBuilderOptions {
   debug?: boolean;
   profile?: boolean;
   experimentalAppOnly?: boolean;
+  experimentalBuildMode?: 'compile' | 'generate';
 }
 
 export interface NextServeBuilderOptions {