life-sync-1.0.1

Safe Haskell	None
Language	Haskell2010

Life.Github

Contents

Repository utils
Repository manipulation commands

Description

Utilities to work with GitHub repositories using "hub".

Synopsis

newtype Owner = Owner {
- getOwner :: Text
}
newtype Repo = Repo {
- getRepo :: Text
}
checkRemoteSync :: IO Bool
cloneRepo :: Owner -> IO ()
insideRepo :: IO a -> IO a
withSynced :: IO a -> IO a
data CopyDirection
- = FromHomeToRepo
- | FromRepoToHome
copyLife :: CopyDirection -> LifeConfiguration -> IO ()
addToRepo :: (Path Abs t -> Path Abs t -> IO ()) -> Path Rel t -> IO ()
createRepository :: Owner -> Repo -> IO ()
pullUpdateFromRepo :: LifeConfiguration -> IO ()
removeFromRepo :: (Path Abs t -> IO ()) -> Path Rel t -> IO ()
updateDotfilesRepo :: Text -> LifeConfiguration -> IO ()
updateFromRepo :: LifeConfiguration -> IO ()

Documentation

newtype Owner Source #

Constructors

Owner
Fields getOwner :: Text

Instances

Show Owner Source #
Instance details Defined in Life.Github Methods showsPrec :: Int -> Owner -> ShowS # show :: Owner -> String # showList :: [Owner] -> ShowS #

newtype Repo Source #

Constructors

Repo
Fields getRepo :: Text

Instances

Show Repo Source #
Instance details Defined in Life.Github Methods showsPrec :: Int -> Repo -> ShowS # show :: Repo -> String # showList :: [Repo] -> ShowS #

Repository utils

checkRemoteSync :: IO Bool Source #

Returns true if local dotfiles repository is synchronized with remote repo.

cloneRepo :: Owner -> IO () Source #

Clones dotfiles repository assuming it doesn't exist.

insideRepo :: IO a -> IO a Source #

Executes action with repoName set as pwd.

withSynced :: IO a -> IO a Source #

Repository manipulation commands

data CopyDirection Source #

Constructors

FromHomeToRepo
FromRepoToHome

copyLife :: CopyDirection -> LifeConfiguration -> IO () Source #

addToRepo :: (Path Abs t -> Path Abs t -> IO ()) -> Path Rel t -> IO () Source #

Adds file or directory to the repository and commits

createRepository :: Owner -> Repo -> IO () Source #

Creates repository on GitHub inside given folder.

pullUpdateFromRepo :: LifeConfiguration -> IO () Source #

removeFromRepo :: (Path Abs t -> IO ()) -> Path Rel t -> IO () Source #

Removes file or directory from the repository and commits

updateDotfilesRepo :: Text -> LifeConfiguration -> IO () Source #

updateFromRepo :: LifeConfiguration -> IO () Source #