@maverickcer/env-cap
    Preparing search index...

    Interface GetEvidenceModelOptions

    Options for getEvidenceModel -- every generateEvidenceModel() option, plus where the cached artifact lives.

    interface GetEvidenceModelOptions {
        commit?: () => Promise<string | undefined>;
        exclude?: string[];
        expiringWithinDays?: number;
        fs: BuildFileSystem;
        include?: string[];
        liveExpirationDates?: LiveExpirationDates;
        location: string;
        packages?: readonly string[];
        previousSnapshotLocation?: string;
        root?: string;
        tsconfig?: string | false;
    }

    Hierarchy (View Summary)

    Index
    commit? exclude? expiringWithinDays? fs include? liveExpirationDates? location packages? previousSnapshotLocation? root? tsconfig?
    commit?: () => Promise<string | undefined>

    Resolves the commit SHA to stamp onto EvidenceModel.provenance.commit. Invoked at most once, after discovery/linking completes. env-cap never shells out to git itself -- see ADR 0012's callback precedent. Omitted: commit is undefined.

    exclude?: string[]

    Glob patterns to exclude, shared across every pass. Defaults to node_modules/dist/.git.

    expiringWithinDays?: number

    Feeds Lifecycle Model's expiring list. Defaults to 30.

    fs: BuildFileSystem

    The filesystem capability -- ./build never imports node:fs (ADR 0040).

    include?: string[]

    Schema-discovery glob for the contract graph. Defaults to ["**/env.schema.ts"].

    liveExpirationDates?: LiveExpirationDates

    Supplies expiration metadata from a live source as a post-discovery override, applied to Lifecycle Model's (and Finding Model's expiring-soon findings') data only -- Contract Model still reflects the schema's own static expiresAt. See live-expirations.ts and ADR 0012.

    location: string

    Where the cached evidence artifact (and its .fingerprint sidecar) live, e.g. docs/env.evidence.json, relative to root. Required -- there is no honest default env-cap could guess at for where a project keeps this.

    packages?: readonly string[]

    See GenerateEnvManifestOptions.packages. See ADR 0014.

    previousSnapshotLocation?: string

    Where a previously-persisted evidence artifact lives, relative to root -- read (never written) as the baseline Change Model diffs against and dynamic-access citation freshness (ADR 0037) compares content hashes to. Independent of any .ts manifest a project may or may not also generate -- there is no derivation from a manifest's own location. Omitted: treated as the normal first-run state (everything reads as added, no citation-freshness baseline to compare against), never an error.

    root?: string

    Directory glob patterns are resolved against. Defaults to process.cwd().

    tsconfig?: string | false

    See GenerateEnvManifestOptions.tsconfig. See ADR 0023.

    Settings
    Member Visibility

    On This Page
    Properties