Safe Haskell	None
Language	Haskell2010

Git.Vogue.Types

Synopsis

data VogueOptions = Options {
- optSearch :: SearchMode
- optCommand :: VogueCommand
- optDisable :: [PluginName]
- optVCS :: VCSType
}
data VCSType
- = Git
- | Null
data VogueCommand
- = CmdInit
- | CmdVerify
- | CmdPlugins
- | CmdDisable PluginName
- | CmdEnable PluginName
- | CmdRunCheck
- | CmdRunFix
data Check
data Fix
data Result
- = Success Text
- | Failure Text
- | Catastrophe Int Text
data Plugin m = Plugin {
- pluginName :: PluginName
- enabled :: Bool
- runCheck :: [FilePath] -> [FilePath] -> m Result
- runFix :: [FilePath] -> [FilePath] -> m Result
}
newtype PluginName = PluginName {
- unPluginName :: Text
}
data SearchMode
- = FindAll
- | FindChanged
- | FindSpecific [FilePath]
data PluginDiscoverer m = PluginDiscoverer {
- discoverPlugins :: m [Plugin m]
- disablePlugin :: PluginName -> m ()
- enablePlugin :: PluginName -> m ()
}
data VCS m = VCS {
- getFiles :: SearchMode -> m [FilePath]
- installHook :: m ()
- removeHook :: m ()
- checkHook :: m Bool
- getTopLevel :: m FilePath
}

Documentation

data VogueOptions #

Options parsed from the command-line.

Constructors

Options
Fields optSearch :: SearchMode optCommand :: VogueCommand optDisable :: [PluginName] optVCS :: VCSType

Instances

Eq VogueOptions #
Instance details Defined in Git.Vogue.Types Methods (==) :: VogueOptions -> VogueOptions -> Bool # (/=) :: VogueOptions -> VogueOptions -> Bool #
Show VogueOptions #
Instance details Defined in Git.Vogue.Types Methods showsPrec :: Int -> VogueOptions -> ShowS # show :: VogueOptions -> String # showList :: [VogueOptions] -> ShowS #

data VCSType #

Constructors

Git
Null

Instances

Eq VCSType #
Instance details Defined in Git.Vogue.Types Methods (==) :: VCSType -> VCSType -> Bool # (/=) :: VCSType -> VCSType -> Bool #
Show VCSType #
Instance details Defined in Git.Vogue.Types Methods showsPrec :: Int -> VCSType -> ShowS # show :: VCSType -> String # showList :: [VCSType] -> ShowS #

data VogueCommand #

Commands, with parameters, to be executed.

Constructors

CmdInit	Add git-vogue support to a git repository.
CmdVerify	Verify that support is installed and plugins happen.
CmdPlugins	List the plugins that git-vogue knows about.
CmdDisable PluginName	Disable a plugin
CmdEnable PluginName	Enable a plugin
CmdRunCheck	Run check plugins on files in a git repository.
CmdRunFix	Run fix plugins on files in a git repository.

Instances

Eq VogueCommand #
Instance details Defined in Git.Vogue.Types Methods (==) :: VogueCommand -> VogueCommand -> Bool # (/=) :: VogueCommand -> VogueCommand -> Bool #
Show VogueCommand #
Instance details Defined in Git.Vogue.Types Methods showsPrec :: Int -> VogueCommand -> ShowS # show :: VogueCommand -> String # showList :: [VogueCommand] -> ShowS #

data Check #

Phantom type for Statuses related to checking

data Fix #

Phantom type for Statuses related to fixing

data Result #

Result of running a Plugin

Constructors

Success Text
Failure Text
Catastrophe Int Text

Instances

Eq Result #
Instance details Defined in Git.Vogue.Types Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #
Ord Result #
Instance details Defined in Git.Vogue.Types Methods compare :: Result -> Result -> Ordering # (<) :: Result -> Result -> Bool # (<=) :: Result -> Result -> Bool # (>) :: Result -> Result -> Bool # (>=) :: Result -> Result -> Bool # max :: Result -> Result -> Result # min :: Result -> Result -> Result #
Show Result #
Instance details Defined in Git.Vogue.Types Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #

