Safe Haskell | None |
---|---|
Language | Haskell98 |
This module exports types and functions common to all VCS.
- data VCSType
- type IsLocked = Bool
- data LogEntry = LogEntry {}
- newtype Ctx a = Ctx (ReaderT Config IO a)
- data Config = Config {
- configCwd :: Maybe FilePath
- configPath :: Maybe FilePath
- configAuthor :: Maybe Author
- configEnvironment :: [(Text, Text)]
- data Author = Author {
- authorName :: Text
- authorEmail :: Maybe Text
- data VCSException = VCSException Int Text Text FilePath [Text]
- data Status
- data Modification
- makeConfig :: Maybe FilePath -> Maybe FilePath -> Maybe Author -> Config
- makeConfigWithEnvironment :: Maybe FilePath -> Maybe FilePath -> Maybe Author -> [(Text, Text)] -> Config
- filePath :: Status -> FilePath
- modification :: Status -> Modification
- isLocked :: Status -> IsLocked
- runVcs :: Config -> Ctx t -> IO t
- vcsExec :: FilePath -> Text -> [Text] -> [(Text, Text)] -> Ctx (Either VCSException Text)
- vcsExecThrowingOnError :: FilePath -> Text -> [Text] -> [(Text, Text)] -> Ctx Text
- exec :: Text -> [Text] -> [(Text, Text)] -> FilePath -> (Config -> Maybe FilePath) -> Ctx (Either VCSException Text)
Documentation
Available VCS types implemented in this package.
Represents a log entry in the history managed by the VCS.
Context for all VCS commands.
E.g. to create a new Git repository use something like this:
import VCSWrapper.Git myInitRepoFn = do let config = makeConfig "path/to/repo" Nothing Nothing runVcs config $ initDB False
Configuration of the Ctx
the VCS commands will be executed in.
Config | |
|
Author to be passed to VCS commands where applicable.
Author | |
|
data VCSException Source #
This Exception
-type will be thrown if a VCS command fails unexpectedly.
Status of a file managed by the respective VCS.
data Modification Source #
Flags to describe the state of a file.
None | File hasn't been modified. |
Added | File has been selected to be managed by the respective VCS. |
Conflicting | File is in conflicting state. Manually resolving the conflict may be necessary. |
Deleted | File has been deleted. |
Modified | File has been modified since last commit. |
Replaced | File has been replaced by a different file. |
Untracked | File is currently not known by the VCS. |
Unknown | State of file is unknown. |
Ignored | File is ignored by VCS. |
Missing | File is missing. |
:: Maybe FilePath | Path to the main directory of the repository. E.g. for Git: the directory of the repository containing the |
-> Maybe FilePath | Path to the vcs executable. If |
-> Maybe Author | Author to be used for different VCS actions. If |
-> Config |
Creates a new Config
.
makeConfigWithEnvironment Source #
:: Maybe FilePath | Path to the main directory of the repository. E.g. for Git: the directory of the repository containing the |
-> Maybe FilePath | Path to the vcs executable. If |
-> Maybe Author | Author to be used for different VCS actions. If |
-> [(Text, Text)] | List of environment variables mappings passed to the underlying VCS executable. |
-> Config |
Creates a new Config
with a list of environment variables.
modification :: Status -> Modification Source #
Retrieve the Modification
of any VCS Status
.
:: FilePath | VCS shell-command, e.g. git |
-> Text | VCS command, e.g. checkout |
-> [Text] | options |
-> [(Text, Text)] | environment variables |
-> Ctx (Either VCSException Text) |
Internal function to execute a VCS command