External module "git"

Index

Interfaces

Functions

Functions

getCurrentGitBranch

getCurrentGitBranch(opts?: GetCurrentGitBranchOptions): string

- Defined in src/git.ts:60
Gets the current git branch.

Parameters
- Optional opts: GetCurrentGitBranchOptions
Returns string

The name of the current branch.

getGitBranches

getGitBranches(opts?: GetGitBranchesOptions): string[]

- Defined in src/git.ts:81
Lists all branches of a git repository.

Parameters
- Optional opts: GetGitBranchesOptions
Returns string[]

The list of branches.

getGitRemoteUrl

getGitRemoteUrl(remote?: string, opts?: GetGitRemoteUrlOptions): string | false

- Defined in src/git.ts:158
Tries to return the remote URL of a git repository.

Parameters
- Optional remote: string
- Optional opts: GetGitRemoteUrlOptions
Returns string | false

The remote URL or (false) if not possible.

getGitRemotes

getGitRemotes(opts?: GetGitRemotesOptions): string[]

- Defined in src/git.ts:122
Lists all remotes of a git repository.

Parameters
- Optional opts: GetGitRemotesOptions
Returns string[]

The list of remotes.

hasGitChanges

hasGitChanges(opts?: HasGitChangesOptions): boolean

- Defined in src/git.ts:192
Checks if a git repository has uncommited changes or not.

Parameters
- Optional opts: HasGitChangesOptions
Returns boolean

Has uncomitted changes or not.

Generated using TypeDoc