Add logger.js utility: Helpers for logging build info

The logger.js utility is a light wrapper on console.log. It takes care 
of bold formatting for titles and indents items by three spaces.

Author: FinnWoelm

lib/copyNextAssets.js

@@ -1,11 +1,12 @@
 const { join }                                = require('path')
 const { copySync }                            = require('fs-extra')
+const { logTitle }                            = require('./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.
 const copyNextAssets = () => {
-  console.log(`\x1b[1m💼 Copying static NextJS assets to ${NETLIFY_PUBLISH_PATH}\x1b[22m`)
+  logTitle("💼 Copying static NextJS assets to", NETLIFY_PUBLISH_PATH)
   copySync(
     join(NEXT_DIST_DIR,         "static"),
     join(NETLIFY_PUBLISH_PATH,  "_next",  "static"),

lib/copyPublicFiles.js

@@ -1,4 +1,5 @@
 const { existsSync, copySync }              = require('fs-extra')
+const { logTitle }                          = require('./logger')
 const { NETLIFY_PUBLISH_PATH, PUBLIC_PATH } = require('./config')
 
 // Copy files from public folder to Netlify publish folder
@@ -8,7 +9,7 @@ const copyPublicFiles = () => {
     return
 
   // Perform copy operation
-  console.log(`\x1b[1m🌍️ Copying ${PUBLIC_PATH} folder to ${NETLIFY_PUBLISH_PATH}\x1b[22m`)
+  logTitle("🌍️ Copying", PUBLIC_PATH, "folder to", NETLIFY_PUBLISH_PATH)
   copySync(PUBLIC_PATH, NETLIFY_PUBLISH_PATH)
 }
 

lib/logger.js

@@ -0,0 +1,19 @@
+// Helpers for writing info to console.log
+
+// Format in bold
+const logTitle = (...args) =>
+  log(`\x1b[1m${args.join(" ")}\x1b[22m`)
+
+// Indent by three spaces
+const logItem = (...args) =>
+  log('  ', ...args)
+
+// Just console.log
+const log = (...args) =>
+  console.log(...args)
+
+module.exports = {
+  logTitle,
+  logItem,
+  log
+}

lib/prepareFolders.js

@@ -1,12 +1,13 @@
 const { emptyDirSync }                                  = require('fs-extra')
+const { logTitle, log }                                 = require('./logger')
 const { NETLIFY_PUBLISH_PATH, NETLIFY_FUNCTIONS_PATH }  = require('./config')
 
 // Empty existing publish and functions folders
 const prepareFolders = () => {
-  console.log("\x1b[1m🚀 Next on Netlify 🚀\x1b[22m")
-  console.log("   Functions directory:", NETLIFY_PUBLISH_PATH)
-  console.log("   Publish directory:  ", NETLIFY_FUNCTIONS_PATH)
-  console.log("   Make sure these are set in your netlify.toml file.")
+  logTitle("🚀 Next on Netlify 🚀")
+  log("  ", "Functions directory:", NETLIFY_PUBLISH_PATH)
+  log("  ", "Publish directory:  ", NETLIFY_FUNCTIONS_PATH)
+  log("  ", "Make sure these are set in your netlify.toml file.")
 
   emptyDirSync(NETLIFY_PUBLISH_PATH)
   emptyDirSync(NETLIFY_FUNCTIONS_PATH)

lib/setupHtmlPages.js

@@ -1,20 +1,21 @@
 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')
 
 // Identify all pages that have been pre-rendered and copy each one to the
 // Netlify publish directory.
 const setupHtmlPages = () => {
-  console.log(`\x1b[1m📝 Writing pre-rendered HTML pages to ${NETLIFY_PUBLISH_PATH}\x1b[22m`)
+  logTitle("📝 Writing pre-rendered HTML pages to", NETLIFY_PUBLISH_PATH)
 
   // Get HTML pages
   const htmlPages = allNextJsPages.filter(page => page.isHtml())
 
   // Copy each page to the Netlify publish directory
   htmlPages.forEach(({ filePath }) => {
-    console.log("  ", filePath)
+    logItem(filePath)
 
     // The path to the file, relative to the pages directory
     const relativePath = path.relative("pages", filePath)

lib/setupRedirects.js

@@ -4,6 +4,7 @@ const { existsSync, readFileSync,
         writeFileSync }           = require('fs-extra')
 const { default: isDynamicRoute } = require("@sls-next/lambda-at-edge/dist/lib/isDynamicRoute")
 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')
@@ -13,12 +14,12 @@ const getNetlifyFunctionName      = require('./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.
 const setupRedirects = () => {
-  console.log("\x1b[1m🔀 Setting up redirects\x1b[22m")
+  logTitle("🔀 Setting up redirects")
 
   // Step 1: Collect custom redirects defined by the user
   const customRedirects = []
   if(existsSync(CUSTOM_REDIRECTS_PATH)) {
-    console.log("  ", "# Prepending custom redirects")
+    logItem("# Prepending custom redirects")
     customRedirects.push(readFileSync(CUSTOM_REDIRECTS_PATH))
   }
 
@@ -75,7 +76,7 @@ const setupRedirects = () => {
 
       // Assemble redirect
       const redirect = `${from}  ${to}  200`
-      console.log("  ", redirect)
+      logItem(redirect)
 
       nextOnNetlifyRedirects.push(redirect)
     })

lib/setupSsgPages.js

@@ -1,6 +1,7 @@
 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,
         NETLIFY_FUNCTIONS_PATH,
         FUNCTION_TEMPLATE_PATH }              = require('./config')
@@ -10,17 +11,17 @@ const getNetlifyFunctionName                  = require('./getNetlifyFunctionNam
 // Identify all pages that require server-side rendering and create a separate
 // Netlify Function for every page.
 const setupSsgPages = () => {
-  console.log(`\x1b[1m🔥 Setting up SSG pages\x1b[22m`)
+  logTitle("🔥 Setting up SSG pages")
 
   // Get SSG pages
   const ssgPages = allNextJsPages.filter(page => page.isSsg())
 
   // Copy pre-rendered SSG pages to Netlify publish folder
-  console.log("  ", "1. Copying pre-rendered SSG pages to", NETLIFY_PUBLISH_PATH)
+  logItem("1. Copying pre-rendered SSG pages to", NETLIFY_PUBLISH_PATH)
 
   ssgPages.forEach(({ htmlFile }) => {
     const filePath = join("pages", htmlFile)
-    console.log("  ", "  ", filePath)
+    logItem("  ", filePath)
 
     copySync(
       join(NEXT_DIST_DIR,         "serverless",     filePath),
@@ -34,11 +35,11 @@ const setupSsgPages = () => {
 
   // Copy SSG page data to _next/data/ folder
   const nextDataFolder = join(NETLIFY_PUBLISH_PATH, "_next", "data/")
-  console.log("  ", "2. Copying SSG page data to", nextDataFolder)
+  logItem("2. Copying SSG page data to", nextDataFolder)
 
   ssgPages.forEach(({ jsonFile, dataRoute }) => {
     const dataPath = join("pages", jsonFile)
-    console.log("  ", "  ", dataPath)
+    logItem("  ", dataPath)
 
     copySync(
       join(NEXT_DIST_DIR,         "serverless", dataPath),
@@ -52,10 +53,10 @@ const setupSsgPages = () => {
 
   // Set up Netlify Functions to handle fallbacks for SSG pages
   const ssgFallbackPages = allNextJsPages.filter(page => page.isSsgFallback())
-  console.log("  ", "3. Setting up Netlify Functions for SSG pages with fallback: true")
+  logItem("3. Setting up Netlify Functions for SSG pages with fallback: true")
 
   ssgFallbackPages.forEach(({ filePath }) => {
-    console.log("  ", "  ", filePath)
+    logItem("  ", filePath)
 
     // Set function name based on file path
     const functionName      = getNetlifyFunctionName(filePath)

lib/setupSsrPages.js

@@ -1,6 +1,7 @@
 const path                                              = require('path')
 const { join }                                          = path
 const { copySync, existsSync }                          = require('fs-extra')
+const { logTitle, logItem }                             = require('./logger')
 const { NEXT_DIST_DIR, NETLIFY_FUNCTIONS_PATH,
         FUNCTION_TEMPLATE_PATH }                        = require('./config')
 const allNextJsPages                                    = require('./allNextJsPages')
@@ -9,14 +10,14 @@ const getNetlifyFunctionName                            = require('./getNetlifyF
 // Identify all pages that require server-side rendering and create a separate
 // Netlify Function for every page.
 const setupSsrPages = () => {
-  console.log(`\x1b[1m💫 Setting up SSR pages as Netlify Functions in ${NETLIFY_FUNCTIONS_PATH}\x1b[22m`)
+  logTitle("💫 Setting up SSR pages as Netlify Functions in", NETLIFY_FUNCTIONS_PATH)
 
   // Get SSR pages
   const ssrPages = allNextJsPages.filter(page => page.isSsr())
 
   // Create Netlify Function for every page
   ssrPages.forEach(({ filePath }) => {
-    console.log("  ", filePath)
+    logItem(filePath)
 
     // Set function name based on file path
     const functionName      = getNetlifyFunctionName(filePath)