| License | BSD3 |
|---|---|
| Maintainer | tbidne@gmail.com |
| Safe Haskell | Trustworthy |
| Language | Haskell2010 |
Git.Stale.Core.MonadFindBranches
Description
The MonadFindBranches class.
Synopsis
- class Monad m => MonadFindBranches m where
- type Handler (m :: Type -> Type) (a :: Type)
- type FinalResults m :: Type
- branchNamesByGrep :: Maybe FilePath -> BranchType -> Maybe Text -> m [Handler m Name]
- getStaleLogs :: Maybe FilePath -> RNonNegative Int -> Day -> [Handler m Name] -> m (Filtered (Handler m NameAuthDay))
- toBranches :: Maybe FilePath -> Text -> Filtered (Handler m NameAuthDay) -> m [Handler m AnyBranch]
- collectResults :: [Handler m AnyBranch] -> m (FinalResults m)
- display :: Text -> FinalResults m -> m ()
- runFindBranches :: (MonadReader Env m, MonadFindBranches m) => m ()
Documentation
class Monad m => MonadFindBranches m where Source #
The MonadFindBranches class is used to describe various git
actions for finding stale branches.
Associated Types
type Handler (m :: Type -> Type) (a :: Type) Source #
Adds custom handling to returned data (e.g. for error handling).
type FinalResults m :: Type Source #
The type returned by collectResults.
Methods
branchNamesByGrep :: Maybe FilePath -> BranchType -> Maybe Text -> m [Handler m Name] Source #
Returns a [Name] representing git branches.
getStaleLogs :: Maybe FilePath -> RNonNegative Int -> Day -> [Handler m Name] -> m (Filtered (Handler m NameAuthDay)) Source #
Maps [Name] to [NameAuthDay], filtering out non-stale branches.
toBranches :: Maybe FilePath -> Text -> Filtered (Handler m NameAuthDay) -> m [Handler m AnyBranch] Source #
Maps [NameAuthDay] to [AnyBranch].
collectResults :: [Handler m AnyBranch] -> m (FinalResults m) Source #
Collects [AnyBranch] into FinalResults.
display :: Text -> FinalResults m -> m () Source #
Displays results.
Instances
runFindBranches :: (MonadReader Env m, MonadFindBranches m) => m () Source #
High level logic of MonadFindBranches usage. This function is the
entrypoint for any MonadFindBranches instance.