Function runCustomInstallCommand

packages/build-utils/src/fs/run-user-scripts.ts:1504–1563

({
  destPath,
  installCommand,
  spawnOpts,
  projectCreatedAt,
}: {
  destPath: string;
  installCommand: string;
  spawnOpts?: SpawnOptions;
  projectCreatedAt?: number;
})

}

export async function runCustomInstallCommand({
  destPath,
  installCommand,
  spawnOpts,
  projectCreatedAt,
}: {
  destPath: string;
  installCommand: string;
  spawnOpts?: SpawnOptions;
  projectCreatedAt?: number;
}): Promise<boolean> {
  const normalizedPath = path.normalize(destPath);

  const { alreadyInstalled, runNpmInstallSet } = checkIfAlreadyInstalled(
    customInstallCommandSet,
    normalizedPath
  );
  customInstallCommandSet = runNpmInstallSet;

  if (alreadyInstalled) {
    debug(
      `Skipping custom install command for ${normalizedPath} because it was already run`
    );
    return false;
  }

  // Skip if VERCEL_INSTALL_COMPLETED is set (e.g., for vercel.ts config compilation)
  // Path is already marked as installed above, allowing subdirectory installs to proceed
  if (process.env.VERCEL_INSTALL_COMPLETED === '1') {
    debug(
      `Skipping custom install command for ${normalizedPath} because VERCEL_INSTALL_COMPLETED is set`
    );
    return false;
  }

  console.log(`Running "install" command: \`${installCommand}\`...`);
  const {
    cliType,
    lockfileVersion,
    packageJson,
    packageJsonPackageManager,
    turboSupportsCorepackHome,
  } = await scanParentDirs(destPath, true);
  const env = getEnvForPackageManager({
    cliType,
    lockfileVersion,
    packageJsonPackageManager,
    env: spawnOpts?.env || {},
    packageJsonEngines: packageJson?.engines,
    turboSupportsCorepackHome,
    projectCreatedAt,
  });
  debug(`Running with $PATH:`, env?.PATH || '');
  await execCommand(installCommand, {
    ...spawnOpts,
    env,
    cwd: destPath,
  });