review comments

Author: james-elicx

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

@@ -11,25 +11,25 @@ import { rm } from "node:fs/promises";
  *
  * It saves the output in a `.worker-next` directory
  *
- * @param opts The options for the project
+ * @param projectOpts The options for the project
  */
-export async function build(opts: ProjectOptions): Promise<void> {
-  if (!opts.skipBuild) {
+export async function build(projectOpts: ProjectOptions): Promise<void> {
+  if (!projectOpts.skipBuild) {
     // Build the next app
-    await buildNextjsApp(opts.sourceDir);
+    await buildNextjsApp(projectOpts.sourceDir);
   }
 
-  if (!containsDotNextDir(opts.sourceDir)) {
-    throw new Error(`.next folder not found in ${opts.sourceDir}`);
+  if (!containsDotNextDir(projectOpts.sourceDir)) {
+    throw new Error(`.next folder not found in ${projectOpts.sourceDir}`);
   }
 
   // Clean the output directory
-  await cleanDirectory(opts.outputDir);
+  await cleanDirectory(projectOpts.outputDir);
 
   // Copy the .next directory to the output directory so it can be mutated.
-  cpSync(join(opts.sourceDir, ".next"), join(opts.outputDir, ".next"), { recursive: true });
+  cpSync(join(projectOpts.sourceDir, ".next"), join(projectOpts.outputDir, ".next"), { recursive: true });
 
-  const config = getConfig(opts);
+  const config = getConfig(projectOpts);
 
   await buildWorker(config);
 }

packages/cloudflare/src/cli/config.ts

@@ -15,7 +15,7 @@ export type Config = {
     // Timestamp for when the build was started
     timestamp: number;
     // Whether to skip building the Next.js app or not
-    shouldSkip: boolean;
+    skipNextBuild: boolean;
   };
 
   paths: {
@@ -50,14 +50,11 @@ export type Config = {
 /**
  * Computes the configuration.
  *
- * @param opts.sourceDir Next app root folder
- * @param opts.outputDir The directory where to save the output (defaults to the app's directory)
- * @param opts.skipBuild Whether the Next.js build should be skipped (i.e. if the `.next` dir is already built)
- *
+ * @param projectOpts The options for the project
  * @returns The configuration, see `Config`
  */
-export function getConfig(opts: ProjectOptions): Config {
-  const dotNext = path.join(opts.outputDir, ".next");
+export function getConfig(projectOpts: ProjectOptions): Config {
+  const dotNext = path.join(projectOpts.outputDir, ".next");
   const appPath = getNextjsApplicationPath(dotNext).replace(/\/$/, "");
   const standaloneRoot = path.join(dotNext, "standalone");
   const standaloneApp = path.join(standaloneRoot, appPath);
@@ -71,12 +68,12 @@ export function getConfig(opts: ProjectOptions): Config {
   return {
     build: {
       timestamp: Date.now(),
-      shouldSkip: !!opts.skipBuild,
+      skipNextBuild: !!projectOpts.skipBuild,
     },
 
     paths: {
-      sourceDir: opts.sourceDir,
-      outputDir: opts.outputDir,
+      sourceDir: projectOpts.sourceDir,
+      outputDir: projectOpts.outputDir,
       dotNext,
       standaloneRoot,
       standaloneApp,
@@ -103,8 +100,11 @@ export function containsDotNextDir(folder: string): boolean {
 }
 
 export type ProjectOptions = {
+  // Next app root folder
   sourceDir: string;
+  // The directory to save the output to (defaults to the app's directory)
   outputDir: string;
+  // Whether the Next.js build should be skipped (i.e. if the `.next` dir is already built)
   skipBuild?: boolean;
 };