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

    Interface GenerateEnvManifestOptions

    Options for generateEnvManifest.

    interface GenerateEnvManifestOptions {
        exclude?: string[];
        fs: BuildFileSystem;
        include?: string[];
        location: string;
        onIncompatibility?: "warn" | "throw";
        packages?: readonly string[];
        root?: string;
        tsconfig?: string | false;
    }
    Index
    exclude? fs include? location onIncompatibility? packages? root? tsconfig?
    exclude?: string[]

    Glob patterns to exclude. Defaults to node_modules/dist/.git.

    fs: BuildFileSystem

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

    include?: string[]

    Glob patterns for schema files. Defaults to ["**/env.schema.ts"].

    location: string

    Output path for the generated manifest, relative to root (e.g. "src/generated/env.manifest.ts").

    onIncompatibility?: "warn" | "throw"

    "warn" (default): only provable incompatibilities (conflicting explicit processor return type annotations) block generation; everything else is reported as a warning. "throw": warnings are escalated to hard errors too, for stricter CI gates.

    packages?: readonly string[]

    Explicit allowlist of installed package names whose declared "envCap": { "schema": "<path>" } entry point should also be discovered, so a contract that ships as its own separately-published package (no monorepo required) can be included in the manifest. Opt-in only: a package is never considered unless its exact name appears here. See ADR 0014.

    root?: string

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

    tsconfig?: string | false

    Path to a tsconfig.json (relative to root) whose compilerOptions.paths/baseUrl resolve aliased import specifiers (e.g. "@/lib/env.schema.js") encountered during static analysis, so a contract or consumer reached only through an alias isn't misreported as abandoned/unresolved. Defaults to "tsconfig.json" at root -- on automatically, no opt-in required, since (unlike packages) this never crosses a trust/versioning boundary: every resolved file is already local, already-trusted project source. Pass false to disable entirely. See ADR 0023.

    Settings
    Member Visibility

    On This Page
    Properties