Safe Haskell	None
Language	Haskell2010

Git.Vogue.Types

Synopsis

Documentation

data VogueOptions Source

Options parsed from the command-line.

Constructors

Options
Fields optSearch :: SearchMode optCommand :: VogueCommand

Instances

Eq VogueOptions Source
Show VogueOptions Source

data VogueCommand Source

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 Source
Show VogueCommand Source

data Check Source

Phantom type for Statuses related to checking

data Fix Source

Phantom type for Statuses related to fixing

data Result Source

Result of running a Plugin

Constructors

Success Text
Failure Text
Catastrophe Int Text

Instances

Eq Result Source
Ord Result Source
Show Result Source

data Plugin m Source

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) Source
Ord (Plugin m) Source
Show (Plugin m) Source

newtype PluginName Source

Constructors

PluginName
Fields unPluginName :: Text

Instances

Eq PluginName Source
Ord PluginName Source
Show PluginName Source
IsString PluginName Source
Monoid PluginName Source

data SearchMode Source

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

Constructors

FindAll
FindChanged
FindSpecific [FilePath]

Instances

Eq SearchMode Source
Show SearchMode Source

data PluginDiscoverer m Source

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 Source

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