@vercel/build-utils 7.3.0 → 7.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/build-utils
 
+## 7.4.0
+
+### Minor Changes
+
+- Adds new helper `getPathForPackageManager()` ([#10918](https://github.com/vercel/vercel/pull/10918))
+
 ## 7.3.0
 
 ### Minor Changes

package/dist/fs/run-user-scripts.d.ts

@@ -78,6 +78,10 @@ export declare function getNodeVersion(destPath: string, nodeVersionFallback?: s
 export declare function scanParentDirs(destPath: string, readPackageJson?: boolean): Promise<ScanParentDirsResult>;
 export declare function walkParentDirs({ base, start, filename, }: WalkParentDirsProps): Promise<string | null>;
 export declare function runNpmInstall(destPath: string, args?: string[], spawnOpts?: SpawnOptions, meta?: Meta, nodeVersion?: NodeVersion): Promise<boolean>;
+/**
+ * Prepares the input environment based on the used package manager and lockfile
+ * versions.
+ */
 export declare function getEnvForPackageManager({ cliType, lockfileVersion, nodeVersion, env, }: {
     cliType: CliType;
     lockfileVersion: number | undefined;
@@ -88,6 +92,37 @@ export declare function getEnvForPackageManager({ cliType, lockfileVersion, node
 }): {
     [x: string]: string | undefined;
 };
+/**
+ * Helper to get the binary paths that link to the used package manager.
+ * Note: Make sure it doesn't contain any `console.log` calls.
+ */
+export declare function getPathForPackageManager({ cliType, lockfileVersion, nodeVersion, env, }: {
+    cliType: CliType;
+    lockfileVersion: number | undefined;
+    nodeVersion: NodeVersion | undefined;
+    env: {
+        [x: string]: string | undefined;
+    };
+}): {
+    /**
+     * Which lockfile was detected.
+     */
+    detectedLockfile: string | undefined;
+    /**
+     * Detected package manager that generated the found lockfile.
+     */
+    detectedPackageManager: string | undefined;
+    /**
+     * Value of $PATH that includes the binaries for the detected package manager.
+     * Undefined if no $PATH are necessary.
+     */
+    path: string | undefined;
+    /**
+     * Set if yarn was identified as package manager and `YARN_NODE_LINKER`
+     * environment variable was not found on the input environment.
+     */
+    yarnNodeLinker: string | undefined;
+};
 export declare function runCustomInstallCommand({ destPath, installCommand, nodeVersion, spawnOpts, }: {
     destPath: string;
     installCommand: string;

package/dist/fs/run-user-scripts.js

@@ -33,6 +33,7 @@ __export(run_user_scripts_exports, {
   getNodeBinPath: () => getNodeBinPath,
   getNodeBinPaths: () => getNodeBinPaths,
   getNodeVersion: () => getNodeVersion,
+  getPathForPackageManager: () => getPathForPackageManager,
   getScriptName: () => getScriptName,
   getSpawnOptions: () => getSpawnOptions,
   installDependencies: () => installDependencies,
@@ -376,7 +377,50 @@ function getEnvForPackageManager({
   nodeVersion,
   env
 }) {
-  const newEnv = { ...env };
+  const {
+    detectedLockfile,
+    detectedPackageManager,
+    path: newPath,
+    yarnNodeLinker
+  } = getPathForPackageManager({
+    cliType,
+    lockfileVersion,
+    nodeVersion,
+    env
+  });
+  const newEnv = {
+    ...env
+  };
+  if (newPath) {
+    const oldPath = env.PATH + "";
+    newEnv.PATH = `${newPath}${import_path.default.delimiter}${oldPath}`;
+  }
+  if (yarnNodeLinker) {
+    newEnv.YARN_NODE_LINKER = yarnNodeLinker;
+  }
+  if (detectedLockfile && detectedPackageManager) {
+    const versionString = cliType === "pnpm" ? `version ${lockfileVersion} ` : "";
+    console.log(
+      `Detected \`${detectedLockfile}\` ${versionString}generated by ${detectedPackageManager}`
+    );
+    if (cliType === "bun") {
+      console.warn(
+        "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
+      );
+    }
+  }
+  return newEnv;
+}
+function getPathForPackageManager({
+  cliType,
+  lockfileVersion,
+  nodeVersion,
+  env
+}) {
+  let detectedLockfile;
+  let detectedPackageManager;
+  let pathValue;
+  let yarnNodeLinker;
   const oldPath = env.PATH + "";
   const npm7 = "/node16/bin-npm7";
   const pnpm7 = "/pnpm7/node_modules/.bin";
@@ -385,35 +429,37 @@ function getEnvForPackageManager({
   const corepackEnabled = env.ENABLE_EXPERIMENTAL_COREPACK === "1";
   if (cliType === "npm") {
     if (typeof lockfileVersion === "number" && lockfileVersion >= 2 && (nodeVersion?.major || 0) < 16 && !oldPath.includes(npm7) && !corepackEnabled) {
-      newEnv.PATH = `${npm7}${import_path.default.delimiter}${oldPath}`;
-      console.log("Detected `package-lock.json` generated by npm 7+");
+      pathValue = npm7;
+      detectedLockfile = "package-lock.json";
+      detectedPackageManager = "npm 7+";
     }
   } else if (cliType === "pnpm") {
     if (typeof lockfileVersion === "number" && lockfileVersion === 5.4 && !oldPath.includes(pnpm7) && !corepackEnabled) {
-      newEnv.PATH = `${pnpm7}${import_path.default.delimiter}${oldPath}`;
-      console.log(
-        `Detected \`pnpm-lock.yaml\` version ${lockfileVersion} generated by pnpm 7`
-      );
+      pathValue = pnpm7;
+      detectedLockfile = "pnpm-lock.yaml";
+      detectedPackageManager = "pnpm 7";
     } else if (typeof lockfileVersion === "number" && lockfileVersion >= 6 && !oldPath.includes(pnpm8) && !corepackEnabled) {
-      newEnv.PATH = `${pnpm8}${import_path.default.delimiter}${oldPath}`;
-      console.log(
-        `Detected \`pnpm-lock.yaml\` version ${lockfileVersion} generated by pnpm 8`
-      );
+      pathValue = pnpm8;
+      detectedLockfile = "pnpm-lock.yaml";
+      detectedPackageManager = "pnpm 8";
     }
   } else if (cliType === "bun") {
     if (!oldPath.includes(bun1) && !corepackEnabled) {
-      newEnv.PATH = `${bun1}${import_path.default.delimiter}${oldPath}`;
-      console.log("Detected `bun.lockb` generated by Bun");
-      console.warn(
-        "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
-      );
+      pathValue = bun1;
+      detectedLockfile = "bun.lockb";
+      detectedPackageManager = "Bun";
     }
   } else {
     if (!env.YARN_NODE_LINKER) {
-      newEnv.YARN_NODE_LINKER = "node-modules";
+      yarnNodeLinker = "node-modules";
     }
   }
-  return newEnv;
+  return {
+    detectedLockfile,
+    detectedPackageManager,
+    path: pathValue,
+    yarnNodeLinker
+  };
 }
 async function runCustomInstallCommand({
   destPath,
@@ -517,6 +563,7 @@ const installDependencies = (0, import_util.deprecate)(
   getNodeBinPath,
   getNodeBinPaths,
   getNodeVersion,
+  getPathForPackageManager,
   getScriptName,
   getSpawnOptions,
   installDependencies,

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import download, { downloadFile, DownloadedFiles, isSymbolicLink, isDirectory }
 import getWriteableDirectory from './fs/get-writable-directory';
 import glob, { GlobOptions } from './fs/glob';
 import rename from './fs/rename';
-import { spawnAsync, execCommand, spawnCommand, walkParentDirs, getScriptName, installDependencies, runPackageJsonScript, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getSpawnOptions, getNodeBinPath, getNodeBinPaths, scanParentDirs, traverseUpDirectories } from './fs/run-user-scripts';
+import { spawnAsync, execCommand, spawnCommand, walkParentDirs, getScriptName, installDependencies, runPackageJsonScript, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getPathForPackageManager, getSpawnOptions, getNodeBinPath, getNodeBinPaths, scanParentDirs, traverseUpDirectories } from './fs/run-user-scripts';
 import { getLatestNodeVersion, getDiscontinuedNodeVersions } from './fs/node-version';
 import streamToBuffer from './fs/stream-to-buffer';
 import debug from './debug';
@@ -18,7 +18,7 @@ import { getPrefixedEnvVars } from './get-prefixed-env-vars';
 import { cloneEnv } from './clone-env';
 import { hardLinkDir } from './hard-link-dir';
 import { validateNpmrc } from './validate-npmrc';
-export { FileBlob, FileFsRef, FileRef, Lambda, NodejsLambda, createLambda, Prerender, download, downloadFile, DownloadedFiles, getWriteableDirectory, glob, GlobOptions, rename, spawnAsync, getScriptName, installDependencies, runPackageJsonScript, execCommand, spawnCommand, walkParentDirs, getNodeBinPath, getNodeBinPaths, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getLatestNodeVersion, getDiscontinuedNodeVersions, getSpawnOptions, getPlatformEnv, getPrefixedEnvVars, streamToBuffer, debug, isSymbolicLink, isDirectory, getLambdaOptionsFromFunction, scanParentDirs, getIgnoreFilter, cloneEnv, hardLinkDir, traverseUpDirectories, validateNpmrc, };
+export { FileBlob, FileFsRef, FileRef, Lambda, NodejsLambda, createLambda, Prerender, download, downloadFile, DownloadedFiles, getWriteableDirectory, glob, GlobOptions, rename, spawnAsync, getScriptName, installDependencies, runPackageJsonScript, execCommand, spawnCommand, walkParentDirs, getNodeBinPath, getNodeBinPaths, runNpmInstall, runBundleInstall, runPipInstall, runShellScript, runCustomInstallCommand, getEnvForPackageManager, getNodeVersion, getPathForPackageManager, getLatestNodeVersion, getDiscontinuedNodeVersions, getSpawnOptions, getPlatformEnv, getPrefixedEnvVars, streamToBuffer, debug, isSymbolicLink, isDirectory, getLambdaOptionsFromFunction, scanParentDirs, getIgnoreFilter, cloneEnv, hardLinkDir, traverseUpDirectories, validateNpmrc, };
 export { EdgeFunction } from './edge-function';
 export { readConfigFile } from './fs/read-config-file';
 export { normalizePath } from './fs/normalize-path';

package/dist/index.js

@@ -20734,6 +20734,7 @@ __export(src_exports, {
   getNodeBinPath: () => getNodeBinPath,
   getNodeBinPaths: () => getNodeBinPaths,
   getNodeVersion: () => getNodeVersion,
+  getPathForPackageManager: () => getPathForPackageManager,
   getPlatformEnv: () => getPlatformEnv,
   getPrefixedEnvVars: () => getPrefixedEnvVars,
   getPrettyError: () => getPrettyError,
@@ -22079,7 +22080,50 @@ function getEnvForPackageManager({
   nodeVersion,
   env
 }) {
-  const newEnv = { ...env };
+  const {
+    detectedLockfile,
+    detectedPackageManager,
+    path: newPath,
+    yarnNodeLinker
+  } = getPathForPackageManager({
+    cliType,
+    lockfileVersion,
+    nodeVersion,
+    env
+  });
+  const newEnv = {
+    ...env
+  };
+  if (newPath) {
+    const oldPath = env.PATH + "";
+    newEnv.PATH = `${newPath}${import_path5.default.delimiter}${oldPath}`;
+  }
+  if (yarnNodeLinker) {
+    newEnv.YARN_NODE_LINKER = yarnNodeLinker;
+  }
+  if (detectedLockfile && detectedPackageManager) {
+    const versionString = cliType === "pnpm" ? `version ${lockfileVersion} ` : "";
+    console.log(
+      `Detected \`${detectedLockfile}\` ${versionString}generated by ${detectedPackageManager}`
+    );
+    if (cliType === "bun") {
+      console.warn(
+        "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
+      );
+    }
+  }
+  return newEnv;
+}
+function getPathForPackageManager({
+  cliType,
+  lockfileVersion,
+  nodeVersion,
+  env
+}) {
+  let detectedLockfile;
+  let detectedPackageManager;
+  let pathValue;
+  let yarnNodeLinker;
   const oldPath = env.PATH + "";
   const npm7 = "/node16/bin-npm7";
   const pnpm7 = "/pnpm7/node_modules/.bin";
@@ -22088,35 +22132,37 @@ function getEnvForPackageManager({
   const corepackEnabled = env.ENABLE_EXPERIMENTAL_COREPACK === "1";
   if (cliType === "npm") {
     if (typeof lockfileVersion === "number" && lockfileVersion >= 2 && (nodeVersion?.major || 0) < 16 && !oldPath.includes(npm7) && !corepackEnabled) {
-      newEnv.PATH = `${npm7}${import_path5.default.delimiter}${oldPath}`;
-      console.log("Detected `package-lock.json` generated by npm 7+");
+      pathValue = npm7;
+      detectedLockfile = "package-lock.json";
+      detectedPackageManager = "npm 7+";
     }
   } else if (cliType === "pnpm") {
     if (typeof lockfileVersion === "number" && lockfileVersion === 5.4 && !oldPath.includes(pnpm7) && !corepackEnabled) {
-      newEnv.PATH = `${pnpm7}${import_path5.default.delimiter}${oldPath}`;
-      console.log(
-        `Detected \`pnpm-lock.yaml\` version ${lockfileVersion} generated by pnpm 7`
-      );
+      pathValue = pnpm7;
+      detectedLockfile = "pnpm-lock.yaml";
+      detectedPackageManager = "pnpm 7";
     } else if (typeof lockfileVersion === "number" && lockfileVersion >= 6 && !oldPath.includes(pnpm8) && !corepackEnabled) {
-      newEnv.PATH = `${pnpm8}${import_path5.default.delimiter}${oldPath}`;
-      console.log(
-        `Detected \`pnpm-lock.yaml\` version ${lockfileVersion} generated by pnpm 8`
-      );
+      pathValue = pnpm8;
+      detectedLockfile = "pnpm-lock.yaml";
+      detectedPackageManager = "pnpm 8";
     }
   } else if (cliType === "bun") {
     if (!oldPath.includes(bun1) && !corepackEnabled) {
-      newEnv.PATH = `${bun1}${import_path5.default.delimiter}${oldPath}`;
-      console.log("Detected `bun.lockb` generated by Bun");
-      console.warn(
-        "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
-      );
+      pathValue = bun1;
+      detectedLockfile = "bun.lockb";
+      detectedPackageManager = "Bun";
     }
   } else {
     if (!env.YARN_NODE_LINKER) {
-      newEnv.YARN_NODE_LINKER = "node-modules";
+      yarnNodeLinker = "node-modules";
     }
   }
-  return newEnv;
+  return {
+    detectedLockfile,
+    detectedPackageManager,
+    path: pathValue,
+    yarnNodeLinker
+  };
 }
 async function runCustomInstallCommand({
   destPath,
@@ -22505,6 +22551,7 @@ var buildsSchema = {
   getNodeBinPath,
   getNodeBinPaths,
   getNodeVersion,
+  getPathForPackageManager,
   getPlatformEnv,
   getPrefixedEnvVars,
   getPrettyError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/build-utils",
-  "version": "7.3.0",
+  "version": "7.4.0",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",