Git.Vogue.Types

Documentation

data VogueOptions

Options parsed from the command-line.

Constructors

Options

Fields

• optSearch :: SearchMode
• optCommand :: VogueCommand
• optDisable :: [PluginName]
• optVCS :: VCSType

Instances

Eq VogueOptions

Methods

(==) :: VogueOptions -> VogueOptions -> Bool

(/=) :: VogueOptions -> VogueOptions -> Bool

Show VogueOptions

Methods

showsPrec :: Int -> VogueOptions -> ShowS

show :: VogueOptions -> String

showList :: [VogueOptions] -> ShowS

data VCSType

Constructors

Git

Null

Instances

Eq VCSType

Methods

(==) :: VCSType -> VCSType -> Bool

(/=) :: VCSType -> VCSType -> Bool

Show VCSType

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

Methods

(==) :: VogueCommand -> VogueCommand -> Bool

(/=) :: VogueCommand -> VogueCommand -> Bool

Show VogueCommand

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

Methods

(==) :: Result -> Result -> Bool

(/=) :: Result -> Result -> Bool

Ord Result

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

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)

Methods

(==) :: Plugin m -> Plugin m -> Bool

(/=) :: Plugin m -> Plugin m -> Bool

Ord (Plugin m)

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)

Methods

showsPrec :: Int -> Plugin m -> ShowS

show :: Plugin m -> String

showList :: [Plugin m] -> ShowS

newtype PluginName

Constructors

PluginName

Fields

• unPluginName :: Text

Instances

Eq PluginName

Methods

(==) :: PluginName -> PluginName -> Bool

(/=) :: PluginName -> PluginName -> Bool

Ord PluginName

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

Methods

showsPrec :: Int -> PluginName -> ShowS

show :: PluginName -> String

showList :: [PluginName] -> ShowS

IsString PluginName

Methods

fromString :: String -> PluginName

Semigroup PluginName

Methods

(<>) :: PluginName -> PluginName -> PluginName

sconcat :: NonEmpty PluginName -> PluginName

stimes :: Integral b => b -> PluginName -> PluginName

Monoid PluginName

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

Methods

(==) :: SearchMode -> SearchMode -> Bool

(/=) :: SearchMode -> SearchMode -> Bool

Show SearchMode

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