data-cap
    Preparing search index...

    Interface ReportFinding

    One reportable fact about the discovered capability graph. severity is assigned by the rule that produces the finding, following the two governing invariants in AGENTS.md: static analysis never infers a relationship from insufficient evidence (an ambiguous case is info or indeterminate-flavored, never guessed at as error), and a finding built from declared metadata (e.g. a missing protections field) never claims more than "documented" vs. "not documented."

    interface ReportFinding {
        capability?: { exportName: string; file: string };
        code: ReportFindingCode;
        family: ReportFindingFamily;
        field?: readonly string[];
        indeterminateSites?: readonly SourceLocation[];
        message: string;
        operation?: string;
        position?: SourcePosition;
        severity: ReportSeverity;
        source?: string;
    }
    Index
    capability? code family field? indeterminateSites? message operation? position? severity source?
    capability?: { exportName: string; file: string }

    The capability this finding is about, if any.

    Type Declaration

    • ReadonlyexportName: string

      The binding name the capability is exported as.

    • Readonlyfile: string

      Absolute path of the file declaring the capability.

    code: ReportFindingCode

    Which kind of fact this finding reports.

    family: ReportFindingFamily

    Which analysis pass produced this finding -- see ReportFindingFamily.

    field?: readonly string[]

    The field path this finding is about, if any.

    indeterminateSites?: readonly SourceLocation[]

    Every candidate access site a "FIELD_ACCESS_INDETERMINATE" finding could actually be about -- populated only for that code. Spans potentially multiple consuming files, so each entry carries its own file (SourceLocation, not just SourcePosition).

    message: string

    Human-readable explanation of the finding.

    operation?: string

    The operation name this finding is about, if any.

    position?: SourcePosition

    Position of the declaration site (capability's own call, or field's own key) this finding is anchored to, when one is available -- see ADR 0052. Additive: absent for findings with no single declaration-site anchor (e.g. a usage-scan finding whose subject is a consuming file, not a declaration).

    severity: ReportSeverity

    How strongly this finding should be treated.

    source?: string

    The consuming file, for usage-scan-derived findings only.

    Settings
    Member Visibility

    On This Page
    Properties