Angular Modernizer
    Preparing search index...

    Interface ScanPlanOutput

    File-level plan in the tool output.

    interface ScanPlanOutput {
        cycles: PlannedCycle[];
        graphFiles: number;
        layerSource: "none" | "layers" | "layersSource";
        maxResults?: number;
        phases: (
            Omit<PlannedPhase, "files"> & {
                files?: (PlannedFile & { violationsTruncated?: boolean })[];
                truncated?: boolean;
            }
        )[];
        stats: {
            byLayer: Record<string, number>;
            files: number;
            levels: number;
            violations: number;
        };
        summary: string;
        warnings: string[];
    }
    Index

    Properties

    cycles graphFiles layerSource maxResults? phases stats summary warnings

    Properties

    cycles: PlannedCycle[]

    Import cycles kept together in the plan.

    graphFiles: number

    Files of the import graph (size of the analyzed program).

    layerSource: "none" | "layers" | "layersSource"

    Where the layers came from: layersSource, layers or none.

    maxResults?: number

    List cap in effect (files per phase, violations per file); absent with summaryOnly.

    phases: (
        Omit<PlannedPhase, "files"> & {
            files?: (PlannedFile & { violationsTruncated?: boolean })[];
            truncated?: boolean;
        }
    )[]

    Plan phases, one per dependency level, dependencies first.

    Type Declaration

    • Optionalfiles?: (PlannedFile & { violationsTruncated?: boolean })[]

      Files of the phase, cut to maxResults; absent with summaryOnly.

    • Optionaltruncated?: boolean

      true when maxResults cut the file list.

    stats: {
        byLayer: Record<string, number>;
        files: number;
        levels: number;
        violations: number;
    }

    Plan statistics from core buildViolationPlan.

    Type Declaration

    • byLayer: Record<string, number>

      File count per layer ((no layer) for files without one).

    • files: number

      Number of violated files.

    • levels: number

      Number of topological levels before phases are merged.

    • violations: number

      Number of input violations.

    summary: string

    Short text of the file-level plan.

    warnings: string[]

    Problems while building the plan, e.g. violation files outside the TypeScript program.

    Settings

    Member Visibility

    On This Page

    Properties