Merge pull request #124 from netlify/fix/get-next-config

fix: fix errors while loading `next.config.js`

Author: ehmicky

helpers/doesNotNeedPlugin.js

@@ -5,15 +5,15 @@ const isStaticExportProject = require('./isStaticExportProject')
 const doesSiteUseNextOnNetlify = require('./doesSiteUseNextOnNetlify')
 const hasCorrectNextConfig = require('./hasCorrectNextConfig')
 
-const doesNotNeedPlugin = async ({ netlifyConfig, packageJson, utils }) => {
+const doesNotNeedPlugin = async ({ netlifyConfig, packageJson, failBuild }) => {
   const { build } = netlifyConfig
   const { name, scripts = {} } = packageJson
   const nextConfigPath = await findUp('next.config.js')
 
   return (
     isStaticExportProject({ build, scripts }) ||
     doesSiteUseNextOnNetlify({ packageJson }) ||
-    !(await hasCorrectNextConfig({ nextConfigPath, failBuild: utils.build.failBuild }))
+    !(await hasCorrectNextConfig({ nextConfigPath, failBuild }))
   )
 }
 

helpers/getNextConfig.js

@@ -3,7 +3,7 @@ const { resolve } = require('path')
 let nextConfig
 
 // Load next.config.js
-const getNextConfig = async function (failBuild) {
+const getNextConfig = async function (failBuild = defaultFailBuild) {
   // Memoizes `nextConfig`
   if (nextConfig !== undefined) {
     return nextConfig
@@ -23,4 +23,8 @@ const getNextConfig = async function (failBuild) {
   return nextConfig
 }
 
+const defaultFailBuild = function (message, { error }) {
+  throw new Error(`${message}\n${error.stack}`)
+}
+
 module.exports = getNextConfig

index.js

@@ -25,7 +25,7 @@ module.exports = {
       return failBuild('Could not find a package.json for this project')
     }
 
-    if (await doesNotNeedPlugin({ netlifyConfig, packageJson, utils })) {
+    if (await doesNotNeedPlugin({ netlifyConfig, packageJson, failBuild })) {
       return
     }
 
@@ -46,7 +46,9 @@ module.exports = {
     constants: { PUBLISH_DIR, FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC },
     utils,
   }) {
-    if (await doesNotNeedPlugin({ netlifyConfig, packageJson, utils })) {
+    const { failBuild } = utils.build
+
+    if (await doesNotNeedPlugin({ netlifyConfig, packageJson, failBuild })) {
       return
     }
 

src/lib/helpers/getI18n.js

@@ -1,5 +1,5 @@
 // Get the i1i8n details specified in next.config.js, if any
-const getNextConfig = require('./getNextConfig')
+const getNextConfig = require('../../../helpers/getNextConfig')
 
 const getI18n = async () => {
   const nextConfig = await getNextConfig()

src/lib/helpers/getNextConfig.js

@@ -1,6 +1,6 @@
 // Get the NextJS distDir specified in next.config.js
 const { join } = require('path')
-const getNextConfig = require('./getNextConfig')
+const getNextConfig = require('../../../helpers/getNextConfig')
 
 const getNextDistDir = async () => {
   const nextConfig = await getNextConfig()

src/lib/helpers/getNextDistDir.js

@@ -1,6 +1,6 @@
 const { join } = require('path')
 const { readJSONSync } = require('fs-extra')
-const getNextConfig = require('./getNextConfig')
+const getNextConfig = require('../../../helpers/getNextConfig')
 const getNextDistDir = require('./getNextDistDir')
 const getDataRouteForRoute = require('./getDataRouteForRoute')
 const asyncForEach = require('./asyncForEach')