review

Author: sommeeeer

packages/open-next/src/build/constant.ts

@@ -3,8 +3,13 @@ export const MIDDLEWARE_TRACE_FILE = "server/middleware.js.nft.json";
 export const INSTRUMENTATION_TRACE_FILE = "server/instrumentation.js.nft.json";
 
 export const LOCAL_CONFIG_PATH = "./open-next.config.local.ts";
-// This is an OpenNext config to run the default server function locally
-// https://opennext.js.org/aws/contribute/local_run
+/* 
+ * https://opennext.js.org/aws/contribute/local_run
+ * This is an OpenNext config to run the default server function locally
+ * Be aware that this will not work the same way as in production. 
+ * Its mostly used for debugging and development purposes.
+ * 
+ */
 export const LOCAL_CONFIG = `export default {
   default: {
     override: {
@@ -21,6 +26,8 @@ export const LOCAL_CONFIG = `export default {
       converter: "dummy",
     },
     loader: "fs-dev",
+    // This part is not needed on ARM Linux as it will be installed by default
+    // Currently only works on Linux machines
     install: {
       arch: "x64",
       packages: ["sharp"],

packages/open-next/src/index.ts

@@ -20,9 +20,9 @@ if (Object.keys(args).includes("--help")) printHelp();
 
 if (command === "build") {
   await build(args["--config-path"], args["--node-externals"]);
-} else if (command === "local:config") {
-  writeLocalConfig();
-} else if (command === "local:run") {
+} else if (command === "generate local") {
+  generateLocalConfig();
+} else if (command === "preview") {
   await buildLocalConfig();
   runLocally();
 }
@@ -78,7 +78,7 @@ function runLocally() {
   });
 }
 
-function writeLocalConfig() {
+function generateLocalConfig() {
   if (existsSync(LOCAL_CONFIG_PATH)) {
     console.error(
       "open-next.config.local.ts already exists. Please remove it before running this command.",
@@ -117,12 +117,12 @@ function printHelp() {
   );
 
   console.log("Other commands:");
-  console.log("  local:run");
+  console.log("  preview");
   console.log(
     "      Build and run OpenNext locally with open-next.config.local.ts",
   );
 
-  console.log("  local:config");
+  console.log("  generate local");
   console.log(
     "      Generate a config file with dev overrides for OpenNext in open-next.config.local.ts",
   );