vigiles API reference
    Preparing search index...

    Interface ProviderResults

    The closed set of built-in facts a gate may declare via needs, with value types.

    interface ProviderResults {
        cwd: string;
        "env.isCI": boolean;
        "git.branch": string;
        "git.isDirty": boolean;
        "git.root": string;
        "os.platform": Platform;
    }
    Index

    Properties

    cwd env.isCI git.branch git.isDirty git.root os.platform

    Properties

    cwd: string

    The directory the hook runs in.

    "env.isCI": boolean

    True iff running on a CI server (detected via the ci-info library).

    "git.branch": string

    The current git branch, or "" outside a git repo / on an unborn HEAD.

    "git.isDirty": boolean

    True iff the working tree has uncommitted changes (false if not a repo).

    "git.root": string

    The repo's top-level directory, or "" outside a git repo.

    "os.platform": Platform

    The OS platform (process.platform: "darwin" | "linux" | "win32" | …).

    Settings

    Member Visibility

    On This Page

    Properties