data Plugin m #

A plugin that can be told to check or fix a list of files

Constructors

Plugin
Fields pluginName :: PluginName enabled :: Bool runCheck :: [FilePath] -> [FilePath] -> m Result runFix :: [FilePath] -> [FilePath] -> m Result

Instances

Eq (Plugin m) #
Instance details Defined in Git.Vogue.Types Methods (==) :: Plugin m -> Plugin m -> Bool # (/=) :: Plugin m -> Plugin m -> Bool #
Ord (Plugin m) #
Instance details Defined in Git.Vogue.Types Methods compare :: Plugin m -> Plugin m -> Ordering # (<) :: Plugin m -> Plugin m -> Bool # (<=) :: Plugin m -> Plugin m -> Bool # (>) :: Plugin m -> Plugin m -> Bool # (>=) :: Plugin m -> Plugin m -> Bool # max :: Plugin m -> Plugin m -> Plugin m # min :: Plugin m -> Plugin m -> Plugin m #
Show (Plugin m) #
Instance details Defined in Git.Vogue.Types Methods showsPrec :: Int -> Plugin m -> ShowS # show :: Plugin m -> String # showList :: [Plugin m] -> ShowS #

newtype PluginName #

Constructors

PluginName
Fields unPluginName :: Text

Instances

Eq PluginName #
Instance details Defined in Git.Vogue.Types Methods (==) :: PluginName -> PluginName -> Bool # (/=) :: PluginName -> PluginName -> Bool #
Ord PluginName #
Instance details Defined in Git.Vogue.Types Methods compare :: PluginName -> PluginName -> Ordering # (<) :: PluginName -> PluginName -> Bool # (<=) :: PluginName -> PluginName -> Bool # (>) :: PluginName -> PluginName -> Bool # (>=) :: PluginName -> PluginName -> Bool # max :: PluginName -> PluginName -> PluginName # min :: PluginName -> PluginName -> PluginName #
Show PluginName #
Instance details Defined in Git.Vogue.Types Methods showsPrec :: Int -> PluginName -> ShowS # show :: PluginName -> String # showList :: [PluginName] -> ShowS #
IsString PluginName #
Instance details Defined in Git.Vogue.Types Methods fromString :: String -> PluginName #
Semigroup PluginName #
Instance details Defined in Git.Vogue.Types Methods (<>) :: PluginName -> PluginName -> PluginName # sconcat :: NonEmpty PluginName -> PluginName # stimes :: Integral b => b -> PluginName -> PluginName #
Monoid PluginName #
Instance details Defined in Git.Vogue.Types Methods mempty :: PluginName # mappend :: PluginName -> PluginName -> PluginName # mconcat :: [PluginName] -> PluginName #

data SearchMode #

We want the flexibility of just checking changed files, or maybe checking all of them.

Constructors

FindAll
FindChanged
FindSpecific [FilePath]

Instances

Eq SearchMode #
Instance details Defined in Git.Vogue.Types Methods (==) :: SearchMode -> SearchMode -> Bool # (/=) :: SearchMode -> SearchMode -> Bool #
Show SearchMode #
Instance details Defined in Git.Vogue.Types Methods showsPrec :: Int -> SearchMode -> ShowS # show :: SearchMode -> String # showList :: [SearchMode] -> ShowS #

data PluginDiscoverer m #

A thing that can find plugins, for example we might search through the libexec directory for executables.

Constructors

PluginDiscoverer
Fields discoverPlugins :: m [Plugin m] disablePlugin :: PluginName -> m () enablePlugin :: PluginName -> m ()

data VCS m #

A VCS backend, such as git.

Constructors

VCS
Fields getFiles :: SearchMode -> m [FilePath] Find all staged files installHook :: m () Install pre-commit hook, will only be called if checkHook returns False removeHook :: m () Remove pre-commit hook checkHook :: m Bool Check pre-commit hook getTopLevel :: m FilePath Find the / of the repo