Function getPathForPackageManager

packages/build-utils/src/fs/run-user-scripts.ts:1439–1502

({
  cliType,
  lockfileVersion,
  env,
}: {
  cliType: CliType;
  lockfileVersion: number | undefined;
  env: { [x: string]: string | undefined };
})

 * @deprecated use `getEnvForPackageManager` instead
 */
export function getPathForPackageManager({
  cliType,
  lockfileVersion,
  env,
}: {
  cliType: CliType;
  lockfileVersion: number | 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;
} {
  // This is not the correct check for whether or not corepack is being used. For that, you'd have to check
  // the package.json's `packageManager` property. However, this deprecated function is keeping it's old,
  // broken behavior.
  const corepackEnabled = env.ENABLE_EXPERIMENTAL_COREPACK === '1';

  let overrides = getPathOverrideForPackageManager({
    cliType,
    lockfileVersion,
    corepackPackageManager: undefined,
  });

  if (corepackEnabled) {
    // this is essentially always overriding the value of `override`, but that's what was happening
    // in this deprecated function before
    overrides = NO_OVERRIDE;
  }

  const alreadyInPath = (newPath: string) => {
    const oldPath = env.PATH ?? '';
    return oldPath.split(path.delimiter).includes(newPath);
  };

  switch (true) {
    case cliType === 'yarn' && !env.YARN_NODE_LINKER:
      return { ...overrides, yarnNodeLinker: 'node-modules' };
    case alreadyInPath(overrides.path ?? ''):
      return {
        detectedLockfile: undefined,
        detectedPackageManager: undefined,
        path: undefined,