Data.VCS.Ignore.Repo

This module contains type class representing the selected type of VCS repository.

Documentation

class Repo r where

Type class representing instance of VCS repository of selected type. In order to obtain instance, the physical repository needs to be scanned first by the scanRepo method. Then absolute path to the repository root is provided by repoRoot method. To check if any path (relative to the repo root) is ignored or not, use the isIgnored method.

Methods

repoName

Arguments

:: r

VCS repository instance

-> Text

name of the repository

Returns name of the repository (e.g. GIT).

repoRoot

Arguments

:: r

VCS repository instance

-> FilePath

absolute path to the repository

Returns absolute path to the root of the VCS repository.

scanRepo

Arguments

:: (MonadIO m, MonadThrow m)

=> FilePath

path to the VCS repository root

-> m r

scanned repository (or failure)

Scans repository at given path. If the given path doesn't contain valid repository, RepoError may be thrown.

isIgnored

Arguments

:: MonadIO m

=> r

VCS repository instance

-> FilePath

path to check, relative to the repository root

-> m Bool

whether the path is ignored or not

Checks whether the given path is ignored. The input path is expected to be relative to the repository root, it might or might not point to existing file or directory.

Instances

Repo Git

Defined in Data.VCS.Ignore.Repo.Git

Methods

repoName :: Git -> Text

repoRoot :: Git -> FilePath

scanRepo :: (MonadIO m, MonadThrow m) => FilePath -> m Git

isIgnored :: MonadIO m => Git -> FilePath -> m Bool

data RepoError

Represents error related to operations over the VCS repository.

Constructors

InvalidRepo FilePath Text

Given FilePath doesn't contain valid VCS repository root.

Instances

Eq RepoError

Defined in Data.VCS.Ignore.Repo

Methods

(==) :: RepoError -> RepoError -> Bool

(/=) :: RepoError -> RepoError -> Bool

Show RepoError

Defined in Data.VCS.Ignore.Repo

Methods

showsPrec :: Int -> RepoError -> ShowS

show :: RepoError -> String

showList :: [RepoError] -> ShowS

Exception RepoError

Defined in Data.VCS.Ignore.Repo

Methods

toException :: RepoError -> SomeException

fromException :: SomeException -> Maybe RepoError

displayException :: RepoError -> String