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

    Interface GenerateEnvArtifactsOptions

    Options for generateEnvArtifacts.

    interface GenerateEnvArtifactsOptions {
        docs?:
            | false
            | Omit<
                GenerateDocumentationOptions,
                | "fs"
                | "root"
                | "include"
                | "exclude"
                | "packages"
                | "tsconfig"
                | "liveExpirationDates",
            >;
        evidence?: false
        | { location: string };
        exclude?: string[];
        fs: BuildFileSystem;
        include?: string[];
        liveExpirationDates?: LiveExpirationDates;
        manifest?:
            | false
            | Omit<
                GenerateEnvManifestOptions,
                "fs"
                | "root"
                | "include"
                | "exclude"
                | "packages"
                | "tsconfig",
            >;
        onOwnershipIssue?: "warn" | "throw";
        onUndocumented?: "warn" | "throw";
        packages?: readonly string[];
        root?: string;
        tsconfig?: string | false;
        usage?:
            | false
            | Omit<
                GenerateUsageReportOptions,
                "fs"
                | "root"
                | "include"
                | "exclude"
                | "packages"
                | "tsconfig",
            >;
    }
    Index
    docs? evidence? exclude? fs include? liveExpirationDates? manifest? onOwnershipIssue? onUndocumented? packages? root? tsconfig? usage?
    docs?:
        | false
        | Omit<
            GenerateDocumentationOptions,
            | "fs"
            | "root"
            | "include"
            | "exclude"
            | "packages"
            | "tsconfig"
            | "liveExpirationDates",
        >

    Docs pass options, or false to skip it entirely.

    evidence?: false | { location: string }

    Where to write the persisted evidence artifact (the full, literal EvidenceModel, plus a paired .fingerprint sidecar -- see evidence-cache.ts), e.g. docs/env.evidence.json, relative to root. Independent of manifest.location -- requesting this needs no other pass, and generating a manifest never requires it. EvidenceModel itself is always computed regardless of this option (ADR 0038, "free to compute, always real") and always returned as result.evidence; this option controls only whether it's also written to disk. Omitted: nothing is written, result.evidence is still populated.

    exclude?: string[]

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

    fs: BuildFileSystem

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

    include?: string[]

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

    liveExpirationDates?: LiveExpirationDates

    Supplies expiration metadata from a live source (a secrets manager, an internal inventory API, ...) as a post-discovery override applied only to the docs pass. Invoked at most once, only when a docs pass is actually requested, with every discovered variable name across all passes' shared contract graph. See live-expirations.ts and ADR 0012. Omitted: behavior is unchanged from a purely static expiresAt.

    manifest?:
        | false
        | Omit<
            GenerateEnvManifestOptions,
            "fs"
            | "root"
            | "include"
            | "exclude"
            | "packages"
            | "tsconfig",
        >

    Manifest pass options, or false to skip it entirely.

    onOwnershipIssue?: "warn" | "throw"

    Escalates every warning-severity "ownership"-family finding (abandoned contracts, unresolved consumers, unconsumed owned variables, indeterminate ownership, stale/missing dynamicAccess citations) into a blocking error. Defaults to "warn" -- see onUndocumented.

    onUndocumented?: "warn" | "throw"

    Escalates every warning-severity "documentation"-family finding (undocumented contracts/variables, stale doc entries, expiring/expired entries, unresolvable documentEnv() links) into a blocking error, so a run with any of them writes nothing and throws. Defaults to "warn" -- ADR 0038's stance, unchanged: documentation gaps never block by default.

    Scoped deliberately narrowly, unlike manifest.onIncompatibility, which gates only the compatibility family. "info"-severity findings are never escalated by either -- see Finding.severity.

    packages?: readonly string[]

    See GenerateEnvManifestOptions.packages; shared across every requested pass. See ADR 0014.

    root?: string

    Directory glob patterns are resolved against, shared across every requested pass. Defaults to process.cwd().

    tsconfig?: string | false

    See GenerateEnvManifestOptions.tsconfig; shared across every requested pass. See ADR 0023.

    usage?:
        | false
        | Omit<
            GenerateUsageReportOptions,
            "fs"
            | "root"
            | "include"
            | "exclude"
            | "packages"
            | "tsconfig",
        >

    Usage-report pass options, or false to skip it entirely.

    Settings
    Member Visibility

    On This Page
    Properties