Skip to main content

utils/doctor

Pipecraft Doctor - Diagnostic Health Check

Performs comprehensive health checks on a Pipecraft setup:

  • Configuration validation
  • GitHub workflow permissions
  • Branch existence on remote
  • Generated file verification
  • Workflow semantic validation
  • Domain path validation

Interfaces​

CheckCategory​

Defined in: utils/doctor.ts:74

Properties​

name​
name: string;

Defined in: utils/doctor.ts:75

results​
results: CheckResult[];

Defined in: utils/doctor.ts:76

CheckResult​

Defined in: utils/doctor.ts:65

Properties​

fix?​
optional fix: object;

Defined in: utils/doctor.ts:68

command?​
optional command: string;
description​
description: string;
message​
message: string;

Defined in: utils/doctor.ts:67

status​
status: CheckStatus;

Defined in: utils/doctor.ts:66

DoctorResult​

Defined in: utils/doctor.ts:79

Properties​

categories​
categories: CheckCategory[];

Defined in: utils/doctor.ts:80

errorCount​
errorCount: number;

Defined in: utils/doctor.ts:81

warningCount​
warningCount: number;

Defined in: utils/doctor.ts:82

Type Aliases​

CheckStatus​

type CheckStatus = "success" | "error" | "warning";

Defined in: utils/doctor.ts:63

Functions​

checkBranches()​

function checkBranches(): CheckCategory;

Defined in: utils/doctor.ts:347

Check 3: Branches exist on remote

Returns​

CheckCategory

checkConfiguration()​

function checkConfiguration(): CheckCategory;

Defined in: utils/doctor.ts:191

Check 1: Configuration validation

Returns​

CheckCategory

checkDomainPaths()​

function checkDomainPaths(): Promise<CheckCategory>;

Defined in: utils/doctor.ts:629

Check 6: Domain paths match files

Returns​

Promise<CheckCategory>

checkGeneratedFiles()​

function checkGeneratedFiles(): CheckCategory;

Defined in: utils/doctor.ts:419

Check 4: Required actions exist

Returns​

CheckCategory

checkGitHubPermissions()​

function checkGitHubPermissions(): Promise<CheckCategory>;

Defined in: utils/doctor.ts:237

Check 2: GitHub workflow permissions

Returns​

Promise<CheckCategory>

checkWorkflowSemantics()​

function checkWorkflowSemantics(): CheckCategory;

Defined in: utils/doctor.ts:557

Check 5: Workflow semantic validation

Returns​

CheckCategory

formatDoctorOutput()​

function formatDoctorOutput(result): string;

Defined in: utils/doctor.ts:121

Parameters​

result​

DoctorResult

Returns​

string

runDoctor()​

function runDoctor(): Promise<DoctorResult>;

Defined in: utils/doctor.ts:701

Run all diagnostic checks and return the results.

Returns​

Promise<DoctorResult>