Angular Modernizer
    Preparing search index...

    Interface CompareHealthOutput

    Output of the compare-health tool.

    interface CompareHealthOutput {
        byFile?: FileDelta[];
        byRule: RuleDelta[];
        currentRun: HealthRunInfo & {
            byCategory: Record<string, number>;
            bySeverity: Record<string, number>;
        };
        fixedViolations?: HealthViolation[];
        newViolations?: HealthViolation[];
        previousRun?: HealthRunInfo;
        projectRoot: string;
        rulesAdded: string[];
        rulesRemoved: string[];
        scopeDifferences: string[];
        snapshotPath: string;
        snapshotWritten: boolean;
        status: CompareHealthStatus;
        summary: string;
        totals?: { fixed: number; new: number; unchanged: number };
        truncated: boolean;
    }
    Index

    Properties

    byFile? byRule currentRun fixedViolations? newViolations? previousRun? projectRoot rulesAdded rulesRemoved scopeDifferences snapshotPath snapshotWritten status summary totals? truncated

    Properties

    byFile?: FileDelta[]

    Changed files; only for status compared, dropped with summaryOnly, capped by maxResults.

    byRule: RuleDelta[]

    Status compared: every rule with violations in either run. Other statuses: current counts only (previous and the deltas are 0).

    currentRun: HealthRunInfo & {
        byCategory: Record<string, number>;
        bySeverity: Record<string, number>;
    }

    Counts of the current run.

    Type Declaration

    • byCategory: Record<string, number>

      Violations per category, over all violations.

    • bySeverity: Record<string, number>

      Violations per severity, over all violations.

    fixedViolations?: HealthViolation[]

    Violations only in the previous run; only for status compared, dropped with summaryOnly, capped by maxResults.

    newViolations?: HealthViolation[]

    Violations only in the current run; only for status compared, dropped with summaryOnly, capped by maxResults.

    previousRun?: HealthRunInfo

    Counts of the stored run, when a readable snapshot exists.

    projectRoot: string

    Absolute project root.

    rulesAdded: string[]

    Rules that ran now but not in the previous run; their findings count as new.

    rulesRemoved: string[]

    Rules that ran in the previous run but not now.

    scopeDifferences: string[]

    Scope keys that differ from the snapshot, as key: previous -> current.

    snapshotPath: string

    Relative to projectRoot when inside it.

    snapshotWritten: boolean

    Whether the current run was written as the new snapshot.

    status: CompareHealthStatus

    Outcome of the run.

    summary: string

    Human-readable summary for LLM consumption.

    totals?: { fixed: number; new: number; unchanged: number }

    Only for status compared.

    Type Declaration

    • fixed: number

      Violations only in the previous run.

    • new: number

      Violations only in the current run.

    • unchanged: number

      Violations in both runs.

    truncated: boolean

    true when maxResults cut one of the lists.

    Settings

    Member Visibility

    On This Page

    Properties