chore: refactor some names

Author: orinokai

src/helpers/config.ts

@@ -5,11 +5,11 @@ import { RUNTIME_DIR } from './constants.js'
 /**
  * Enable Next.js standalone mode
  */
-export const setBuildtimeConfig = () => {
+export const setBuildConfig = () => {
   process.env.NEXT_PRIVATE_STANDALONE = 'true'
 }
 
-export const setRuntimeConfig = async () => {
+export const setRequestConfig = async () => {
   const runtimeConfig = JSON.parse(await readFile('./.next/required-server-files.json', 'utf-8'))
 
   // set the path to the cache handler

src/helpers/files.ts

@@ -6,9 +6,9 @@ import { copySync, moveSync } from 'fs-extra/esm'
 import { NEXT_BUILD_DIR } from './constants.js'
 
 /**
- * Stash the Next.js build output in a temporary directory
+ * Move the Next.js build output to a temporary directory
  */
-export const stashBuildOutput = ({ PUBLISH_DIR }: NetlifyPluginConstants) => {
+export const moveBuildOutput = ({ PUBLISH_DIR }: NetlifyPluginConstants) => {
   moveSync(PUBLISH_DIR, NEXT_BUILD_DIR, { overwrite: true })
 }
 

src/helpers/functions.ts

@@ -13,10 +13,10 @@ const pkg = readJsonSync(`${PLUGIN_DIR}/package.json`)
  * @param config Netlify config
  */
 export const createServerHandler = async () => {
-  // clear the server handler directory
+  // clear the handler directory
   emptyDirSync(SERVER_HANDLER_DIR)
 
-  // trace the server handler dependencies
+  // trace the handler dependencies
   const { fileList } = await nodeFileTrace(
     [`${PLUGIN_DIR}/dist/templates/server-handler.js`, `${PLUGIN_DIR}/dist/templates/cache-handler.cjs`],
     { base: PLUGIN_DIR, ignore: ['package.json', 'node_modules/next/**'] },
@@ -27,11 +27,11 @@ export const createServerHandler = async () => {
     copySync(`${PLUGIN_DIR}/${path}`, `${SERVER_HANDLER_DIR}/${path}`)
   })
 
-  // copy the next.js standalone build output to the server handler directory
+  // copy the next.js standalone build output to the handler directory
   copySync(`${NEXT_BUILD_DIR}/standalone/.next`, `${SERVER_HANDLER_DIR}/.next`)
   copySync(`${NEXT_BUILD_DIR}/standalone/node_modules`, `${SERVER_HANDLER_DIR}/node_modules`)
 
-  // create the server handler metadata file
+  // create the handler metadata file
   writeJSONSync(`${SERVER_HANDLER_DIR}/${SERVER_HANDLER_NAME}.json`, {
     config: {
       name: 'Next.js Server Handler',
@@ -43,8 +43,10 @@ export const createServerHandler = async () => {
     version: 1,
   })
 
+  // config ESM
   writeFileSync(`${SERVER_HANDLER_DIR}/package.json`, JSON.stringify({ type: 'module' }))
 
+  // write the root handler file
   writeFileSync(
     `${SERVER_HANDLER_DIR}/${SERVER_HANDLER_NAME}.js`,
     `import handler from './dist/templates/server-handler.js';export default handler;export const config = { path: '/*' }`,

src/index.ts

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

src/templates/server-handler.ts

@@ -8,8 +8,8 @@ let nextHandler: WorkerRequestHandler
 export default async (request: Request) => {
   if (!nextHandler) {
     // set the server config
-    const { setRuntimeConfig } = await import('../helpers/config.js')
-    await setRuntimeConfig()
+    const { setRequestConfig } = await import('../helpers/config.js')
+    await setRequestConfig()
 
     // let Next.js initialize and create the request handler
     const { getRequestHandlers } = await import('next/dist/server/lib/start-server.js')