data-cap
    Preparing search index...

    Interface GenerateDataArtifactsOptions

    Options for computeDataArtifacts/generateDataArtifacts/checkArtifacts.

    interface GenerateDataArtifactsOptions {
        commit?: string;
        docs?: string;
        evidence?: string;
        exclude?: readonly string[];
        expiringWithinDays?: number;
        flow?: string;
        fs: BuildFileSystem;
        generatedAt?: Date;
        include?: readonly string[];
        location?: string;
        ownership?: string;
        packages?: readonly string[];
        root: string;
        strict?: boolean;
        strictDocs?: boolean;
        strictFlow?: boolean;
        strictOwnership?: boolean;
        tsconfig?: string | false;
    }

    Hierarchy (View Summary)

    Index
    commit? docs? evidence? exclude? expiringWithinDays? flow? fs generatedAt? include? location? ownership? packages? root strict? strictDocs? strictFlow? strictOwnership? tsconfig?
    commit?: string

    The commit SHA this run's evidence was generated against, stamped onto EvidenceModel.provenance.commit. Caller-supplied only -- data-cap never shells out to git itself, so omitting this records a stated absence, never a guess.

    docs?: string

    Output path for the Markdown documentation catalog.

    evidence?: string

    Output path for the composed Evidence Model (ADR 0050), as JSON -- see ReportResult.evidence, which is always computed regardless of this option; this only controls whether it's additionally written to disk.

    exclude?: readonly string[]

    Glob patterns (relative to root) that prune a file or directory regardless of include.

    expiringWithinDays?: number

    How many days out counts as "expiring soon" for the Lifecycle Model and the documentation catalog's own expiring section. Defaults to DEFAULT_EXPIRING_WITHIN_DAYS.

    flow?: string

    Output directory for the Data Flow Diagram + Security Data-Flow Review set.

    fs: BuildFileSystem

    The filesystem capability, shared across every requested pass -- ./build never imports node:fs (ADR 0058).

    generatedAt?: Date

    The single instant every time-sensitive computation in this run shares (EvidenceModel.provenance.generatedAt, Lifecycle Model's daysRemaining), so none of them can disagree about "now". Defaults to the wall clock at the moment this function is called.

    include?: readonly string[]

    Glob patterns (relative to root) a file must match at least one of to be discovered. Defaults to every .ts/.tsx file.

    location?: string

    Output path for the generated manifest .ts file. Omit to skip manifest generation (the inventory is still built and static rules still run).

    ownership?: string

    Output path for the Dependency & Ownership report.

    packages?: readonly string[]

    Explicit cross-package schema discovery allowlist -- see resolve-package-schema.ts.

    root: string

    Directory discovery/linking resolves against.

    strict?: boolean

    Escalate every pass's warning findings to error (never info).

    strictDocs?: boolean

    Escalate static (ownership/sensitivity/duplication) findings to error.

    strictFlow?: boolean

    Escalate SENSITIVE_DATA_CROSSES_EXTERNAL_BOUNDARY/SENSITIVE_FIELD_ENDPOINT_MISSING_HANDLING findings to error -- every finding buildFlowGraph produces.

    strictOwnership?: boolean

    Escalate proven usage findings (abandoned capabilities, unconsumed owned fields) to error -- never escalates unresolved-consumer or indeterminate findings.

    tsconfig?: string | false

    Explicit tsconfig.json path override, or false to disable alias resolution -- see LinkOptions.tsconfig.

    Settings
    Member Visibility

    On This Page
    Properties