Function getSkippedNodeModulesReason

packages/cli-exec/src/safety.ts:9–53

(
  nodeModulesDirectory: string,
  parentDirectories?: string[]
)

 * Explains why a `node_modules` directory should be skipped, or `null` if safe.
 */
export async function getSkippedNodeModulesReason(
  nodeModulesDirectory: string,
  parentDirectories?: string[]
): Promise<string | null> {
  const parentDirectory = path.dirname(nodeModulesDirectory);
  parentDirectories ??= [parentDirectory];

  for (const directory of parentDirectories) {
    let unsafeParentReason: string | null;

    try {
      unsafeParentReason = await getUnsafeDirectoryReason(directory);
    } catch (error) {
      unsafeParentReason = `could not inspect: ${getErrorMessage(error)}`;
    }

    if (unsafeParentReason) {
      return `${directory} is ${unsafeParentReason}`;
    }
  }

  const result = await statIfExists(nodeModulesDirectory);

  if ('missing' in result) {
    return null;
  }

  if ('reason' in result) {
    return result.reason;
  }

  if (!result.stats.isDirectory()) {
    return 'not a directory';
  }

  const unsafeNodeModulesReason = getUnsafeStatsReason(result.stats);

  if (unsafeNodeModulesReason) {
    return unsafeNodeModulesReason;
  }

  return await getSkippedLocalBinDirectoryReason(
    path.join(nodeModulesDirectory, '.bin')
  );
}

/**
 * Explains why a `.bin` directory should be skipped, or `null` if safe.