Function makeDiagnosticError

packages/python/src/entrypoint.ts:373–414

(
  framework: string,
  diagnostics: EntrypointDiagnostics
)

}

function makeDiagnosticError(
  framework: string,
  diagnostics: EntrypointDiagnostics
): NowBuildError {
  const code = `${framework.toUpperCase()}_ENTRYPOINT_NOT_FOUND`;
  const link = getFrameworkEntrypointDocsUrl(framework);
  const action = 'Learn More';
  const displayName = getFrameworkDisplayName(framework);
  const elsewhere = diagnostics.validCandidatesElsewhere ?? [];
  const suggestion =
    elsewhere.length > 0 ? renderCandidateSuggestion(elsewhere) : null;

  let message: string;

  if (diagnostics.existingWithoutEntrypoint.length > 0) {
    message = getMissingExportMessage(
      framework,
      diagnostics.existingWithoutEntrypoint
    );
    if (suggestion) message += `\n\n${suggestion}`;
  } else if (diagnostics.djangoManageBaseDir !== undefined) {
    const where = diagnostics.djangoManageBaseDir || '.';
    message =
      `Found Django manage.py in "${where}" but could not resolve the application entrypoint. ` +
      `Ensure WSGI_APPLICATION or ASGI_APPLICATION is set in your Django settings.`;
    if (suggestion) message += `\n\n${suggestion}`;
  } else if (
    diagnostics.pyprojectAppScript &&
    diagnostics.pyprojectCheckedPaths?.length
  ) {
    const checked = diagnostics.pyprojectCheckedPaths.join(' or ');
    message = `pyproject.toml [project.scripts] defines app = "${diagnostics.pyprojectAppScript}" but ${checked} was not found.`;
    if (suggestion) message += `\n\n${suggestion}`;
  } else if (suggestion) {
    message = `No ${displayName} entrypoint found in default locations, ${suggestion}`;
  } else {
    const searchedList = PYTHON_CANDIDATE_ENTRYPOINTS.join(', ');
    message = `No ${displayName} entrypoint found. Set "tool.vercel.entrypoint" in pyproject.toml or define an entrypoint in one of: ${searchedList}.`;
  }

  return new NowBuildError({ code, message, link, action });
}

/**
 * Detect a Python entrypoint for any Python framework using AST-based detection.