Refactor: Move build steps into lib/steps and helpers into lib/helpers

Clean up the list of files under lib by grouping them into build steps
and helper files. Build steps are the functions that are directly called
from the next-on-netlify.js file at root level. Helpers are auxiliary
functions used in one of the build steps.

Author: FinnWoelm

lib/config.js

@@ -1,5 +1,5 @@
 const { join } = require("path");
-const getNextDistDir = require("./getNextDistDir");
+const getNextDistDir = require("./helpers/getNextDistDir");
 
 // This is where next-on-netlify will place all static files.
 // The publish key in netlify.toml should point to this folder.

lib/getNetlifyFunctionName.js renamed to lib/helpers/getNetlifyFunctionName.js

@@ -1,7 +1,7 @@
 const { join } = require("path");
 const { copySync } = require("fs-extra");
-const { logTitle } = require("./logger");
-const { NETLIFY_PUBLISH_PATH, NEXT_DIST_DIR } = require("./config");
+const { logTitle } = require("../helpers/logger");
+const { NETLIFY_PUBLISH_PATH, NEXT_DIST_DIR } = require("../config");
 
 // Copy the NextJS' static assets from NextJS distDir to Netlify publish folder.
 // These need to be available for NextJS to work.

lib/getNetlifyRoute.js renamed to lib/helpers/getNetlifyRoute.js

@@ -1,6 +1,6 @@
 const { existsSync, copySync } = require("fs-extra");
-const { logTitle } = require("./logger");
-const { NETLIFY_PUBLISH_PATH, PUBLIC_PATH } = require("./config");
+const { logTitle } = require("../helpers/logger");
+const { NETLIFY_PUBLISH_PATH, PUBLIC_PATH } = require("../config");
 
 // Copy files from public folder to Netlify publish folder
 const copyPublicFiles = () => {

lib/getNextDistDir.js renamed to lib/helpers/getNextDistDir.js

@@ -1,6 +1,6 @@
 const { emptyDirSync } = require("fs-extra");
-const { logTitle, log } = require("./logger");
-const { NETLIFY_PUBLISH_PATH, NETLIFY_FUNCTIONS_PATH } = require("./config");
+const { logTitle, log } = require("../helpers/logger");
+const { NETLIFY_PUBLISH_PATH, NETLIFY_FUNCTIONS_PATH } = require("../config");
 
 // Empty existing publish and functions folders
 const prepareFolders = () => {

lib/logger.js renamed to lib/helpers/logger.js

@@ -1,9 +1,9 @@
 const path = require("path");
 const { join } = path;
 const { copySync, existsSync } = require("fs-extra");
-const { logTitle, logItem } = require("./logger");
-const { NEXT_DIST_DIR, NETLIFY_PUBLISH_PATH } = require("./config");
-const allNextJsPages = require("./allNextJsPages");
+const { logTitle, logItem } = require("../helpers/logger");
+const { NEXT_DIST_DIR, NETLIFY_PUBLISH_PATH } = require("../config");
+const allNextJsPages = require("../allNextJsPages");
 
 // Identify all pages that have been pre-rendered and copy each one to the
 // Netlify publish directory.

lib/copyNextAssets.js renamed to lib/steps/copyNextAssets.js

@@ -7,11 +7,11 @@ const {
 const {
   getSortedRoutes,
 } = require("@sls-next/lambda-at-edge/dist/lib/sortedRoutes");
-const { logTitle, logItem } = require("./logger");
-const { NETLIFY_PUBLISH_PATH, CUSTOM_REDIRECTS_PATH } = require("./config");
-const allNextJsPages = require("./allNextJsPages");
-const getNetlifyRoute = require("./getNetlifyRoute");
-const getNetlifyFunctionName = require("./getNetlifyFunctionName");
+const { logTitle, logItem } = require("../helpers/logger");
+const { NETLIFY_PUBLISH_PATH, CUSTOM_REDIRECTS_PATH } = require("../config");
+const allNextJsPages = require("../allNextJsPages");
+const getNetlifyRoute = require("../helpers/getNetlifyRoute");
+const getNetlifyFunctionName = require("../helpers/getNetlifyFunctionName");
 
 // Setup _redirects file that routes all requests to the appropriate location:
 // Either the relevant Netlify function or one of the pre-rendered HTML pages.

lib/copyPublicFiles.js renamed to lib/steps/copyPublicFiles.js

@@ -1,15 +1,15 @@
 const path = require("path");
 const { join } = path;
 const { copySync, existsSync } = require("fs-extra");
-const { logTitle, logItem } = require("./logger");
+const { logTitle, logItem } = require("../helpers/logger");
 const {
   NEXT_DIST_DIR,
   NETLIFY_PUBLISH_PATH,
   NETLIFY_FUNCTIONS_PATH,
   FUNCTION_TEMPLATE_PATH,
-} = require("./config");
-const allNextJsPages = require("./allNextJsPages");
-const getNetlifyFunctionName = require("./getNetlifyFunctionName");
+} = require("../config");
+const allNextJsPages = require("../allNextJsPages");
+const getNetlifyFunctionName = require("../helpers/getNetlifyFunctionName");
 
 // Identify all pages that require server-side rendering and create a separate
 // Netlify Function for every page.

lib/prepareFolders.js renamed to lib/steps/prepareFolders.js

@@ -1,14 +1,14 @@
 const path = require("path");
 const { join } = path;
 const { copySync, existsSync } = require("fs-extra");
-const { logTitle, logItem } = require("./logger");
+const { logTitle, logItem } = require("../helpers/logger");
 const {
   NEXT_DIST_DIR,
   NETLIFY_FUNCTIONS_PATH,
   FUNCTION_TEMPLATE_PATH,
-} = require("./config");
-const allNextJsPages = require("./allNextJsPages");
-const getNetlifyFunctionName = require("./getNetlifyFunctionName");
+} = require("../config");
+const allNextJsPages = require("../allNextJsPages");
+const getNetlifyFunctionName = require("../helpers/getNetlifyFunctionName");
 
 // Identify all pages that require server-side rendering and create a separate
 // Netlify Function for every page.

lib/setupHtmlPages.js renamed to lib/steps/setupHtmlPages.js

@@ -9,14 +9,14 @@ program
   )
   .parse(process.argv);
 
-const { logTitle } = require("./lib/logger");
-const prepareFolders = require("./lib/prepareFolders");
-const copyPublicFiles = require("./lib/copyPublicFiles");
-const copyNextAssets = require("./lib/copyNextAssets");
-const setupSsrPages = require("./lib/setupSsrPages");
-const setupSsgPages = require("./lib/setupSsgPages");
-const setupHtmlPages = require("./lib/setupHtmlPages");
-const setupRedirects = require("./lib/setupRedirects");
+const { logTitle } = require("./lib/helpers/logger");
+const prepareFolders = require("./lib/steps/prepareFolders");
+const copyPublicFiles = require("./lib/steps/copyPublicFiles");
+const copyNextAssets = require("./lib/steps/copyNextAssets");
+const setupSsrPages = require("./lib/steps/setupSsrPages");
+const setupSsgPages = require("./lib/steps/setupSsgPages");
+const setupHtmlPages = require("./lib/steps/setupHtmlPages");
+const setupRedirects = require("./lib/steps/setupRedirects");
 
 prepareFolders();