Data.VCS.Ignore.Core

This module contains core operations you can perform over the scanned Repo.

Documentation

findRepo

Arguments

:: (MonadIO m, Repo r)

=> FilePath

path where to start scanning

-> m (Maybe r)

scanned Repo (if found)

Attempts to find (and scan via scanRepo) repository at given path. If given path doesn't contain valid repository, it recursively tries in every parent directory until the root directory (e.g. C: or /) is reached.

listRepo

Arguments

:: (MonadIO m, Repo r)

=> r

repository to list

-> m [FilePath]

list of non-ignored paths within the repository

Resursively lists all non-ignored paths withing the given repository (both files and directories).

walkRepo

Arguments

:: (MonadIO m, Repo r)

=> r

repository to walk

-> (FilePath -> m a)

action to do on every non-excluded filepath

-> m [a]

list of transformed paths

Similar to listRepo, but allows to perform any action on every non-ignored path within the repository.