gitrev-typed
Safe HaskellNone
LanguageHaskell2010

Development.GitRev.Utils.Git

Description

Provides utilities for querying git.

Since: 0.1

Synopsis

Documentation

data GitError Source #

Errors that can be encountered with git.

Since: 0.1

Constructors

GitNotFound

Since: 0.1

GitRunError String

Since: 0.1

Instances

Instances details
Exception GitError Source #

Since: 0.1

Instance details

Defined in Development.GitRev.Utils.Git

Methods

toException :: GitError -> SomeException #

fromException :: SomeException -> Maybe GitError #

displayException :: GitError -> String #

backtraceDesired :: GitError -> Bool #

Show GitError Source #

Since: 0.1

Instance details

Defined in Development.GitRev.Utils.Git

Methods

showsPrec :: Int -> GitError -> ShowS #

show :: GitError -> String #

showList :: [GitError] -> ShowS #

Eq GitError Source #

Since: 0.1

Instance details

Defined in Development.GitRev.Utils.Git

Methods

(==) :: GitError -> GitError -> Bool #

(/=) :: GitError -> GitError -> Bool #

Lift GitError Source #

Since: 0.1

Instance details

Defined in Development.GitRev.Utils.Git

Methods

lift :: Quote m => GitError -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => GitError -> Code m GitError #

gitBranchQ :: Q (Either GitError String) Source #

Returns the current git branch.

Examples

Expand
>>> $$(qToCode gitBranchQ)
Right ...

Since: 0.1

gitCommitCountQ :: Q (Either GitError String) Source #

Returns the git commit count.

Examples

Expand
>>> $$(qToCode gitCommitCountQ)
Right ...

Since: 0.1

gitCommitDateQ :: Q (Either GitError String) Source #

Returns the latest git commit date.

Examples

Expand
>>> $$(qToCode gitCommitDateQ)
Right ...

Since: 0.1

gitDescribeQ :: Q (Either GitError String) Source #

Returns the git description.

Examples

Expand
>>> $$(qToCode gitDescribeQ)
Right ...

Since: 0.1

gitDiffQ :: Q (Either GitError String) Source #

Return the diff of the working copy with HEAD.

Examples

Expand
>>> $$(qToCode gitDiffQ)
Right ...

Since: 0.1

gitDirtyQ :: Q (Either GitError Bool) Source #

Returns the git dirty status.

Examples

Expand
>>> $$(qToCode gitDirtyQ)
Right ...

Since: 0.1

gitDirtyTrackedQ :: Q (Either GitError Bool) Source #

Returns the git dirty status, ignoring untracked files.

Examples

Expand
>>> $$(qToCode gitDirtyTrackedQ)
Right ...

Since: 0.1

gitHashQ :: Q (Either GitError String) Source #

Returns the latest git hash.

Examples

Expand
>>> $$(qToCode gitHashQ)
Right ...

Since: 0.1

gitShortHashQ :: Q (Either GitError String) Source #

Returns the latest git short hash.

Examples

Expand
>>> $$(qToCode gitShortHashQ)
Right ...

Since: 0.1

gitTreeQ :: Q (Either GitError String) Source #

Returns the hash of the current tree.

Examples

Expand
>>> $$(qToCode gitTreeQ)
Right ...

Since: 0.1