Data.VCS.Ignore.Repo.Git

This module contains implementation of Repo type class for the GIT content versioning system. Most of the public functions is exported only to make them visible for tests, end user of this library really shouldn't need to use them.

Documentation

data Git

Data type representing scanned instance of GIT repository.

Constructors

Git

Fields

• gitRepoRoot :: FilePath

  absolute path to the repository root

• gitPatterns :: [(FilePath, [Pattern])]

  patterns ignored at given repository paths

Instances

Eq Git

Defined in Data.VCS.Ignore.Repo.Git

Methods

(==) :: Git -> Git -> Bool

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

Show Git

Defined in Data.VCS.Ignore.Repo.Git

Methods

showsPrec :: Int -> Git -> ShowS

show :: Git -> String

showList :: [Git] -> ShowS

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 Pattern

Represents single pattern to be used as a rule for ignoring paths.

Constructors

Pattern

Fields

• pPatterns :: [Pattern]

  underlying implementation

• pRaw :: Text

  raw textual representation of the pattern

• pIsNegated :: Bool

  whether the pattern is the negation (starts with !)

Instances

Eq Pattern

Defined in Data.VCS.Ignore.Repo.Git

Methods

(==) :: Pattern -> Pattern -> Bool

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

Show Pattern

Defined in Data.VCS.Ignore.Repo.Git

Methods

showsPrec :: Int -> Pattern -> ShowS

show :: Pattern -> String

showList :: [Pattern] -> ShowS

IsString Pattern

Defined in Data.VCS.Ignore.Repo.Git

Methods

fromString :: String -> Pattern

compilePattern

Arguments

:: Text

raw pattern as text

-> Pattern

compiled pattern

Compiles pattern.

matchesPattern

Arguments

:: Pattern

pattern to match against

-> FilePath

path to check

-> Bool

check result

Tests whether given path matches against the pattern.

parsePatterns

Arguments

:: Text

text to parse

-> [Pattern]

parsed patterns

Parses Glob patterns from given text source. Each line in input text is considered to be single pattern. Lines starting with # (comments) and blank lines are skipped.

>>> parsePatterns "*.xml\n.DS_Store"
[Pattern {pPatterns = [compile "*.xml",compile "*.xml/*"], pRaw = "*.xml", pIsNegated = False},Pattern {pPatterns = [compile "**/.DS_Store",compile "**/.DS_Store/*"], pRaw = ".DS_Store", pIsNegated = False}]

loadPatterns

Arguments

:: MonadIO m

=> FilePath

path to text file to parse

-> m [Pattern]

parsed Glob patterns

Loads Glob patterns from given text file. If the fille cannot be read for any reason, empty list is returned. See parsePatterns for more details about parsing.

findGitIgnores

Arguments

:: MonadIO m

=> FilePath

path to the directory to search in

-> m [FilePath]

paths of found .gitignore files

Recursively finds all .gitignore files within the given directory path.

gitIgnorePatterns

Arguments

:: MonadIO m

=> FilePath

path to the directory to search .gitignore files in

-> m [(FilePath, [Pattern])]

list of .gitignore paths and parsed Glob patterns

Recursively finds all .gitignore files within the given directory path and parses them into Glob patterns. See loadPatterns and findGitIgnores for more details.

repoPatterns

Arguments

:: MonadIO m

=> FilePath

path to the GIT repository root

-> m [Pattern]

parsed Glob patterns

Loads GIT repository specific ignore patterns, present in REPO_ROOT/info/exclude file.

globalPatterns

Arguments

:: MonadIO m

=> m [Pattern]

parsed Glob patterns

Loads global GIT ignore patterns, present in XDG_CONFIG_GOME/git/ignore file.

scanRepo'

Arguments

:: (MonadIO m, MonadThrow m)

=> m [Pattern]

reference to globalPatterns function (or similar)

-> (FilePath -> m [Pattern])

reference to repoPatterns function (or similar)

-> (FilePath -> m [(FilePath, [Pattern])])

reference to gitIgnorePatterns function (or similar)

-> (FilePath -> m Bool)

reference to isGitRepo function (or similar)

-> FilePath

path to GIT repository root

-> m Git

scanned Git repository

Internal version of scanRepo, where individual functions needs to be explicitly provided, which is useful mainly for testing purposes.

isIgnored'

Arguments

:: MonadIO m

=> Git

scanned GIT repository

-> FilePath

path to check if ignored

-> m Bool

Internal version of isIgnored function.

isGitRepo

Arguments

:: MonadIO m

=> FilePath

path to the directory to check

-> m Bool

True if the given directory is valid GIT repository

Checks whether given directory path is valid GIT repository.