feat: monorepo handling

.gitignore

@@ -150,3 +150,5 @@ Temporary Items
 
 # End of https://www.toptal.com/developers/gitignore/api/osx,node
 demo/package-lock.json
+
+.netlify

helpers/checkNxConfig.js

@@ -0,0 +1,50 @@
+const { existsSync } = require('fs')
+const { EOL } = require('os')
+const path = require('path')
+
+const checkNxConfig = ({ netlifyConfig, nextConfig, failBuild, constants: { PUBLISH_DIR } }) => {
+  const errors = []
+  if (nextConfig.distDir === '.next') {
+    errors.push(
+      "- 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')) {
+    errors.push(
+      "Please set the 'publish' value in your Netlify build config to a folder inside your app directory. e.g. 'apps/myapp/out'",
+    )
+  }
+
+  const expectedConfigFile = path.resolve(netlifyConfig.build.publish, '..', 'next.config.js')
+
+  if (expectedConfigFile !== nextConfig.configFile) {
+    const confName = path.relative(process.cwd(), nextConfig.configFile)
+    errors.push(
+      `- Using incorrect config file '${confName}'. Expected to use '${path.relative(
+        process.cwd(),
+        expectedConfigFile,
+      )}'`,
+    )
+
+    if (existsSync(expectedConfigFile)) {
+      errors.push(
+        `Please move or delete '${confName}'${confName === 'next.config.js' ? ' from the root of your site' : ''}.`,
+      )
+    } else {
+      errors.push(
+        `Please move or delete '${confName}'${
+          confName === 'next.config.js' ? ' from the root of your site' : ''
+        }, and create '${path.relative(process.cwd(), expectedConfigFile)}' instead.`,
+      )
+    }
+  }
+
+  if (errors.length !== 0) {
+    failBuild(
+      // TODO: Add ntl.fyi link to docs
+      ['Invalid configuration', ...errors, 'See the docs on using Nx with Netlify for more information'].join(EOL),
+    )
+  }
+}
+
+module.exports = checkNxConfig

helpers/getNextRoot.js

@@ -0,0 +1,12 @@
+const { existsSync } = require('fs')
+const path = require('path')
+
+const getNextRoot = ({ netlifyConfig }) => {
+  let nextRoot = process.cwd()
+  if (!existsSync(path.join(nextRoot, 'next.config.js')) && netlifyConfig.build.publish) {
+    nextRoot = path.dirname(netlifyConfig.build.publish)
+  }
+  return nextRoot
+}
+
+module.exports = getNextRoot

helpers/validateNextUsage.js

@@ -1,5 +1,5 @@
-const { lt: ltVersion, gte: gteVersion } = require('semver')
 const { yellowBright } = require('chalk')
+const { lt: ltVersion, gte: gteVersion } = require('semver')
 
 // Ensure Next.js is available.
 // We use `peerDependencies` instead of `dependencies` so that users can choose

helpers/verifyBuildTarget.js

@@ -1,11 +1,16 @@
-const getNextConfig = require('./getNextConfig')
-const findUp = require('find-up')
-const { writeFile, unlink } = require('fs-extra')
 const path = require('path')
 
+const { writeFile } = require('fs-extra')
+
+const getNextConfig = require('./getNextConfig')
+const getNextRoot = require('./getNextRoot')
+
 // Checks if site has the correct next.config.js
-const verifyBuildTarget = async ({ failBuild }) => {
-  const { target } = await getNextConfig(failBuild)
+const verifyBuildTarget = async ({ failBuild, netlifyConfig }) => {
+  const nextRoot = getNextRoot({ netlifyConfig })
+
+  const { target, configFile, ...rest } = await getNextConfig(failBuild, nextRoot)
+  console.log({ target, rest, configFile, nextRoot })
 
   // If the next config exists, log warning if target isnt in acceptableTargets
   const acceptableTargets = ['serverless', 'experimental-serverless-trace']
@@ -19,8 +24,6 @@ const verifyBuildTarget = async ({ failBuild }) => {
     )}". Building with "serverless" target.`,
   )
 
-  /* eslint-disable fp/no-delete, node/no-unpublished-require */
-
   // We emulate Vercel so that we can set target to serverless if needed
   process.env.NOW_BUILDER = true
   // If no valid target is set, we use an internal Next env var to force it
@@ -29,30 +32,31 @@ const verifyBuildTarget = async ({ failBuild }) => {
   // 🐉 We need Next to recalculate "isZeitNow" var so we can set the target, but it's
   // set as an import side effect so we need to clear the require cache first. 🐲
   // https://github.com/vercel/next.js/blob/canary/packages/next/telemetry/ci-info.ts
+  /* eslint-disable node/no-unpublished-require */
 
   delete require.cache[require.resolve('next/dist/telemetry/ci-info')]
   delete require.cache[require.resolve('next/dist/next-server/server/config')]
 
+  /* eslint-enable node/no-unpublished-require */
+
   // Clear memoized cache
   getNextConfig.clear()
 
   // Creating a config file, because otherwise Next won't reload the config and pick up the new target
 
-  if (!(await findUp('next.config.js'))) {
+  if (!configFile) {
     await writeFile(
       path.resolve('next.config.js'),
       `module.exports = {
-  // Supported targets are "serverless" and "experimental-serverless-trace"
-  target: "serverless"
-}`,
+    // Supported targets are "serverless" and "experimental-serverless-trace"
+    target: "serverless"
+  }`,
     )
   }
   // Force the new config to be generated
-  await getNextConfig(failBuild)
-
+  await getNextConfig(failBuild, nextRoot)
   // Reset the value in case something else is looking for it
   process.env.NOW_BUILDER = false
-  /* eslint-enable fp/no-delete, node/no-unpublished-require */
 }
 
 module.exports = verifyBuildTarget

index.js

@@ -1,19 +1,22 @@
+const path = require('path')
+
 const makeDir = require('make-dir')
 
 const { restoreCache, saveCache } = require('./helpers/cacheBuild')
+const checkNxConfig = require('./helpers/checkNxConfig')
 const copyUnstableIncludedDirs = require('./helpers/copyUnstableIncludedDirs')
 const doesNotNeedPlugin = require('./helpers/doesNotNeedPlugin')
 const getNextConfig = require('./helpers/getNextConfig')
+const getNextRoot = require('./helpers/getNextRoot')
 const validateNextUsage = require('./helpers/validateNextUsage')
 const verifyBuildTarget = require('./helpers/verifyBuildTarget')
 const nextOnNetlify = require('./src')
-
 // * Helpful Plugin Context *
 // - Between the prebuild and build steps, the project's build command is run
 // - Between the build and postbuild steps, any functions are bundled
 
 module.exports = {
-  async onPreBuild({ netlifyConfig, packageJson, utils }) {
+  async onPreBuild({ netlifyConfig, packageJson, utils, constants }) {
     const { failBuild } = utils.build
 
     validateNextUsage(failBuild)
@@ -29,9 +32,19 @@ module.exports = {
 
     // Populates the correct config if needed
     await verifyBuildTarget({ netlifyConfig, packageJson, failBuild })
+    const nextRoot = getNextRoot({ netlifyConfig })
 
     // Because we memoize nextConfig, we need to do this after the write file
-    const nextConfig = await getNextConfig(utils.failBuild)
+    const nextConfig = await getNextConfig(utils.failBuild, nextRoot)
+
+    const isNx = Boolean(
+      (packageJson.devDependencies && packageJson.devDependencies['@nrwl/next']) ||
+        (packageJson.dependencies && packageJson.dependencies['@nrwl/next']),
+    )
+
+    if (isNx) {
+      checkNxConfig({ netlifyConfig, packageJson, nextConfig, failBuild, constants })
+    }
 
     if (nextConfig.images.domains.length !== 0 && !process.env.NEXT_IMAGE_ALLOWED_DOMAINS) {
       console.log(
@@ -50,6 +63,8 @@ module.exports = {
   }) {
     const { failBuild } = utils.build
 
+    const nextRoot = getNextRoot({ netlifyConfig })
+
     if (doesNotNeedPlugin({ netlifyConfig, packageJson, failBuild })) {
       return
     }
@@ -58,18 +73,24 @@ module.exports = {
 
     await makeDir(PUBLISH_DIR)
 
-    await nextOnNetlify({ functionsDir: FUNCTIONS_SRC, publishDir: PUBLISH_DIR })
+    await nextOnNetlify({
+      functionsDir: path.resolve(FUNCTIONS_SRC),
+      publishDir: netlifyConfig.build.publish,
+      nextRoot,
+    })
   },
 
-  async onPostBuild({ netlifyConfig, packageJson, constants: { FUNCTIONS_DIST }, utils }) {
+  async onPostBuild({ netlifyConfig, packageJson, constants: { FUNCTIONS_DIST = DEFAULT_FUNCTIONS_DIST }, utils }) {
     if (doesNotNeedPlugin({ netlifyConfig, packageJson, utils })) {
       return
     }
+    const nextRoot = getNextRoot({ netlifyConfig })
 
-    const nextConfig = await getNextConfig(utils.failBuild)
+    const nextConfig = await getNextConfig(utils.failBuild, nextRoot)
     await saveCache({ cache: utils.cache, distDir: nextConfig.distDir })
-    copyUnstableIncludedDirs({ nextConfig, functionsDist: FUNCTIONS_DIST })
+    copyUnstableIncludedDirs({ nextConfig, functionsDist: path.resolve(FUNCTIONS_DIST) })
   },
 }
 
 const DEFAULT_FUNCTIONS_SRC = 'netlify/functions'
+const DEFAULT_FUNCTIONS_DIST = '.netlify/functions/'

netlify.toml

@@ -1,2 +1,11 @@
 [build]
-base="demo/"
+command = "npm run build:demo"
+functions = "demo/netlify/functions"
+publish = "demo/out"
+base="."
+
+[dev]
+command="npm run dev:demo"
+
+[[plugins]]
+package="."