Phials plugin documentation
User guide
AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0

GitInfo

Since Plugin API: 1.0.0

Signature

interface GitInfo {
    readonly rootPath: string;
    readonly branch: string | null;
    readonly detached: boolean;
    readonly dirty: boolean;
    readonly ahead: number;
    readonly behind: number;
    readonly remoteUrl: string | null;
}

Members

NameTypeRequiredDescription
rootPathstringyes-
branchstring | nullyes-
detachedbooleanyes-
dirtybooleanyes-
aheadnumberyes-
behindnumberyes-
remoteUrlstring | nullyes-