chore: moved writeFunctionConfiguration to a separate utils folder

Author: nickytonline

packages/runtime/src/helpers/functions.ts

@@ -2,7 +2,6 @@ import type { NetlifyConfig, NetlifyPluginConstants } from '@netlify/build'
 import bridgeFile from '@vercel/node-bridge'
 import chalk from 'chalk'
 import destr from 'destr'
-import { resolveModuleRoot } from './config'
 import { copyFile, ensureDir, existsSync, readJSON, writeFile, writeJSON } from 'fs-extra'
 import type { ImageConfigComplete, RemotePattern } from 'next/dist/shared/lib/image-config'
 import { outdent } from 'outdent'
@@ -13,8 +12,6 @@ import {
   ODB_FUNCTION_NAME,
   IMAGE_FUNCTION_NAME,
   DEFAULT_FUNCTIONS_SRC,
-  NEXT_PLUGIN,
-  NEXT_PLUGIN_NAME,
   HANDLER_FUNCTION_TITLE,
   ODB_FUNCTION_TITLE,
   IMAGE_FUNCTION_TITLE,
@@ -25,6 +22,7 @@ import { getResolverForPages, getResolverForSourceFiles } from '../templates/get
 
 import { ApiConfig, ApiRouteType, extractConfigFromFile } from './analysis'
 import { getSourceFileForPage } from './files'
+import { writeFunctionConfiguration } from './utilities/functions'
 import { getFunctionNameForPage } from './utils'
 
 export interface ApiRouteConfig {
@@ -33,37 +31,6 @@ export interface ApiRouteConfig {
   compiled: string
 }
 
-const checkForPackage = async (packageDir: string, nodeModule: boolean) => {
-  const packagePlugin = existsSync(packageDir) ? await readJSON(packageDir) : null
-  let nextPlugin
-  if (!nodeModule && packagePlugin){
-    nextPlugin = packagePlugin.dependencies[NEXT_PLUGIN] ? packagePlugin.dependencies[NEXT_PLUGIN] : null
-  }else if (nodeModule && packagePlugin){
-    nextPlugin = packagePlugin.version ? packagePlugin.version : null
-  }
-
-  return nextPlugin
-}
-
-const writeFunctionConfiguration = async (functionName: string, functionTitle: string, functionsDir: string) => {
-  const pluginPackagePath = '.netlify/plugins/package.json'
-  const ProjDir = resolveModuleRoot(NEXT_PLUGIN)
-  const nodeModulesPath = `${ProjDir}/package.json`
-  
-  const nextPluginVersion =
-    (await checkForPackage(nodeModulesPath, true)) || (await checkForPackage(pluginPackagePath, false))
-
-  const metadata = {
-    config: {
-      name: functionTitle,
-      generator: nextPluginVersion ? `${NEXT_PLUGIN_NAME}@${nextPluginVersion}` : 'Next Runtime Version Not Found',
-    },
-    version: 1,
-  }
-
-  await writeFile(join(functionsDir, functionName, `${functionName}.json`), JSON.stringify(metadata))
-}
-
 export const generateFunctions = async (
   { FUNCTIONS_SRC = DEFAULT_FUNCTIONS_SRC, INTERNAL_FUNCTIONS_SRC, PUBLISH_DIR }: NetlifyPluginConstants,
   appDir: string,

packages/runtime/src/helpers/utilities/functions.ts

@@ -0,0 +1,43 @@
+import { existsSync, readJSON, writeFile } from 'fs-extra'
+import { join } from 'pathe'
+
+import { NEXT_PLUGIN, NEXT_PLUGIN_NAME } from '../../constants'
+import { resolveModuleRoot } from '../config'
+
+const checkForPackage = async (packageDir: string, nodeModule: boolean) => {
+  const packagePlugin = existsSync(packageDir) ? await readJSON(packageDir) : null
+  let nextPlugin
+  if (!nodeModule && packagePlugin) {
+    nextPlugin = packagePlugin.dependencies[NEXT_PLUGIN] ? packagePlugin.dependencies[NEXT_PLUGIN] : null
+  } else if (nodeModule && packagePlugin) {
+    nextPlugin = packagePlugin.version ? packagePlugin.version : null
+  }
+
+  return nextPlugin
+}
+
+/**
+ * Creates a function configuration file for the given function
+ *
+ * @param functionName The name of the function, e.g. `___netlify-handler`
+ * @param functionTitle The name of the function that will be displayed in logs, e.g. `Next.js SSR handler`
+ * @param functionsDir The directory where the function is located, e.g. `.netlify/functions`
+ */
+export const writeFunctionConfiguration = async (functionName: string, functionTitle: string, functionsDir: string) => {
+  const pluginPackagePath = '.netlify/plugins/package.json'
+  const ProjDir = resolveModuleRoot(NEXT_PLUGIN)
+  const nodeModulesPath = `${ProjDir}/package.json`
+
+  const nextPluginVersion =
+    (await checkForPackage(nodeModulesPath, true)) || (await checkForPackage(pluginPackagePath, false))
+
+  const metadata = {
+    config: {
+      name: functionTitle,
+      generator: nextPluginVersion ? `${NEXT_PLUGIN_NAME}@${nextPluginVersion}` : 'Next Runtime Version Not Found',
+    },
+    version: 1,
+  }
+
+  await writeFile(join(functionsDir, functionName, `${functionName}.json`), JSON.stringify(metadata))
+}