chore: update code comments

Author: orinokai

src/handlers/cache.cts

@@ -1,3 +1,8 @@
+/**
+ * Netlify Cache Handler
+ * (CJS format because Next.js doesn't support ESM yet)
+ */
+
 export default class CacheHandler {
  options: any
  cache: Map<string, any>

src/helpers/config.ts

@@ -3,13 +3,17 @@ import { readFile } from 'node:fs/promises'
 import { TASK_DIR } from './constants.js'
 
 /**
- * Enable Next.js standalone mode
+ * Enable standalone mode at build-time
  */
 export const setBuildConfig = () => {
  process.env.NEXT_PRIVATE_STANDALONE = 'true'
 }
 
+/**
+ * Configure the request-time custom cache handler
+ */
 export const setRequestConfig = async () => {
+ // get config from the build output
  const runtimeConfig = JSON.parse(await readFile(`${TASK_DIR}/.next/required-server-files.json`, 'utf-8'))
 
  // set the path to the cache handler
@@ -18,6 +22,6 @@ export const setRequestConfig = async () => {
  incrementalCacheHandlerPath: `${TASK_DIR}/dist/handlers/cache.cjs`,
  }
 
- // set config from the build output
+ // set config
  process.env.__NEXT_PRIVATE_STANDALONE_CONFIG = JSON.stringify(runtimeConfig.config)
 }

src/helpers/files.ts

@@ -6,16 +6,16 @@ import { copySync, moveSync } from 'fs-extra/esm'
 import { BUILD_DIR } from './constants.js'
 
 /**
- * Move the Next.js build output to a temporary directory
+ * Move the Next.js build output from the publish dir to a temp dir
  */
-export const moveBuildOutput = ({ PUBLISH_DIR }: NetlifyPluginConstants) => {
+export const stashBuildOutput = ({ PUBLISH_DIR }: NetlifyPluginConstants) => {
  moveSync(PUBLISH_DIR, BUILD_DIR, { overwrite: true })
 }
 
 /**
- * Move static assets so they are uploaded to the Netlify CDN
+ * Move static assets to the publish dir so they upload to the CDN
  */
-export const moveStaticAssets = ({ PUBLISH_DIR }: NetlifyPluginConstants) => {
+export const publishStaticAssets = ({ PUBLISH_DIR }: NetlifyPluginConstants) => {
  if (existsSync('public')) {
  copySync('public', PUBLISH_DIR)
  }

src/helpers/functions.ts

@@ -9,8 +9,6 @@ const pkg = readJsonSync(`${PLUGIN_DIR}/package.json`)
 
 /**
  * Create a Netlify function to run the Next.js server
- * @param publishDir The publish directory
- * @param config Netlify config
  */
 export const createServerHandler = async () => {
  // clear the handler directory
@@ -43,7 +41,7 @@ export const createServerHandler = async () => {
  version: 1,
  })
 
- // config ESM
+ // configure ESM
  writeFileSync(`${SERVER_HANDLER_DIR}/package.json`, JSON.stringify({ type: 'module' }))
 
  // write the root handler file

src/index.ts

@@ -1,7 +1,7 @@
 import type { NetlifyPluginOptions } from '@netlify/build'
 
 import { setBuildConfig } from './helpers/config.js'
-import { moveStaticAssets, moveBuildOutput } from './helpers/files.js'
+import { publishStaticAssets, stashBuildOutput } from './helpers/files.js'
 import { createServerHandler } from './helpers/functions.js'
 
 type NetlifyPluginOptionsWithFlags = NetlifyPluginOptions & { featureFlags?: Record<string, unknown> }
@@ -11,7 +11,7 @@ export const onPreBuild = () => {
 }
 
 export const onBuild = async ({ constants }: NetlifyPluginOptionsWithFlags) => {
- moveBuildOutput(constants)
- moveStaticAssets(constants)
+ stashBuildOutput(constants)
+ publishStaticAssets(constants)
  await createServerHandler()
 }