Function getCliNotFoundMessage

packages/cli-exec/src/errors.ts:62–97

(
  diagnostics: ResolutionDiagnostics
)

 * Builds a not-found error message with diagnostics from local bin resolution.
 */
export function getCliNotFoundMessage(
  diagnostics: ResolutionDiagnostics
): string {
  const details: string[] = [];
  const { localBinSearch } = diagnostics;

  if (localBinSearch.stopReason === 'project-root-marker') {
    details.push(
      `Local bin lookup stopped at ${JSON.stringify(localBinSearch.stoppedAt)} (${JSON.stringify(localBinSearch.markerPath)}).`
    );
  } else if (localBinSearch.stopReason === 'filesystem-root') {
    details.push(
      `No project root marker was found from ${JSON.stringify(localBinSearch.searchRoot)}; local bin lookup reached the filesystem root.`
    );
  }

  for (const skippedNodeModules of localBinSearch.skippedNodeModules) {
    details.push(
      `Skipped ${JSON.stringify(skippedNodeModules.directory)}: ${skippedNodeModules.reason}.`
    );
  }

  for (const skippedLocalBin of diagnostics.skippedLocalBins) {
    details.push(
      `Skipped ${JSON.stringify(skippedLocalBin.candidate)}: ${skippedLocalBin.reason}.`
    );
  }

  if (details.length === 0) {
    return 'Unable to find a usable Vercel CLI installation.';
  }

  return ['Unable to find a usable Vercel CLI installation.', ...details].join(
    '\n'
  );
}

/**
 * Verifies that the resolved working directory exists and is a directory.