chore: changes from review

Author: ascorbic

helpers/checkNxConfig.js

@@ -9,12 +9,13 @@ const checkNxConfig = ({ netlifyConfig, nextConfig, failBuild, constants: { PUBL
       "- When using Nx you must set a value for 'distDir' in your next.config.js, and the value cannot be '.next'",
     )
   }
-  if (!PUBLISH_DIR.startsWith('apps')) {
+  // The PUBLISH_DIR constant is normalized, so no leading slash is needed
+  if (!PUBLISH_DIR.startsWith('apps/')) {
     errors.push(
       "Please set the 'publish' value in your Netlify build config to a folder inside your app directory. e.g. 'apps/myapp/out'",
     )
   }
-
+  // Look for the config file as a sibling of the publish dir
   const expectedConfigFile = path.resolve(netlifyConfig.build.publish, '..', 'next.config.js')
 
   if (expectedConfigFile !== nextConfig.configFile) {

helpers/getNextRoot.js

@@ -1,6 +1,10 @@
 const { existsSync } = require('fs')
 const path = require('path')
 
+/**
+ * If we're in a monorepo then the Next root may not be the same as the base directory
+ * If there's no next.config.js in the root, we instead look for it as a sibling of the publish dir
+ */
 const getNextRoot = ({ netlifyConfig }) => {
   let nextRoot = process.cwd()
   if (!existsSync(path.join(nextRoot, 'next.config.js')) && netlifyConfig.build.publish) {

helpers/verifyBuildTarget.js

@@ -9,7 +9,7 @@ const getNextRoot = require('./getNextRoot')
 const verifyBuildTarget = async ({ failBuild, netlifyConfig }) => {
   const nextRoot = getNextRoot({ netlifyConfig })
 
-  const { target, configFile, ...rest } = await getNextConfig(failBuild, nextRoot)
+  const { target, configFile } = await getNextConfig(failBuild, nextRoot)
 
   // If the next config exists, log warning if target isnt in acceptableTargets
   const acceptableTargets = ['serverless', 'experimental-serverless-trace']
@@ -46,10 +46,11 @@ const verifyBuildTarget = async ({ failBuild, netlifyConfig }) => {
   if (!configFile) {
     await writeFile(
       path.resolve('next.config.js'),
-      `module.exports = {
-    // Supported targets are "serverless" and "experimental-serverless-trace"
-    target: "serverless"
-  }`,
+      `
+module.exports = {
+  // Supported targets are "serverless" and "experimental-serverless-trace"
+  target: "serverless"
+}`,
     )
   }
   // Force the new config to be generated

index.js

@@ -37,6 +37,7 @@ module.exports = {
     // Because we memoize nextConfig, we need to do this after the write file
     const nextConfig = await getNextConfig(utils.failBuild, nextRoot)
 
+    // Nx needs special config handling, so check for it specifically
     const isNx = Boolean(
       (packageJson.devDependencies && packageJson.devDependencies['@nrwl/next']) ||
         (packageJson.dependencies && packageJson.dependencies['@nrwl/next']),

src/index.js

@@ -19,6 +19,8 @@ const build = async (functionsPath, publishPath, nextRoot) => {
     functionsPath,
     publishPath,
   })
+
+  // If we're in a monorepo we need to move into the Next site root
   const oldCwd = process.cwd()
   if (nextRoot !== oldCwd) {
     process.chdir(nextRoot)
@@ -35,6 +37,7 @@ const build = async (functionsPath, publishPath, nextRoot) => {
 
   setupHeaders(publishPath)
 
+  // ...and move back after
   if (nextRoot !== oldCwd) {
     process.chdir(oldCwd)
   }