use configurable functionsDir and publishDir throughout NoN (netlify#89)

* use configurable functionsDir and publishDir throughout NoN * Update index.js Co-authored-by: ehmicky <ehmicky@users.noreply.github.com>

Author: lindsaylevine

index.js

@@ -3,17 +3,30 @@ const copyPublicFiles = require("./lib/steps/copyPublicFiles");
 const copyNextAssets = require("./lib/steps/copyNextAssets");
 const setupPages = require("./lib/steps/setupPages");
 const setupRedirects = require("./lib/steps/setupRedirects");
+const {
+ NETLIFY_PUBLISH_PATH,
+ NETLIFY_FUNCTIONS_PATH,
+} = require("./lib/config");
 
-const nextOnNetlify = () => {
- prepareFolders();
+/** options param:
+ * {
+ * functionsDir: string to path
+ * publishDir: string to path
+ * }
+ */
+const nextOnNetlify = (options = {}) => {
+ const functionsPath = options.functionsDir || NETLIFY_FUNCTIONS_PATH;
+ const publishPath = options.publishDir || NETLIFY_PUBLISH_PATH;
 
- copyPublicFiles();
+ prepareFolders({ functionsPath, publishPath });
 
- copyNextAssets();
+ copyPublicFiles(publishPath);
 
- setupPages();
+ copyNextAssets(publishPath);
 
- setupRedirects();
+ setupPages({ functionsPath, publishPath });
+
+ setupRedirects(publishPath);
 };
 
 module.exports = nextOnNetlify;

lib/helpers/getNextConfig.js

@@ -0,0 +1,12 @@
+// Get next.config.js
+const { PHASE_PRODUCTION_BUILD } = require("next/constants");
+const { default: loadConfig } = require("next/dist/next-server/server/config");
+const { resolve } = require("path");
+
+const getNextConfig = () => {
+ // Load next.config.js
+ // Use same code as https://github.com/vercel/next.js/blob/25488f4a03db30cade4d086ba49cd9a50a2ac02e/packages/next/build/index.ts#L114
+ return loadConfig(PHASE_PRODUCTION_BUILD, resolve("."));
+};
+
+module.exports = getNextConfig;

lib/helpers/getNextDistDir.js

@@ -1,12 +1,9 @@
 // Get the NextJS distDir specified in next.config.js
-const { PHASE_PRODUCTION_BUILD } = require("next/constants");
-const { default: loadConfig } = require("next/dist/next-server/server/config");
-const { resolve, join } = require("path");
+const { join } = require("path");
+const getNextConfig = require("./getNextConfig");
 
 const getNextDistDir = ({ nextConfigPath }) => {
- // Load next.config.js
- // Use same code as https://github.com/vercel/next.js/blob/25488f4a03db30cade4d086ba49cd9a50a2ac02e/packages/next/build/index.ts#L114
- const nextConfig = loadConfig(PHASE_PRODUCTION_BUILD, resolve("."));
+ const nextConfig = getNextConfig();
 
  return join(".", nextConfig.distDir);
 };

lib/helpers/setupNetlifyFunctionForPage.js

@@ -1,17 +1,13 @@
 const { copySync } = require("fs-extra");
 const { join } = require("path");
-const {
- NEXT_DIST_DIR,
- NETLIFY_FUNCTIONS_PATH,
- FUNCTION_TEMPLATE_PATH,
-} = require("../config");
+const { NEXT_DIST_DIR, FUNCTION_TEMPLATE_PATH } = require("../config");
 const getNetlifyFunctionName = require("./getNetlifyFunctionName");
 
 // Create a Netlify Function for the page with the given file path
-const setupNetlifyFunctionForPage = (filePath) => {
+const setupNetlifyFunctionForPage = ({ filePath, functionsPath }) => {
  // Set function name based on file path
  const functionName = getNetlifyFunctionName(filePath);
- const functionDirectory = join(NETLIFY_FUNCTIONS_PATH, functionName);
+ const functionDirectory = join(functionsPath, functionName);
 
  // Copy function template
  const functionTemplateCopyPath = join(

lib/helpers/setupStaticFileForPage.js

@@ -1,16 +1,20 @@
 const { copySync } = require("fs-extra");
 const { join } = require("path");
-const { NEXT_DIST_DIR, NETLIFY_PUBLISH_PATH } = require("../config");
+const { NEXT_DIST_DIR } = require("../config");
 
 // Copy the static asset from pages/inputPath to out_publish/outputPath
-const setupStaticFileForPage = (inputPath, outputPath = null) => {
+const setupStaticFileForPage = ({
+ inputPath,
+ outputPath = null,
+ publishPath,
+}) => {
  // If no outputPath is set, default to the same as inputPath
  outputPath = outputPath || inputPath;
 
  // Perform copy operation
  copySync(
  join(NEXT_DIST_DIR, "serverless", "pages", inputPath),
- join(NETLIFY_PUBLISH_PATH, outputPath),
+ join(publishPath, outputPath),
  {
  overwrite: false,
  errorOnExist: true,

lib/pages/api/setup.js

@@ -1,19 +1,18 @@
 const { logTitle, logItem } = require("../../helpers/logger");
-const { NETLIFY_FUNCTIONS_PATH } = require("../../config");
 const setupNetlifyFunctionForPage = require("../../helpers/setupNetlifyFunctionForPage");
 const pages = require("./pages");
 
 // Create a Netlify Function for every API endpoint
-const setup = () => {
+const setup = (functionsPath) => {
  logTitle(
  "💫 Setting up API endpoints as Netlify Functions in",
- NETLIFY_FUNCTIONS_PATH
+ functionsPath
  );
 
  // Create Netlify Function for every page
  pages.forEach(({ filePath }) => {
  logItem(filePath);
- setupNetlifyFunctionForPage(filePath);
+ setupNetlifyFunctionForPage({ filePath, functionsPath });
  });
 };
 

lib/pages/getInitialProps/setup.js

@@ -1,19 +1,18 @@
 const { logTitle, logItem } = require("../../helpers/logger");
-const { NETLIFY_FUNCTIONS_PATH } = require("../../config");
 const setupNetlifyFunctionForPage = require("../../helpers/setupNetlifyFunctionForPage");
 const pages = require("./pages");
 
 // Create a Netlify Function for every page with getInitialProps
-const setup = () => {
+const setup = (functionsPath) => {
  logTitle(
  "💫 Setting up pages with getInitialProps as Netlify Functions in",
- NETLIFY_FUNCTIONS_PATH
+ functionsPath
  );
 
  // Create Netlify Function for every page
  pages.forEach(({ filePath }) => {
  logItem(filePath);
- setupNetlifyFunctionForPage(filePath);
+ setupNetlifyFunctionForPage({ filePath, functionsPath });
  });
 };
 

lib/pages/getServerSideProps/setup.js

@@ -1,19 +1,18 @@
 const { logTitle, logItem } = require("../../helpers/logger");
-const { NETLIFY_FUNCTIONS_PATH } = require("../../config");
 const setupNetlifyFunctionForPage = require("../../helpers/setupNetlifyFunctionForPage");
 const pages = require("./pages");
 
 // Create a Netlify Function for every page with getServerSideProps
-const setup = () => {
+const setup = (functionsPath) => {
  logTitle(
  "💫 Setting up pages with getServerSideProps as Netlify Functions in",
- NETLIFY_FUNCTIONS_PATH
+ functionsPath
  );
 
  // Create Netlify Function for every page
  pages.forEach(({ filePath }) => {
  logItem(filePath);
- setupNetlifyFunctionForPage(filePath);
+ setupNetlifyFunctionForPage({ filePath, functionsPath });
  });
 };
 

lib/pages/getStaticProps/setup.js

@@ -1,17 +1,16 @@
 const { join } = require("path");
 const { logTitle, logItem } = require("../../helpers/logger");
-const { NETLIFY_PUBLISH_PATH } = require("../../config");
 const getFilePathForRoute = require("../../helpers/getFilePathForRoute");
 const isRouteWithFallback = require("../../helpers/isRouteWithFallback");
 const setupStaticFileForPage = require("../../helpers/setupStaticFileForPage");
 const setupNetlifyFunctionForPage = require("../../helpers/setupNetlifyFunctionForPage");
 const pages = require("./pages");
 
 // Copy pre-rendered SSG pages
-const setup = () => {
+const setup = ({ functionsPath, publishPath }) => {
  logTitle(
  "🔥 Copying pre-rendered pages with getStaticProps and JSON data to",
- NETLIFY_PUBLISH_PATH
+ publishPath
  );
 
  // Keep track of the functions that have been set up, so that we do not set up
@@ -23,11 +22,15 @@ const setup = () => {
 
  // Copy pre-rendered HTML page
  const htmlPath = getFilePathForRoute(route, "html");
- setupStaticFileForPage(htmlPath);
+ setupStaticFileForPage({ inputPath: htmlPath, publishPath });
 
  // Copy page's JSON data
  const jsonPath = getFilePathForRoute(route, "json");
- setupStaticFileForPage(jsonPath, dataRoute);
+ setupStaticFileForPage({
+ inputPath: jsonPath,
+ outputPath: dataRoute,
+ publishPath,
+ });
 
  // // Set up the Netlify function (this is ONLY for preview mode)
  const relativePath = getFilePathForRoute(srcRoute || route, "js");
@@ -39,7 +42,7 @@ const setup = () => {
  return;
 
  logItem(filePath);
- setupNetlifyFunctionForPage(filePath);
+ setupNetlifyFunctionForPage({ filePath, functionsPath });
  filePathsDone.push(filePath);
  });
 };

lib/pages/getStaticPropsWithFallback/setup.js

@@ -1,24 +1,23 @@
 const { join } = require("path");
 const { logTitle, logItem } = require("../../helpers/logger");
-const { NETLIFY_FUNCTIONS_PATH } = require("../../config");
 const getFilePathForRoute = require("../../helpers/getFilePathForRoute");
 const setupNetlifyFunctionForPage = require("../../helpers/setupNetlifyFunctionForPage");
 const pages = require("./pages");
 
 // Create a Netlify Function for every page with getStaticProps and fallback
-const setup = () => {
+const setup = (functionsPath) => {
  logTitle(
  "💫 Setting up pages with getStaticProps and fallback: true",
  "as Netlify Functions in",
- NETLIFY_FUNCTIONS_PATH
+ functionsPath
  );
 
  // Create Netlify Function for every page
  pages.forEach(({ route }) => {
  const relativePath = getFilePathForRoute(route, "js");
  const filePath = join("pages", relativePath);
  logItem(filePath);
- setupNetlifyFunctionForPage(filePath);
+ setupNetlifyFunctionForPage({ filePath, functionsPath });
  });
 };