| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
HMGit.Internal.Core.Runner.API
Synopsis
- type HMGitT = ReaderT HMGitConfig
- hmGitDBPath :: Monad m => HMGitT m (Path Abs Dir)
- hmGitDBName :: Monad m => HMGitT m String
- hmGitLoadMasterHash :: (MonadIO m, MonadThrow m) => HMGitT m (Maybe String)
- hmGitRoot :: Monad m => HMGitT m (Path Abs Dir)
- hmGitTreeLim :: Monad m => HMGitT m Int
- hmGitIndexPath :: Monad m => HMGitT m (Path Abs File)
- hmGitBRPath :: MonadIO m => HMGitT m (Either (Path Abs File) (Path Abs File))
- hmGitBRPath' :: MonadIO m => HMGitT m (Path Abs File)
- hmGitBRName :: MonadIO m => HMGitT m (Either String String)
- hmGitBRName' :: MonadIO m => HMGitT m String
- getCurrentDirFromHMGit :: (MonadThrow m, MonadIO m) => HMGitT m (Path Rel Dir)
- runHMGit :: HMGitT m a -> HMGitConfig -> m a
Documentation
type HMGitT = ReaderT HMGitConfig Source #
hmGitDBPath :: Monad m => HMGitT m (Path Abs Dir) Source #
Get an abstract path to the HMGit database directory
hmGitLoadMasterHash :: (MonadIO m, MonadThrow m) => HMGitT m (Maybe String) Source #
Read refs/heads/master. If it does not exist,
look for refs/heads/main as a fallback.
The Nothing will be returned if neither exists.
hmGitRoot :: Monad m => HMGitT m (Path Abs Dir) Source #
Get an abstract path to the HMGit project directory
hmGitBRPath :: MonadIO m => HMGitT m (Either (Path Abs File) (Path Abs File)) Source #
If refs/heads/master or refs/heads/main exists, return Right,
if they are not exist, the candidate path is wrapped in Left returned.
hmGitBRPath' :: MonadIO m => HMGitT m (Path Abs File) Source #
Get the path, ignoring whether it is an actual path or a candidate path.
hmGitBRName :: MonadIO m => HMGitT m (Either String String) Source #
If refs/heads/master or refs/heads/main exists, return Right,
if they are not exist, the candidate name is wrapped in Left returned.
hmGitBRName' :: MonadIO m => HMGitT m String Source #
Get the name, ignoring whether it is a real name or a candidate name.
getCurrentDirFromHMGit :: (MonadThrow m, MonadIO m) => HMGitT m (Path Rel Dir) Source #
Returns the current path relative to the hmgit database directory
runHMGit :: HMGitT m a -> HMGitConfig -> m a Source #
HMGit runner