data-cap
    Preparing search index...

    Interface ReportResult

    Everything one generateDataArtifacts/checkArtifacts run produced or would produce.

    interface ReportResult {
        documentation: GenerateDocumentationResult | undefined;
        errorCount: number;
        evidence: EvidenceModel;
        findings: readonly ReportFinding[];
        flow: GenerateFlowResult | undefined;
        hasBlockingErrors: boolean;
        infoCount: number;
        manifest: GenerateManifestResult | undefined;
        usage: GenerateUsageResult | undefined;
        warningCount: number;
        warnings: readonly ParseWarning[];
    }
    Index
    documentation errorCount evidence findings flow hasBlockingErrors infoCount manifest usage warningCount warnings
    documentation: GenerateDocumentationResult | undefined

    Present only when --docs was requested.

    errorCount: number

    Count of findings at error severity.

    evidence: EvidenceModel

    data-cap's Evidence Model (ADR 0050), composed from this same run's inventory/usage/manifest/findings -- always present, unlike manifest/documentation/usage/flow above, since composing it costs nothing beyond data already held in memory. --evidence only controls whether it's additionally written to disk; every consumer of ReportResult (including --json) already gets the real, composed model on every run, whether or not a file was requested for it.

    findings: readonly ReportFinding[]

    Every finding across every requested generator, after --strict* escalation.

    flow: GenerateFlowResult | undefined

    Present only when --flow was requested.

    hasBlockingErrors: boolean

    True when errorCount > 0 -- generateDataArtifacts throws instead of writing when this is true.

    infoCount: number

    Count of findings at info severity.

    manifest: GenerateManifestResult | undefined

    Present only when --location was requested.

    usage: GenerateUsageResult | undefined

    Present when --ownership or --flow was requested (the flow report needs the usage scan too).

    warningCount: number

    Count of findings at warning severity.

    warnings: readonly ParseWarning[]

    Parse/link warnings from discovery, never blocking.

    Settings
    Member Visibility

    On This Page
    Properties