Skip to main content

Git

Helper functions for working with Git.

Functions

isGitRepository()

function isGitRepository(gitRepositoryPath): boolean

Helper function to determine whether the given path is inside of a Git repository.

Parameters

ParameterType
gitRepositoryPathstring

Returns

boolean

Defined in

packages/complete-node/src/functions/git.ts:10


isGitRepositoryClean()

function isGitRepositoryClean(gitRepositoryPath): boolean

Helper function to determine whether the given Git repository is "clean", meaning has no unchanged files from the head.

Parameters

ParameterType
gitRepositoryPathstring

Returns

boolean

Defined in

packages/complete-node/src/functions/git.ts:20


isGitRepositoryLatestCommit()

function isGitRepositoryLatestCommit(gitRepositoryPath): boolean

Helper function to determine whether the given Git repository is up to date with the remote.

Parameters

ParameterType
gitRepositoryPathstring

Returns

boolean

Defined in

packages/complete-node/src/functions/git.ts:27